From 7276849479fc25a78f8852508bc883c5d7a32365 Mon Sep 17 00:00:00 2001 From: vcmirko <37864434+wfaguy@users.noreply.github.com> Date: Tue, 18 Jul 2023 18:33:54 +0200 Subject: [PATCH 1/5] new depencyfeature --- CHANGELOG.md | 5 ++++ client/package.json | 2 +- client/src/components/Form.vue | 37 +++++++++++++++++++------- server/package.json | 2 +- server/schema/forms_schema.json | 47 ++++++++++++++++++++++----------- server/schema/help.yaml | 32 +++++++++++++++++----- server/src/swagger.json | 2 +- 7 files changed, 92 insertions(+), 35 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 522545d7..868033a4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +### Added + +- New dependency mechanism isValid + you can show/hide a field based if another field is valid or not + ## [4.0.12] - 2023-07-15 ### Changed diff --git a/client/package.json b/client/package.json index 7a230bca..e90de5ab 100644 --- a/client/package.json +++ b/client/package.json @@ -1,6 +1,6 @@ { "name": "ansible_forms_vue", - "version": "4.0.12", + "version": "4.0.13", "private": true, "scripts": { "serve": "vue-cli-service serve", diff --git a/client/src/components/Form.vue b/client/src/components/Form.vue index 47763cf3..2e2683f9 100644 --- a/client/src/components/Form.vue +++ b/client/src/components/Form.vue @@ -785,6 +785,7 @@ var fieldname=inversed?item.name.slice(1):item.name var columnRegex = /(.+)\.(.+)/g; // detect a "." in the field var tmpArr=columnRegex.exec(fieldname) // found aaa.bbb + var tmp if(tmpArr && tmpArr.length>0){ fieldname = tmpArr[1] // aaa column=tmpArr[2] // bbb @@ -798,16 +799,34 @@ }else{ value=ref.form[fieldname] } - if(isAnd && ((!inversed && !item.values.includes(value)) || ((inversed && item.values.includes(value)))) ){ - result=false - // console.log("and not valid") - break - } - if(isOr && ((!inversed && item.values.includes(value)) || (inversed && !item.values.includes(value)))){ - result=true - // console.log("or valid") - break + // new in 4.0.13 - dependency on validated + if(item.isValid != undefined){ + tmp = item.isValid!=this.$v.form[fieldname].$invalid + if(isAnd && ((!inversed && !tmp) || ((inversed && tmp))) ){ + result=false + // console.log("and not valid") + break + } + if(isOr && ((!inversed && tmp) || (inversed && !tmp))){ + result=true + // console.log("or valid") + break + } + + }else{ + tmp = item.values?.includes(value) + if(isAnd && ((!inversed && !tmp) || ((inversed && tmp))) ){ + result=false + // console.log("and not valid") + break + } + if(isOr && ((!inversed && tmp) || (inversed && !tmp))){ + result=true + // console.log("or valid") + break + } } + } // console.log("sub => " + result) // invert if nand or nor diff --git a/server/package.json b/server/package.json index a013d2ff..b02a9657 100644 --- a/server/package.json +++ b/server/package.json @@ -1,6 +1,6 @@ { "name": "ansible_forms", - "version": "4.0.12", + "version": "4.0.13", "repository": { "type": "git", "url": "git://github.com/ansibleguy76/ansibleforms.git" diff --git a/server/schema/forms_schema.json b/server/schema/forms_schema.json index 44e2c05a..2692342a 100644 --- a/server/schema/forms_schema.json +++ b/server/schema/forms_schema.json @@ -1123,24 +1123,39 @@ "dependencies": { "type": "array", "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "pattern": "^!{0,1}[A-Za-z0-9_\\-.]+$" + "anyOf":[ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "pattern": "^!{0,1}[A-Za-z0-9_\\-.]+$" + }, + "values": { + "type": "array", + "items": { + "anyOf": [ + {"type": "string"}, + {"type": "integer"}, + {"type": "boolean"} + ] + } + } + } }, - "values": { - "type": "array", - "items": { - "anyOf": [{"type": "string"}, - {"type": "integer"}, - {"type": "boolean"} - ] + { + "type": "object", + "properties": { + "name": { + "type": "string", + "pattern": "^!{0,1}[A-Za-z0-9_\\-.]+$" + }, + "isValid": { "type": "boolean"} } - } - }, - "additionalProperties": false - } + } + ] + }, + "additionalProperties": false }, "hide": {"type": "boolean"}, "icon": { diff --git a/server/schema/help.yaml b/server/schema/help.yaml index 67eed13b..92bcf985 100644 --- a/server/schema/help.yaml +++ b/server/schema/help.yaml @@ -1900,10 +1900,6 @@ description: Uses the logical `and` operand to evaluate multiple dependencies - name: or description: Uses the logical `and` operand to evaluate multiple dependencies - - name: nand - description: Uses the logical `nand` operand to evaluate multiple dependencies - - name: nor - description: Uses the logical `nor` operand to evaluate multiple dependencies short: The dependency logical function default: and description: This attribute represents the logical function between multiple dependencies. @@ -1912,15 +1908,22 @@ allowed: Reference to other formfields and their values short: Show/hide this field based on the values or other fields description: | - Each dependency element is an object with 2 attributes: + Each dependency element is either an object with the following 2 attributes: * `name` : holds the fieldname. - * `values` : a list of valid values for the referencing field. + * `values` : a list of valid values for the referenced field. + Or with the following 2 attributes: + * `name` : holds the fieldname. + * `isValid` : a boolean to check if the referenced is validated or not. + Use in combination with attribute `dependencyFn`. changelog: - version: 4.0.0 type: added description: Add an exlamation mark `!` before the referencing field's name, to invert the match. Wrap it in quotes because the `!` mark has special meaning in YAML. + - version: 4.0.13 + type: added + description: Add a new way of dependency. Use `isValid` property to show/hide a field. examples: - name: Show a field based on a checkbox code: | @@ -1934,6 +1937,21 @@ - name: add_extra_comment values: - true + - name: Show a field if another field is valid + code: | + - name: code + type: text + regex: + expression: "^[a-z]{3}$" + description: Must be 3 characters lowercase + required: true + - name: code_uppercase + type: expression + runLocal: true + expression: "'$(code)'.toUpperCase()" + dependencies: + - name: code + isValid: true # new in 4.0.13 -> code_uppercase will only be shown if code is validated - name: Show a field based on 2 fields, using the 'or' function code: | - name: job_type @@ -1964,7 +1982,7 @@ label: What's the name of the office dependencyFn: or dependencies: - - name: "!job_type" # this will invert/negate + - name: "!job_type" # this will invert/negate - note the wrapping quotes!! needed for valid yaml values: - IT - HR diff --git a/server/src/swagger.json b/server/src/swagger.json index adce3f05..944184da 100644 --- a/server/src/swagger.json +++ b/server/src/swagger.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "description": "This is the swagger interface for AnsibleForms.\r\nUse the `/auth/login` api with basic authentication to obtain a JWT token.\r\nThen use the access token, prefixed with the word '**Bearer**' to use all other api's.\r\nNote that the access token is limited in time. You can then either login again and get a new set of tokens or use the `/token` api and the refresh token to obtain a new set (preferred).", - "version": "4.0.12", + "version": "4.0.13", "title": "AnsibleForms", "contact": { "email": "info@ansibleforms.com" From bddaea8a7e4c5adcd7dab794e50601ffb747d665 Mon Sep 17 00:00:00 2001 From: vcmirko <37864434+wfaguy@users.noreply.github.com> Date: Wed, 19 Jul 2023 15:36:31 +0200 Subject: [PATCH 2/5] first test github pages --- docs/_config.yml | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 docs/_config.yml diff --git a/docs/_config.yml b/docs/_config.yml new file mode 100644 index 00000000..78cbc8ab --- /dev/null +++ b/docs/_config.yml @@ -0,0 +1,3 @@ +theme: jekyll-theme-minimal +title: AnsibleForms Documentation +description: Bookmark this to keep an eye on my project updates! \ No newline at end of file From 2c8d34a89d8d0e56d6bb92150d5a1d9542166d11 Mon Sep 17 00:00:00 2001 From: vcmirko <37864434+wfaguy@users.noreply.github.com> Date: Wed, 19 Jul 2023 17:34:05 +0200 Subject: [PATCH 3/5] init docs --- docs/404.html | 25 ++ docs/Gemfile | 34 +++ docs/Gemfile.lock | 264 ++++++++++++++++++ docs/_config.yml | 58 +++- .../2023-07-19-welcome-to-jekyll.markdown | 29 ++ docs/about.markdown | 18 ++ docs/index.markdown | 6 + 7 files changed, 431 insertions(+), 3 deletions(-) create mode 100644 docs/404.html create mode 100644 docs/Gemfile create mode 100644 docs/Gemfile.lock create mode 100644 docs/_posts/2023-07-19-welcome-to-jekyll.markdown create mode 100644 docs/about.markdown create mode 100644 docs/index.markdown diff --git a/docs/404.html b/docs/404.html new file mode 100644 index 00000000..086a5c9e --- /dev/null +++ b/docs/404.html @@ -0,0 +1,25 @@ +--- +permalink: /404.html +layout: default +--- + + + +
+

404

+ +

Page not found :(

+

The requested page could not be found.

+
diff --git a/docs/Gemfile b/docs/Gemfile new file mode 100644 index 00000000..a43b41fd --- /dev/null +++ b/docs/Gemfile @@ -0,0 +1,34 @@ +source "https://rubygems.org" +# Hello! This is where you manage which Jekyll version is used to run. +# When you want to use a different version, change it below, save the +# file and run `bundle install`. Run Jekyll with `bundle exec`, like so: +# +# bundle exec jekyll serve +# +# This will help ensure the proper Jekyll version is running. +# Happy Jekylling! +# gem "jekyll", "~> 4.3.2" +gem "github-pages", "~> 228", group: :jekyll_plugins +# This is the default theme for new Jekyll sites. You may change this to anything you like. +gem "minima", "~> 2.5" +# If you want to use GitHub Pages, remove the "gem "jekyll"" above and +# uncomment the line below. To upgrade, run `bundle update github-pages`. +# gem "github-pages", group: :jekyll_plugins +# If you have any plugins, put them here! +group :jekyll_plugins do + gem "jekyll-feed", "~> 0.12" +end + +# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem +# and associated library. +platforms :mingw, :x64_mingw, :mswin, :jruby do + gem "tzinfo", ">= 1", "< 3" + gem "tzinfo-data" +end + +# Performance-booster for watching directories on Windows +gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin] + +# Lock `http_parser.rb` gem to `v0.6.x` on JRuby builds since newer versions of the gem +# do not have a Java counterpart. +gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby] diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock new file mode 100644 index 00000000..558f0c70 --- /dev/null +++ b/docs/Gemfile.lock @@ -0,0 +1,264 @@ +GEM + remote: https://rubygems.org/ + specs: + activesupport (7.0.6) + concurrent-ruby (~> 1.0, >= 1.0.2) + i18n (>= 1.6, < 2) + minitest (>= 5.1) + tzinfo (~> 2.0) + addressable (2.8.4) + public_suffix (>= 2.0.2, < 6.0) + coffee-script (2.4.1) + coffee-script-source + execjs + coffee-script-source (1.11.1) + colorator (1.1.0) + commonmarker (0.23.9) + concurrent-ruby (1.2.2) + dnsruby (1.70.0) + simpleidn (~> 0.2.1) + em-websocket (0.5.3) + eventmachine (>= 0.12.9) + http_parser.rb (~> 0) + ethon (0.16.0) + ffi (>= 1.15.0) + eventmachine (1.2.7) + execjs (2.8.1) + faraday (2.7.10) + faraday-net_http (>= 2.0, < 3.1) + ruby2_keywords (>= 0.0.4) + faraday-net_http (3.0.2) + ffi (1.15.5) + forwardable-extended (2.6.0) + gemoji (3.0.1) + github-pages (228) + github-pages-health-check (= 1.17.9) + jekyll (= 3.9.3) + jekyll-avatar (= 0.7.0) + jekyll-coffeescript (= 1.1.1) + jekyll-commonmark-ghpages (= 0.4.0) + jekyll-default-layout (= 0.1.4) + jekyll-feed (= 0.15.1) + jekyll-gist (= 1.5.0) + jekyll-github-metadata (= 2.13.0) + jekyll-include-cache (= 0.2.1) + jekyll-mentions (= 1.6.0) + jekyll-optional-front-matter (= 0.3.2) + jekyll-paginate (= 1.1.0) + jekyll-readme-index (= 0.3.0) + jekyll-redirect-from (= 0.16.0) + jekyll-relative-links (= 0.6.1) + jekyll-remote-theme (= 0.4.3) + jekyll-sass-converter (= 1.5.2) + jekyll-seo-tag (= 2.8.0) + jekyll-sitemap (= 1.4.0) + jekyll-swiss (= 1.0.0) + jekyll-theme-architect (= 0.2.0) + jekyll-theme-cayman (= 0.2.0) + jekyll-theme-dinky (= 0.2.0) + jekyll-theme-hacker (= 0.2.0) + jekyll-theme-leap-day (= 0.2.0) + jekyll-theme-merlot (= 0.2.0) + jekyll-theme-midnight (= 0.2.0) + jekyll-theme-minimal (= 0.2.0) + jekyll-theme-modernist (= 0.2.0) + jekyll-theme-primer (= 0.6.0) + jekyll-theme-slate (= 0.2.0) + jekyll-theme-tactile (= 0.2.0) + jekyll-theme-time-machine (= 0.2.0) + jekyll-titles-from-headings (= 0.5.3) + jemoji (= 0.12.0) + kramdown (= 2.3.2) + kramdown-parser-gfm (= 1.1.0) + liquid (= 4.0.4) + mercenary (~> 0.3) + minima (= 2.5.1) + nokogiri (>= 1.13.6, < 2.0) + rouge (= 3.26.0) + terminal-table (~> 1.4) + github-pages-health-check (1.17.9) + addressable (~> 2.3) + dnsruby (~> 1.60) + octokit (~> 4.0) + public_suffix (>= 3.0, < 5.0) + typhoeus (~> 1.3) + html-pipeline (2.14.3) + activesupport (>= 2) + nokogiri (>= 1.4) + http_parser.rb (0.8.0) + i18n (1.14.1) + concurrent-ruby (~> 1.0) + jekyll (3.9.3) + addressable (~> 2.4) + colorator (~> 1.0) + em-websocket (~> 0.5) + i18n (>= 0.7, < 2) + jekyll-sass-converter (~> 1.0) + jekyll-watch (~> 2.0) + kramdown (>= 1.17, < 3) + liquid (~> 4.0) + mercenary (~> 0.3.3) + pathutil (~> 0.9) + rouge (>= 1.7, < 4) + safe_yaml (~> 1.0) + jekyll-avatar (0.7.0) + jekyll (>= 3.0, < 5.0) + jekyll-coffeescript (1.1.1) + coffee-script (~> 2.2) + coffee-script-source (~> 1.11.1) + jekyll-commonmark (1.4.0) + commonmarker (~> 0.22) + jekyll-commonmark-ghpages (0.4.0) + commonmarker (~> 0.23.7) + jekyll (~> 3.9.0) + jekyll-commonmark (~> 1.4.0) + rouge (>= 2.0, < 5.0) + jekyll-default-layout (0.1.4) + jekyll (~> 3.0) + jekyll-feed (0.15.1) + jekyll (>= 3.7, < 5.0) + jekyll-gist (1.5.0) + octokit (~> 4.2) + jekyll-github-metadata (2.13.0) + jekyll (>= 3.4, < 5.0) + octokit (~> 4.0, != 4.4.0) + jekyll-include-cache (0.2.1) + jekyll (>= 3.7, < 5.0) + jekyll-mentions (1.6.0) + html-pipeline (~> 2.3) + jekyll (>= 3.7, < 5.0) + jekyll-optional-front-matter (0.3.2) + jekyll (>= 3.0, < 5.0) + jekyll-paginate (1.1.0) + jekyll-readme-index (0.3.0) + jekyll (>= 3.0, < 5.0) + jekyll-redirect-from (0.16.0) + jekyll (>= 3.3, < 5.0) + jekyll-relative-links (0.6.1) + jekyll (>= 3.3, < 5.0) + jekyll-remote-theme (0.4.3) + addressable (~> 2.0) + jekyll (>= 3.5, < 5.0) + jekyll-sass-converter (>= 1.0, <= 3.0.0, != 2.0.0) + rubyzip (>= 1.3.0, < 3.0) + jekyll-sass-converter (1.5.2) + sass (~> 3.4) + jekyll-seo-tag (2.8.0) + jekyll (>= 3.8, < 5.0) + jekyll-sitemap (1.4.0) + jekyll (>= 3.7, < 5.0) + jekyll-swiss (1.0.0) + jekyll-theme-architect (0.2.0) + jekyll (> 3.5, < 5.0) + jekyll-seo-tag (~> 2.0) + jekyll-theme-cayman (0.2.0) + jekyll (> 3.5, < 5.0) + jekyll-seo-tag (~> 2.0) + jekyll-theme-dinky (0.2.0) + jekyll (> 3.5, < 5.0) + jekyll-seo-tag (~> 2.0) + jekyll-theme-hacker (0.2.0) + jekyll (> 3.5, < 5.0) + jekyll-seo-tag (~> 2.0) + jekyll-theme-leap-day (0.2.0) + jekyll (> 3.5, < 5.0) + jekyll-seo-tag (~> 2.0) + jekyll-theme-merlot (0.2.0) + jekyll (> 3.5, < 5.0) + jekyll-seo-tag (~> 2.0) + jekyll-theme-midnight (0.2.0) + jekyll (> 3.5, < 5.0) + jekyll-seo-tag (~> 2.0) + jekyll-theme-minimal (0.2.0) + jekyll (> 3.5, < 5.0) + jekyll-seo-tag (~> 2.0) + jekyll-theme-modernist (0.2.0) + jekyll (> 3.5, < 5.0) + jekyll-seo-tag (~> 2.0) + jekyll-theme-primer (0.6.0) + jekyll (> 3.5, < 5.0) + jekyll-github-metadata (~> 2.9) + jekyll-seo-tag (~> 2.0) + jekyll-theme-slate (0.2.0) + jekyll (> 3.5, < 5.0) + jekyll-seo-tag (~> 2.0) + jekyll-theme-tactile (0.2.0) + jekyll (> 3.5, < 5.0) + jekyll-seo-tag (~> 2.0) + jekyll-theme-time-machine (0.2.0) + jekyll (> 3.5, < 5.0) + jekyll-seo-tag (~> 2.0) + jekyll-titles-from-headings (0.5.3) + jekyll (>= 3.3, < 5.0) + jekyll-watch (2.2.1) + listen (~> 3.0) + jemoji (0.12.0) + gemoji (~> 3.0) + html-pipeline (~> 2.2) + jekyll (>= 3.0, < 5.0) + kramdown (2.3.2) + rexml + kramdown-parser-gfm (1.1.0) + kramdown (~> 2.0) + liquid (4.0.4) + listen (3.8.0) + rb-fsevent (~> 0.10, >= 0.10.3) + rb-inotify (~> 0.9, >= 0.9.10) + mercenary (0.3.6) + minima (2.5.1) + jekyll (>= 3.5, < 5.0) + jekyll-feed (~> 0.9) + jekyll-seo-tag (~> 2.1) + minitest (5.18.1) + nokogiri (1.15.3-x86_64-linux) + racc (~> 1.4) + octokit (4.25.1) + faraday (>= 1, < 3) + sawyer (~> 0.9) + pathutil (0.16.2) + forwardable-extended (~> 2.6) + public_suffix (4.0.7) + racc (1.7.1) + rb-fsevent (0.11.2) + rb-inotify (0.10.1) + ffi (~> 1.0) + rexml (3.2.5) + rouge (3.26.0) + ruby2_keywords (0.0.5) + rubyzip (2.3.2) + safe_yaml (1.0.5) + sass (3.7.4) + sass-listen (~> 4.0.0) + sass-listen (4.0.0) + rb-fsevent (~> 0.9, >= 0.9.4) + rb-inotify (~> 0.9, >= 0.9.7) + sawyer (0.9.2) + addressable (>= 2.3.5) + faraday (>= 0.17.3, < 3) + simpleidn (0.2.1) + unf (~> 0.1.4) + terminal-table (1.8.0) + unicode-display_width (~> 1.1, >= 1.1.1) + typhoeus (1.4.0) + ethon (>= 0.9.0) + tzinfo (2.0.6) + concurrent-ruby (~> 1.0) + unf (0.1.4) + unf_ext + unf_ext (0.0.8.2) + unicode-display_width (1.8.0) + +PLATFORMS + x86_64-linux + +DEPENDENCIES + github-pages (~> 228) + http_parser.rb (~> 0.6.0) + jekyll-feed (~> 0.12) + minima (~> 2.5) + tzinfo (>= 1, < 3) + tzinfo-data + wdm (~> 0.1.1) + +BUNDLED WITH + 2.2.3 diff --git a/docs/_config.yml b/docs/_config.yml index 78cbc8ab..bd5c0e6d 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -1,3 +1,55 @@ -theme: jekyll-theme-minimal -title: AnsibleForms Documentation -description: Bookmark this to keep an eye on my project updates! \ No newline at end of file +# Welcome to Jekyll! +# +# This config file is meant for settings that affect your whole blog, values +# which you are expected to set up once and rarely edit after that. If you find +# yourself editing this file very often, consider using Jekyll's data files +# feature for the data you need to update frequently. +# +# For technical reasons, this file is *NOT* reloaded automatically when you use +# 'bundle exec jekyll serve'. If you change this file, please restart the server process. +# +# If you need help with YAML syntax, here are some quick references for you: +# https://learn-the-web.algonquindesign.ca/topics/markdown-yaml-cheat-sheet/#yaml +# https://learnxinyminutes.com/docs/yaml/ +# +# Site settings +# These are used to personalize your new site. If you look in the HTML files, +# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on. +# You can create any custom variable you would like, and they will be accessible +# in the templates via {{ site.myvariable }}. + +title: AnsibleForms Help Documentation +email: info@ansibleforms.com +description: >- # this means to ignore newlines until "baseurl:" + Write an awesome description for your new site here. You can edit this + line in _config.yml. It will appear in your document head meta (for + Google search results) and in your feed.xml site description. +baseurl: "/ansibleforms" # the subpath of your site, e.g. /blog +url: "https://ansibleguy76.github.io" # the base hostname & protocol for your site, e.g. http://example.com +#twitter_username: jekyllrb +github_username: ansibleguy76 + +# Build settings +theme: minima +plugins: + - jekyll-feed + +# Exclude from processing. +# The following items will not be processed, by default. +# Any item listed under the `exclude:` key here will be automatically added to +# the internal "default list". +# +# Excluded items can be processed by explicitly listing the directories or +# their entries' file path in the `include:` list. +# +# exclude: +# - .sass-cache/ +# - .jekyll-cache/ +# - gemfiles/ +# - Gemfile +# - Gemfile.lock +# - node_modules/ +# - vendor/bundle/ +# - vendor/cache/ +# - vendor/gems/ +# - vendor/ruby/ diff --git a/docs/_posts/2023-07-19-welcome-to-jekyll.markdown b/docs/_posts/2023-07-19-welcome-to-jekyll.markdown new file mode 100644 index 00000000..a6463cc7 --- /dev/null +++ b/docs/_posts/2023-07-19-welcome-to-jekyll.markdown @@ -0,0 +1,29 @@ +--- +layout: post +title: "Welcome to Jekyll!" +date: 2023-07-19 17:23:15 +0200 +categories: jekyll update +--- +You’ll find this post in your `_posts` directory. Go ahead and edit it and re-build the site to see your changes. You can rebuild the site in many different ways, but the most common way is to run `jekyll serve`, which launches a web server and auto-regenerates your site when a file is updated. + +Jekyll requires blog post files to be named according to the following format: + +`YEAR-MONTH-DAY-title.MARKUP` + +Where `YEAR` is a four-digit number, `MONTH` and `DAY` are both two-digit numbers, and `MARKUP` is the file extension representing the format used in the file. After that, include the necessary front matter. Take a look at the source for this post to get an idea about how it works. + +Jekyll also offers powerful support for code snippets: + +{% highlight ruby %} +def print_hi(name) + puts "Hi, #{name}" +end +print_hi('Tom') +#=> prints 'Hi, Tom' to STDOUT. +{% endhighlight %} + +Check out the [Jekyll docs][jekyll-docs] for more info on how to get the most out of Jekyll. File all bugs/feature requests at [Jekyll’s GitHub repo][jekyll-gh]. If you have questions, you can ask them on [Jekyll Talk][jekyll-talk]. + +[jekyll-docs]: https://jekyllrb.com/docs/home +[jekyll-gh]: https://github.com/jekyll/jekyll +[jekyll-talk]: https://talk.jekyllrb.com/ diff --git a/docs/about.markdown b/docs/about.markdown new file mode 100644 index 00000000..8b4e0b28 --- /dev/null +++ b/docs/about.markdown @@ -0,0 +1,18 @@ +--- +layout: page +title: About +permalink: /about/ +--- + +This is the base Jekyll theme. You can find out more info about customizing your Jekyll theme, as well as basic Jekyll usage documentation at [jekyllrb.com](https://jekyllrb.com/) + +You can find the source code for Minima at GitHub: +[jekyll][jekyll-organization] / +[minima](https://github.com/jekyll/minima) + +You can find the source code for Jekyll at GitHub: +[jekyll][jekyll-organization] / +[jekyll](https://github.com/jekyll/jekyll) + + +[jekyll-organization]: https://github.com/jekyll diff --git a/docs/index.markdown b/docs/index.markdown new file mode 100644 index 00000000..06715078 --- /dev/null +++ b/docs/index.markdown @@ -0,0 +1,6 @@ +--- +# Feel free to add content and custom Front Matter to this file. +# To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults + +layout: home +--- From 012e6bf8edf0b2673d62af9380db625a2b45b698 Mon Sep 17 00:00:00 2001 From: vcmirko <37864434+wfaguy@users.noreply.github.com> Date: Mon, 24 Jul 2023 10:11:20 +0200 Subject: [PATCH 4/5] first start to add documentation --- docs/404.html | 25 - docs/404.md | 6 + docs/Dockerfile | 14 + docs/Gemfile | 35 +- docs/Gemfile.lock | 225 +- docs/LICENSE | 13 + docs/LICENSE-BSD-NAVGOCO.txt | 27 + docs/_config.yml | 175 +- docs/_data/alerts.yml | 18 + docs/_data/definitions.yml | 12 + docs/_data/glossary.yml | 13 + docs/_data/samplelist.yml | 109 + docs/_data/sidebars/home_sidebar.yml | 24 + docs/_data/sidebars/mydoc_sidebar.yml | 297 + docs/_data/sidebars/other.yml | 20 + docs/_data/sidebars/product1_sidebar.yml | 62 + docs/_data/sidebars/product2_sidebar.yml | 94 + docs/_data/strings.yml | 8 + docs/_data/tags.yml | 17 + docs/_data/terms.yml | 3 + docs/_data/topnav.yml | 34 + docs/_includes/archive.html | 15 + docs/_includes/callout.html | 4 + docs/_includes/commento.html | 8 + .../custom/getting_started_series.html | 21 + .../custom/getting_started_series_next.html | 13 + docs/_includes/custom/series_acme.html | 21 + docs/_includes/custom/series_acme_next.html | 32 + docs/_includes/custom/usermap.html | 16 + docs/_includes/custom/usermapcomplex.html | 93 + docs/_includes/feedback.html | 15 + docs/_includes/footer.html | 11 + docs/_includes/google_analytics.html | 8 + docs/_includes/head.html | 43 + docs/_includes/head_print.html | 30 + docs/_includes/image.html | 3 + docs/_includes/important.html | 3 + docs/_includes/initialize_shuffle.html | 130 + docs/_includes/inline_image.html | 3 + docs/_includes/links.html | 45 + docs/_includes/note.html | 3 + docs/_includes/sidebar.html | 60 + docs/_includes/taglogic.html | 33 + docs/_includes/tip.html | 3 + docs/_includes/toc.html | 23 + docs/_includes/topnav.html | 83 + docs/_includes/warning.html | 3 + docs/_layouts/default.html | 108 + docs/_layouts/default_print.html | 26 + docs/_layouts/none.html | 5 + docs/_layouts/page.html | 70 + docs/_layouts/page_print.html | 17 + docs/_layouts/post.html | 41 + docs/_posts/2015-04-12-test-post-last-year.md | 10 + docs/_posts/2016-02-24-first-post.md | 19 + docs/_posts/2016-02-26-sample-post-jekyll.md | 17 + .../2023-07-19-welcome-to-jekyll.markdown | 29 - docs/_tooltips/baseball.html | 6 + docs/_tooltips/basketball.html | 6 + docs/_tooltips/football.html | 6 + docs/_tooltips/soccer.html | 6 + docs/about.markdown | 18 - docs/build.sh | 18 + docs/createtag | 54 + docs/css/bootstrap.min.css | 7529 +++++++++++++++++ docs/css/boxshadowproperties.css | 24 + docs/css/customstyles.css | 1203 +++ docs/css/font-awesome.min.css | 4 + docs/css/fonts/FontAwesome.otf | Bin 0 -> 134808 bytes docs/css/fonts/fontawesome-webfont.eot | Bin 0 -> 165742 bytes docs/css/fonts/fontawesome-webfont.svg | 2671 ++++++ docs/css/fonts/fontawesome-webfont.ttf | Bin 0 -> 165548 bytes docs/css/fonts/fontawesome-webfont.woff | Bin 0 -> 98024 bytes docs/css/fonts/fontawesome-webfont.woff2 | Bin 0 -> 77160 bytes docs/css/modern-business.css | 89 + docs/css/printstyles.css | 159 + docs/css/syntax.css | 60 + docs/css/theme-blue.css | 121 + docs/css/theme-green.css | 110 + docs/docker-compose.yml | 11 + docs/feed.xml | 32 + docs/fonts/FontAwesome.otf | Bin 0 -> 85908 bytes docs/fonts/fontawesome-webfont.eot | Bin 0 -> 56006 bytes docs/fonts/fontawesome-webfont.svg | 520 ++ docs/fonts/fontawesome-webfont.ttf | Bin 0 -> 112160 bytes docs/fonts/fontawesome-webfont.woff | Bin 0 -> 65452 bytes docs/fonts/glyphicons-halflings-regular.eot | Bin 0 -> 20127 bytes docs/fonts/glyphicons-halflings-regular.svg | 288 + docs/fonts/glyphicons-halflings-regular.ttf | Bin 0 -> 45404 bytes docs/fonts/glyphicons-halflings-regular.woff | Bin 0 -> 23424 bytes docs/fonts/glyphicons-halflings-regular.woff2 | Bin 0 -> 18028 bytes docs/images/androidsdkmanagericon.png | Bin 0 -> 795 bytes docs/images/authorizegithubscreen2.png | Bin 0 -> 76388 bytes docs/images/authorizeongithub.png | Bin 0 -> 22571 bytes docs/images/company_logo.png | Bin 0 -> 3105 bytes docs/images/company_logo_big.png | Bin 0 -> 9588 bytes docs/images/favicon.ico | Bin 0 -> 177352 bytes docs/images/helpapi-01.png | Bin 0 -> 91640 bytes docs/images/helpapi.svg | 1661 ++++ docs/images/illustratoroptions.png | Bin 0 -> 118175 bytes docs/images/itermexample.png | Bin 0 -> 68886 bytes docs/images/jekyll.png | Bin 0 -> 5375 bytes docs/images/killalljekyll.png | Bin 0 -> 66686 bytes docs/images/liningup.png | Bin 0 -> 74728 bytes docs/images/workflowarrow.png | Bin 0 -> 3595 bytes docs/index.markdown | 6 - docs/index.md | 414 + docs/js/customscripts.js | 54 + docs/js/jekyll-search.js | 1 + docs/js/jquery.ba-throttle-debounce.min.js | 9 + docs/js/jquery.navgoco.min.js | 8 + docs/js/jquery.shuffle.min.js | 1588 ++++ docs/js/toc.js | 82 + docs/pages/mydoc/mydoc_about.md | 22 + .../mydoc/mydoc_about_ruby_gems_bundler.md | 254 + docs/pages/mydoc/mydoc_adding_tooltips.md | 27 + docs/pages/mydoc/mydoc_alerts.md | 211 + docs/pages/mydoc/mydoc_atom_text_editor.md | 35 + docs/pages/mydoc/mydoc_build_arguments.md | 68 + docs/pages/mydoc/mydoc_build_scripts.md | 197 + docs/pages/mydoc/mydoc_code_samples.md | 27 + docs/pages/mydoc/mydoc_collections.md | 40 + docs/pages/mydoc/mydoc_commenting_on_files.md | 68 + docs/pages/mydoc/mydoc_conditional_logic.md | 156 + docs/pages/mydoc/mydoc_content_reuse.md | 58 + docs/pages/mydoc/mydoc_excluding_files.md | 86 + docs/pages/mydoc/mydoc_faq.md | 136 + docs/pages/mydoc/mydoc_generating_pdfs.md | 429 + docs/pages/mydoc/mydoc_git_collaboration.md | 185 + docs/pages/mydoc/mydoc_glossary.md | 111 + docs/pages/mydoc/mydoc_help_api.md | 363 + docs/pages/mydoc/mydoc_hyperlinks.md | 29 + docs/pages/mydoc/mydoc_icons.md | 242 + docs/pages/mydoc/mydoc_images.md | 99 + .../mydoc/mydoc_install_jekyll_on_mac.md | 157 + .../mydoc/mydoc_install_jekyll_on_windows.md | 93 + docs/pages/mydoc/mydoc_installing_bundler.md | 43 + docs/pages/mydoc/mydoc_introduction.md | 30 + docs/pages/mydoc/mydoc_iterm_profiles.md | 43 + docs/pages/mydoc/mydoc_kb_layout.md | 115 + docs/pages/mydoc/mydoc_labels.md | 33 + docs/pages/mydoc/mydoc_lists.md | 133 + docs/pages/mydoc/mydoc_navtabs.md | 114 + docs/pages/mydoc/mydoc_pages.md | 183 + docs/pages/mydoc/mydoc_posts.md | 47 + .../mydoc/mydoc_publishing_github_pages.md | 74 + .../pages/mydoc/mydoc_push_build_to_server.md | 35 + docs/pages/mydoc/mydoc_release_notes_50.md | 48 + docs/pages/mydoc/mydoc_release_notes_60.md | 40 + .../pages/mydoc/mydoc_search_configuration.md | 120 + docs/pages/mydoc/mydoc_series.md | 110 + docs/pages/mydoc/mydoc_seriesdemo1.md | 22 + docs/pages/mydoc/mydoc_seriesdemo2.md | 24 + docs/pages/mydoc/mydoc_seriesdemo3.md | 24 + docs/pages/mydoc/mydoc_seriesdemo4.md | 26 + docs/pages/mydoc/mydoc_shuffle.html | 167 + docs/pages/mydoc/mydoc_sidebar_navigation.md | 84 + docs/pages/mydoc/mydoc_special_layouts.md | 27 + docs/pages/mydoc/mydoc_support.md | 13 + docs/pages/mydoc/mydoc_supported_features.md | 55 + docs/pages/mydoc/mydoc_syntax_highlighting.md | 111 + docs/pages/mydoc/mydoc_tables.md | 141 + .../mydoc/mydoc_tag_archives_overview.md | 18 + docs/pages/mydoc/mydoc_tags.md | 199 + docs/pages/mydoc/mydoc_themes.md | 28 + docs/pages/mydoc/mydoc_troubleshooting.md | 81 + .../pages/mydoc/mydoc_webstorm_text_editor.md | 90 + docs/pages/mydoc/mydoc_workflow_maps.md | 142 + docs/pages/mydoc/mydoc_yaml_tutorial.md | 426 + docs/pages/news/news.html | 32 + docs/pages/news/news_archive.html | 35 + docs/pages/product1/p1_landing_page.html | 239 + docs/pages/product1/p1_sample1.md | 25 + docs/pages/product1/p1_sample2.md | 25 + docs/pages/product1/p1_sample3.md | 25 + docs/pages/product1/p1_sample4.md | 25 + docs/pages/product1/p1_sample5.md | 25 + docs/pages/product1/p1_sample6.md | 25 + docs/pages/product1/p1_sample7.md | 25 + docs/pages/product2/p2_landing_page.html | 239 + docs/pages/product2/p2_sample1.md | 29 + docs/pages/product2/p2_sample10.md | 29 + docs/pages/product2/p2_sample11.md | 29 + docs/pages/product2/p2_sample12.md | 29 + docs/pages/product2/p2_sample13.md | 30 + docs/pages/product2/p2_sample14.md | 30 + docs/pages/product2/p2_sample2.md | 30 + docs/pages/product2/p2_sample3.md | 28 + docs/pages/product2/p2_sample4.md | 28 + docs/pages/product2/p2_sample5.md | 28 + docs/pages/product2/p2_sample6.md | 30 + docs/pages/product2/p2_sample7.md | 30 + docs/pages/product2/p2_sample8.md | 30 + docs/pages/product2/p2_sample9.md | 31 + docs/pages/tags/tag_collaboration.md | 11 + docs/pages/tags/tag_content_types.md | 11 + docs/pages/tags/tag_formatting.md | 11 + docs/pages/tags/tag_getting_started.md | 11 + docs/pages/tags/tag_mobile.md | 11 + docs/pages/tags/tag_navigation.md | 11 + docs/pages/tags/tag_news.md | 11 + docs/pages/tags/tag_publishing.md | 11 + docs/pages/tags/tag_single_sourcing.md | 11 + docs/pages/tags/tag_special_layouts.md | 12 + docs/pages/tags/tag_troubleshooting.md | 11 + docs/pdf-all.sh | 1 + docs/pdf-mydoc.sh | 14 + docs/pdf-product1.sh | 11 + docs/pdf-product2.sh | 11 + docs/pdf/mydoc.pdf | Bin 0 -> 1038295 bytes docs/pdf/product1.pdf | Bin 0 -> 115101 bytes docs/pdf/product2.pdf | Bin 0 -> 142049 bytes docs/pdfconfigs/config_mydoc_pdf.yml | 19 + docs/pdfconfigs/config_product1_pdf.yml | 19 + docs/pdfconfigs/config_product2_pdf.yml | 19 + docs/pdfconfigs/prince-list.txt | 82 + docs/pdfconfigs/titlepage.html | 22 + docs/pdfconfigs/tocpage.html | 44 + docs/search.json | 32 + docs/sitemap.xml | 24 + docs/tooltips.html | 79 + docs/tooltips.json | 19 + docs/update.sh | 4 + docs/var/build.sh | 10 + docs/watch.sh | 23 + 225 files changed, 26406 insertions(+), 272 deletions(-) delete mode 100644 docs/404.html create mode 100644 docs/404.md create mode 100644 docs/Dockerfile create mode 100644 docs/LICENSE create mode 100644 docs/LICENSE-BSD-NAVGOCO.txt create mode 100644 docs/_data/alerts.yml create mode 100644 docs/_data/definitions.yml create mode 100644 docs/_data/glossary.yml create mode 100644 docs/_data/samplelist.yml create mode 100644 docs/_data/sidebars/home_sidebar.yml create mode 100644 docs/_data/sidebars/mydoc_sidebar.yml create mode 100644 docs/_data/sidebars/other.yml create mode 100644 docs/_data/sidebars/product1_sidebar.yml create mode 100644 docs/_data/sidebars/product2_sidebar.yml create mode 100644 docs/_data/strings.yml create mode 100644 docs/_data/tags.yml create mode 100644 docs/_data/terms.yml create mode 100644 docs/_data/topnav.yml create mode 100644 docs/_includes/archive.html create mode 100644 docs/_includes/callout.html create mode 100644 docs/_includes/commento.html create mode 100644 docs/_includes/custom/getting_started_series.html create mode 100644 docs/_includes/custom/getting_started_series_next.html create mode 100644 docs/_includes/custom/series_acme.html create mode 100644 docs/_includes/custom/series_acme_next.html create mode 100644 docs/_includes/custom/usermap.html create mode 100644 docs/_includes/custom/usermapcomplex.html create mode 100644 docs/_includes/feedback.html create mode 100644 docs/_includes/footer.html create mode 100644 docs/_includes/google_analytics.html create mode 100644 docs/_includes/head.html create mode 100644 docs/_includes/head_print.html create mode 100644 docs/_includes/image.html create mode 100644 docs/_includes/important.html create mode 100644 docs/_includes/initialize_shuffle.html create mode 100644 docs/_includes/inline_image.html create mode 100644 docs/_includes/links.html create mode 100644 docs/_includes/note.html create mode 100644 docs/_includes/sidebar.html create mode 100644 docs/_includes/taglogic.html create mode 100644 docs/_includes/tip.html create mode 100644 docs/_includes/toc.html create mode 100644 docs/_includes/topnav.html create mode 100644 docs/_includes/warning.html create mode 100644 docs/_layouts/default.html create mode 100644 docs/_layouts/default_print.html create mode 100644 docs/_layouts/none.html create mode 100644 docs/_layouts/page.html create mode 100644 docs/_layouts/page_print.html create mode 100644 docs/_layouts/post.html create mode 100644 docs/_posts/2015-04-12-test-post-last-year.md create mode 100644 docs/_posts/2016-02-24-first-post.md create mode 100644 docs/_posts/2016-02-26-sample-post-jekyll.md delete mode 100644 docs/_posts/2023-07-19-welcome-to-jekyll.markdown create mode 100644 docs/_tooltips/baseball.html create mode 100644 docs/_tooltips/basketball.html create mode 100644 docs/_tooltips/football.html create mode 100644 docs/_tooltips/soccer.html delete mode 100644 docs/about.markdown create mode 100644 docs/build.sh create mode 100644 docs/createtag create mode 100644 docs/css/bootstrap.min.css create mode 100644 docs/css/boxshadowproperties.css create mode 100644 docs/css/customstyles.css create mode 100644 docs/css/font-awesome.min.css create mode 100644 docs/css/fonts/FontAwesome.otf create mode 100644 docs/css/fonts/fontawesome-webfont.eot create mode 100644 docs/css/fonts/fontawesome-webfont.svg create mode 100644 docs/css/fonts/fontawesome-webfont.ttf create mode 100644 docs/css/fonts/fontawesome-webfont.woff create mode 100644 docs/css/fonts/fontawesome-webfont.woff2 create mode 100644 docs/css/modern-business.css create mode 100644 docs/css/printstyles.css create mode 100644 docs/css/syntax.css create mode 100644 docs/css/theme-blue.css create mode 100644 docs/css/theme-green.css create mode 100644 docs/docker-compose.yml create mode 100644 docs/feed.xml create mode 100644 docs/fonts/FontAwesome.otf create mode 100644 docs/fonts/fontawesome-webfont.eot create mode 100644 docs/fonts/fontawesome-webfont.svg create mode 100644 docs/fonts/fontawesome-webfont.ttf create mode 100644 docs/fonts/fontawesome-webfont.woff create mode 100644 docs/fonts/glyphicons-halflings-regular.eot create mode 100644 docs/fonts/glyphicons-halflings-regular.svg create mode 100644 docs/fonts/glyphicons-halflings-regular.ttf create mode 100644 docs/fonts/glyphicons-halflings-regular.woff create mode 100644 docs/fonts/glyphicons-halflings-regular.woff2 create mode 100644 docs/images/androidsdkmanagericon.png create mode 100644 docs/images/authorizegithubscreen2.png create mode 100644 docs/images/authorizeongithub.png create mode 100644 docs/images/company_logo.png create mode 100644 docs/images/company_logo_big.png create mode 100644 docs/images/favicon.ico create mode 100644 docs/images/helpapi-01.png create mode 100644 docs/images/helpapi.svg create mode 100644 docs/images/illustratoroptions.png create mode 100644 docs/images/itermexample.png create mode 100644 docs/images/jekyll.png create mode 100644 docs/images/killalljekyll.png create mode 100644 docs/images/liningup.png create mode 100644 docs/images/workflowarrow.png delete mode 100644 docs/index.markdown create mode 100644 docs/index.md create mode 100644 docs/js/customscripts.js create mode 100644 docs/js/jekyll-search.js create mode 100644 docs/js/jquery.ba-throttle-debounce.min.js create mode 100644 docs/js/jquery.navgoco.min.js create mode 100644 docs/js/jquery.shuffle.min.js create mode 100644 docs/js/toc.js create mode 100644 docs/pages/mydoc/mydoc_about.md create mode 100644 docs/pages/mydoc/mydoc_about_ruby_gems_bundler.md create mode 100644 docs/pages/mydoc/mydoc_adding_tooltips.md create mode 100644 docs/pages/mydoc/mydoc_alerts.md create mode 100644 docs/pages/mydoc/mydoc_atom_text_editor.md create mode 100644 docs/pages/mydoc/mydoc_build_arguments.md create mode 100644 docs/pages/mydoc/mydoc_build_scripts.md create mode 100644 docs/pages/mydoc/mydoc_code_samples.md create mode 100644 docs/pages/mydoc/mydoc_collections.md create mode 100644 docs/pages/mydoc/mydoc_commenting_on_files.md create mode 100644 docs/pages/mydoc/mydoc_conditional_logic.md create mode 100644 docs/pages/mydoc/mydoc_content_reuse.md create mode 100644 docs/pages/mydoc/mydoc_excluding_files.md create mode 100644 docs/pages/mydoc/mydoc_faq.md create mode 100644 docs/pages/mydoc/mydoc_generating_pdfs.md create mode 100644 docs/pages/mydoc/mydoc_git_collaboration.md create mode 100644 docs/pages/mydoc/mydoc_glossary.md create mode 100644 docs/pages/mydoc/mydoc_help_api.md create mode 100644 docs/pages/mydoc/mydoc_hyperlinks.md create mode 100644 docs/pages/mydoc/mydoc_icons.md create mode 100644 docs/pages/mydoc/mydoc_images.md create mode 100644 docs/pages/mydoc/mydoc_install_jekyll_on_mac.md create mode 100644 docs/pages/mydoc/mydoc_install_jekyll_on_windows.md create mode 100644 docs/pages/mydoc/mydoc_installing_bundler.md create mode 100644 docs/pages/mydoc/mydoc_introduction.md create mode 100644 docs/pages/mydoc/mydoc_iterm_profiles.md create mode 100644 docs/pages/mydoc/mydoc_kb_layout.md create mode 100644 docs/pages/mydoc/mydoc_labels.md create mode 100644 docs/pages/mydoc/mydoc_lists.md create mode 100644 docs/pages/mydoc/mydoc_navtabs.md create mode 100644 docs/pages/mydoc/mydoc_pages.md create mode 100644 docs/pages/mydoc/mydoc_posts.md create mode 100644 docs/pages/mydoc/mydoc_publishing_github_pages.md create mode 100644 docs/pages/mydoc/mydoc_push_build_to_server.md create mode 100644 docs/pages/mydoc/mydoc_release_notes_50.md create mode 100644 docs/pages/mydoc/mydoc_release_notes_60.md create mode 100644 docs/pages/mydoc/mydoc_search_configuration.md create mode 100644 docs/pages/mydoc/mydoc_series.md create mode 100644 docs/pages/mydoc/mydoc_seriesdemo1.md create mode 100644 docs/pages/mydoc/mydoc_seriesdemo2.md create mode 100644 docs/pages/mydoc/mydoc_seriesdemo3.md create mode 100644 docs/pages/mydoc/mydoc_seriesdemo4.md create mode 100644 docs/pages/mydoc/mydoc_shuffle.html create mode 100644 docs/pages/mydoc/mydoc_sidebar_navigation.md create mode 100644 docs/pages/mydoc/mydoc_special_layouts.md create mode 100644 docs/pages/mydoc/mydoc_support.md create mode 100644 docs/pages/mydoc/mydoc_supported_features.md create mode 100644 docs/pages/mydoc/mydoc_syntax_highlighting.md create mode 100644 docs/pages/mydoc/mydoc_tables.md create mode 100644 docs/pages/mydoc/mydoc_tag_archives_overview.md create mode 100644 docs/pages/mydoc/mydoc_tags.md create mode 100644 docs/pages/mydoc/mydoc_themes.md create mode 100644 docs/pages/mydoc/mydoc_troubleshooting.md create mode 100644 docs/pages/mydoc/mydoc_webstorm_text_editor.md create mode 100644 docs/pages/mydoc/mydoc_workflow_maps.md create mode 100644 docs/pages/mydoc/mydoc_yaml_tutorial.md create mode 100644 docs/pages/news/news.html create mode 100644 docs/pages/news/news_archive.html create mode 100644 docs/pages/product1/p1_landing_page.html create mode 100644 docs/pages/product1/p1_sample1.md create mode 100644 docs/pages/product1/p1_sample2.md create mode 100644 docs/pages/product1/p1_sample3.md create mode 100644 docs/pages/product1/p1_sample4.md create mode 100644 docs/pages/product1/p1_sample5.md create mode 100644 docs/pages/product1/p1_sample6.md create mode 100644 docs/pages/product1/p1_sample7.md create mode 100644 docs/pages/product2/p2_landing_page.html create mode 100644 docs/pages/product2/p2_sample1.md create mode 100644 docs/pages/product2/p2_sample10.md create mode 100644 docs/pages/product2/p2_sample11.md create mode 100644 docs/pages/product2/p2_sample12.md create mode 100644 docs/pages/product2/p2_sample13.md create mode 100644 docs/pages/product2/p2_sample14.md create mode 100644 docs/pages/product2/p2_sample2.md create mode 100644 docs/pages/product2/p2_sample3.md create mode 100644 docs/pages/product2/p2_sample4.md create mode 100644 docs/pages/product2/p2_sample5.md create mode 100644 docs/pages/product2/p2_sample6.md create mode 100644 docs/pages/product2/p2_sample7.md create mode 100644 docs/pages/product2/p2_sample8.md create mode 100644 docs/pages/product2/p2_sample9.md create mode 100644 docs/pages/tags/tag_collaboration.md create mode 100644 docs/pages/tags/tag_content_types.md create mode 100644 docs/pages/tags/tag_formatting.md create mode 100644 docs/pages/tags/tag_getting_started.md create mode 100644 docs/pages/tags/tag_mobile.md create mode 100644 docs/pages/tags/tag_navigation.md create mode 100644 docs/pages/tags/tag_news.md create mode 100644 docs/pages/tags/tag_publishing.md create mode 100644 docs/pages/tags/tag_single_sourcing.md create mode 100644 docs/pages/tags/tag_special_layouts.md create mode 100644 docs/pages/tags/tag_troubleshooting.md create mode 100644 docs/pdf-all.sh create mode 100644 docs/pdf-mydoc.sh create mode 100644 docs/pdf-product1.sh create mode 100644 docs/pdf-product2.sh create mode 100644 docs/pdf/mydoc.pdf create mode 100644 docs/pdf/product1.pdf create mode 100644 docs/pdf/product2.pdf create mode 100644 docs/pdfconfigs/config_mydoc_pdf.yml create mode 100644 docs/pdfconfigs/config_product1_pdf.yml create mode 100644 docs/pdfconfigs/config_product2_pdf.yml create mode 100644 docs/pdfconfigs/prince-list.txt create mode 100644 docs/pdfconfigs/titlepage.html create mode 100644 docs/pdfconfigs/tocpage.html create mode 100644 docs/search.json create mode 100644 docs/sitemap.xml create mode 100644 docs/tooltips.html create mode 100644 docs/tooltips.json create mode 100644 docs/update.sh create mode 100644 docs/var/build.sh create mode 100644 docs/watch.sh diff --git a/docs/404.html b/docs/404.html deleted file mode 100644 index 086a5c9e..00000000 --- a/docs/404.html +++ /dev/null @@ -1,25 +0,0 @@ ---- -permalink: /404.html -layout: default ---- - - - -
-

404

- -

Page not found :(

-

The requested page could not be found.

-
diff --git a/docs/404.md b/docs/404.md new file mode 100644 index 00000000..a7b58c00 --- /dev/null +++ b/docs/404.md @@ -0,0 +1,6 @@ +--- +title: "Page Not Found" +search: exclude +--- + +Sorry, but the page you were trying to view does not exist. Try searching for it or looking at the URL to see if it looks correct. diff --git a/docs/Dockerfile b/docs/Dockerfile new file mode 100644 index 00000000..7eed201a --- /dev/null +++ b/docs/Dockerfile @@ -0,0 +1,14 @@ +FROM jekyll/builder + +WORKDIR /tmp +ADD Gemfile /tmp/ +ADD Gemfile.lock /tmp/ +RUN bundle install + +FROM jekyll/jekyll + +VOLUME /src +EXPOSE 4000 + +WORKDIR /src +ENTRYPOINT ["jekyll", "serve", "--livereload", "-H", "0.0.0.0"] diff --git a/docs/Gemfile b/docs/Gemfile index a43b41fd..515633aa 100644 --- a/docs/Gemfile +++ b/docs/Gemfile @@ -1,34 +1,7 @@ source "https://rubygems.org" -# Hello! This is where you manage which Jekyll version is used to run. -# When you want to use a different version, change it below, save the -# file and run `bundle install`. Run Jekyll with `bundle exec`, like so: -# -# bundle exec jekyll serve -# -# This will help ensure the proper Jekyll version is running. -# Happy Jekylling! -# gem "jekyll", "~> 4.3.2" -gem "github-pages", "~> 228", group: :jekyll_plugins -# This is the default theme for new Jekyll sites. You may change this to anything you like. -gem "minima", "~> 2.5" -# If you want to use GitHub Pages, remove the "gem "jekyll"" above and -# uncomment the line below. To upgrade, run `bundle update github-pages`. -# gem "github-pages", group: :jekyll_plugins -# If you have any plugins, put them here! -group :jekyll_plugins do - gem "jekyll-feed", "~> 0.12" -end -# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem -# and associated library. -platforms :mingw, :x64_mingw, :mswin, :jruby do - gem "tzinfo", ">= 1", "< 3" - gem "tzinfo-data" -end +# to publish on github page +gem 'github-pages', group: :jekyll_plugins -# Performance-booster for watching directories on Windows -gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin] - -# Lock `http_parser.rb` gem to `v0.6.x` on JRuby builds since newer versions of the gem -# do not have a Java counterpart. -gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby] +# to publich without github page +#gem "jekyll" diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock index 558f0c70..e8ad94bf 100644 --- a/docs/Gemfile.lock +++ b/docs/Gemfile.lock @@ -1,47 +1,57 @@ GEM remote: https://rubygems.org/ specs: - activesupport (7.0.6) + activesupport (6.0.6.1) concurrent-ruby (~> 1.0, >= 1.0.2) - i18n (>= 1.6, < 2) - minitest (>= 5.1) - tzinfo (~> 2.0) - addressable (2.8.4) - public_suffix (>= 2.0.2, < 6.0) + i18n (>= 0.7, < 2) + minitest (~> 5.1) + tzinfo (~> 1.1) + zeitwerk (~> 2.2, >= 2.2.2) + addressable (2.8.0) + public_suffix (>= 2.0.2, < 5.0) coffee-script (2.4.1) coffee-script-source execjs coffee-script-source (1.11.1) colorator (1.1.0) - commonmarker (0.23.9) - concurrent-ruby (1.2.2) - dnsruby (1.70.0) - simpleidn (~> 0.2.1) - em-websocket (0.5.3) + commonmarker (0.17.13) + ruby-enum (~> 0.5) + concurrent-ruby (1.2.0) + dnsruby (1.61.7) + simpleidn (~> 0.1) + em-websocket (0.5.2) eventmachine (>= 0.12.9) - http_parser.rb (~> 0) - ethon (0.16.0) + http_parser.rb (~> 0.6.0) + ethon (0.14.0) ffi (>= 1.15.0) eventmachine (1.2.7) execjs (2.8.1) - faraday (2.7.10) - faraday-net_http (>= 2.0, < 3.1) + faraday (1.4.3) + faraday-em_http (~> 1.0) + faraday-em_synchrony (~> 1.0) + faraday-excon (~> 1.1) + faraday-net_http (~> 1.0) + faraday-net_http_persistent (~> 1.1) + multipart-post (>= 1.2, < 3) ruby2_keywords (>= 0.0.4) - faraday-net_http (3.0.2) - ffi (1.15.5) + faraday-em_http (1.0.0) + faraday-em_synchrony (1.0.0) + faraday-excon (1.1.0) + faraday-net_http (1.0.1) + faraday-net_http_persistent (1.1.0) + ffi (1.15.3) forwardable-extended (2.6.0) gemoji (3.0.1) - github-pages (228) - github-pages-health-check (= 1.17.9) - jekyll (= 3.9.3) + github-pages (215) + github-pages-health-check (= 1.17.2) + jekyll (= 3.9.0) jekyll-avatar (= 0.7.0) jekyll-coffeescript (= 1.1.1) - jekyll-commonmark-ghpages (= 0.4.0) + jekyll-commonmark-ghpages (= 0.1.6) jekyll-default-layout (= 0.1.4) jekyll-feed (= 0.15.1) jekyll-gist (= 1.5.0) jekyll-github-metadata (= 2.13.0) - jekyll-include-cache (= 0.2.1) jekyll-mentions (= 1.6.0) jekyll-optional-front-matter (= 0.3.2) jekyll-paginate (= 1.1.0) @@ -50,49 +60,49 @@ GEM jekyll-relative-links (= 0.6.1) jekyll-remote-theme (= 0.4.3) jekyll-sass-converter (= 1.5.2) - jekyll-seo-tag (= 2.8.0) + jekyll-seo-tag (= 2.7.1) jekyll-sitemap (= 1.4.0) jekyll-swiss (= 1.0.0) - jekyll-theme-architect (= 0.2.0) - jekyll-theme-cayman (= 0.2.0) - jekyll-theme-dinky (= 0.2.0) - jekyll-theme-hacker (= 0.2.0) - jekyll-theme-leap-day (= 0.2.0) - jekyll-theme-merlot (= 0.2.0) - jekyll-theme-midnight (= 0.2.0) - jekyll-theme-minimal (= 0.2.0) - jekyll-theme-modernist (= 0.2.0) - jekyll-theme-primer (= 0.6.0) - jekyll-theme-slate (= 0.2.0) - jekyll-theme-tactile (= 0.2.0) - jekyll-theme-time-machine (= 0.2.0) + jekyll-theme-architect (= 0.1.1) + jekyll-theme-cayman (= 0.1.1) + jekyll-theme-dinky (= 0.1.1) + jekyll-theme-hacker (= 0.1.2) + jekyll-theme-leap-day (= 0.1.1) + jekyll-theme-merlot (= 0.1.1) + jekyll-theme-midnight (= 0.1.1) + jekyll-theme-minimal (= 0.1.1) + jekyll-theme-modernist (= 0.1.1) + jekyll-theme-primer (= 0.5.4) + jekyll-theme-slate (= 0.1.1) + jekyll-theme-tactile (= 0.1.1) + jekyll-theme-time-machine (= 0.1.1) jekyll-titles-from-headings (= 0.5.3) jemoji (= 0.12.0) - kramdown (= 2.3.2) + kramdown (= 2.3.1) kramdown-parser-gfm (= 1.1.0) - liquid (= 4.0.4) + liquid (= 4.0.3) mercenary (~> 0.3) minima (= 2.5.1) - nokogiri (>= 1.13.6, < 2.0) + nokogiri (>= 1.10.4, < 2.0) rouge (= 3.26.0) terminal-table (~> 1.4) - github-pages-health-check (1.17.9) + github-pages-health-check (1.17.2) addressable (~> 2.3) dnsruby (~> 1.60) octokit (~> 4.0) - public_suffix (>= 3.0, < 5.0) + public_suffix (>= 2.0.2, < 5.0) typhoeus (~> 1.3) - html-pipeline (2.14.3) + html-pipeline (2.14.0) activesupport (>= 2) nokogiri (>= 1.4) - http_parser.rb (0.8.0) - i18n (1.14.1) + http_parser.rb (0.6.0) + i18n (0.9.5) concurrent-ruby (~> 1.0) - jekyll (3.9.3) + jekyll (3.9.0) addressable (~> 2.4) colorator (~> 1.0) em-websocket (~> 0.5) - i18n (>= 0.7, < 2) + i18n (~> 0.7) jekyll-sass-converter (~> 1.0) jekyll-watch (~> 2.0) kramdown (>= 1.17, < 3) @@ -106,13 +116,13 @@ GEM jekyll-coffeescript (1.1.1) coffee-script (~> 2.2) coffee-script-source (~> 1.11.1) - jekyll-commonmark (1.4.0) - commonmarker (~> 0.22) - jekyll-commonmark-ghpages (0.4.0) - commonmarker (~> 0.23.7) - jekyll (~> 3.9.0) - jekyll-commonmark (~> 1.4.0) - rouge (>= 2.0, < 5.0) + jekyll-commonmark (1.3.1) + commonmarker (~> 0.14) + jekyll (>= 3.7, < 5.0) + jekyll-commonmark-ghpages (0.1.6) + commonmarker (~> 0.17.6) + jekyll-commonmark (~> 1.2) + rouge (>= 2.0, < 4.0) jekyll-default-layout (0.1.4) jekyll (~> 3.0) jekyll-feed (0.15.1) @@ -122,8 +132,6 @@ GEM jekyll-github-metadata (2.13.0) jekyll (>= 3.4, < 5.0) octokit (~> 4.0, != 4.4.0) - jekyll-include-cache (0.2.1) - jekyll (>= 3.7, < 5.0) jekyll-mentions (1.6.0) html-pipeline (~> 2.3) jekyll (>= 3.7, < 5.0) @@ -143,50 +151,50 @@ GEM rubyzip (>= 1.3.0, < 3.0) jekyll-sass-converter (1.5.2) sass (~> 3.4) - jekyll-seo-tag (2.8.0) + jekyll-seo-tag (2.7.1) jekyll (>= 3.8, < 5.0) jekyll-sitemap (1.4.0) jekyll (>= 3.7, < 5.0) jekyll-swiss (1.0.0) - jekyll-theme-architect (0.2.0) - jekyll (> 3.5, < 5.0) + jekyll-theme-architect (0.1.1) + jekyll (~> 3.5) jekyll-seo-tag (~> 2.0) - jekyll-theme-cayman (0.2.0) - jekyll (> 3.5, < 5.0) + jekyll-theme-cayman (0.1.1) + jekyll (~> 3.5) jekyll-seo-tag (~> 2.0) - jekyll-theme-dinky (0.2.0) - jekyll (> 3.5, < 5.0) + jekyll-theme-dinky (0.1.1) + jekyll (~> 3.5) jekyll-seo-tag (~> 2.0) - jekyll-theme-hacker (0.2.0) + jekyll-theme-hacker (0.1.2) jekyll (> 3.5, < 5.0) jekyll-seo-tag (~> 2.0) - jekyll-theme-leap-day (0.2.0) - jekyll (> 3.5, < 5.0) + jekyll-theme-leap-day (0.1.1) + jekyll (~> 3.5) jekyll-seo-tag (~> 2.0) - jekyll-theme-merlot (0.2.0) - jekyll (> 3.5, < 5.0) + jekyll-theme-merlot (0.1.1) + jekyll (~> 3.5) jekyll-seo-tag (~> 2.0) - jekyll-theme-midnight (0.2.0) - jekyll (> 3.5, < 5.0) + jekyll-theme-midnight (0.1.1) + jekyll (~> 3.5) jekyll-seo-tag (~> 2.0) - jekyll-theme-minimal (0.2.0) - jekyll (> 3.5, < 5.0) + jekyll-theme-minimal (0.1.1) + jekyll (~> 3.5) jekyll-seo-tag (~> 2.0) - jekyll-theme-modernist (0.2.0) - jekyll (> 3.5, < 5.0) + jekyll-theme-modernist (0.1.1) + jekyll (~> 3.5) jekyll-seo-tag (~> 2.0) - jekyll-theme-primer (0.6.0) + jekyll-theme-primer (0.5.4) jekyll (> 3.5, < 5.0) jekyll-github-metadata (~> 2.9) jekyll-seo-tag (~> 2.0) - jekyll-theme-slate (0.2.0) - jekyll (> 3.5, < 5.0) + jekyll-theme-slate (0.1.1) + jekyll (~> 3.5) jekyll-seo-tag (~> 2.0) - jekyll-theme-tactile (0.2.0) - jekyll (> 3.5, < 5.0) + jekyll-theme-tactile (0.1.1) + jekyll (~> 3.5) jekyll-seo-tag (~> 2.0) - jekyll-theme-time-machine (0.2.0) - jekyll (> 3.5, < 5.0) + jekyll-theme-time-machine (0.1.1) + jekyll (~> 3.5) jekyll-seo-tag (~> 2.0) jekyll-titles-from-headings (0.5.3) jekyll (>= 3.3, < 5.0) @@ -196,69 +204,70 @@ GEM gemoji (~> 3.0) html-pipeline (~> 2.2) jekyll (>= 3.0, < 5.0) - kramdown (2.3.2) + kramdown (2.3.1) rexml kramdown-parser-gfm (1.1.0) kramdown (~> 2.0) - liquid (4.0.4) - listen (3.8.0) + liquid (4.0.3) + listen (3.5.1) rb-fsevent (~> 0.10, >= 0.10.3) rb-inotify (~> 0.9, >= 0.9.10) mercenary (0.3.6) + mini_portile2 (2.8.0) minima (2.5.1) jekyll (>= 3.5, < 5.0) jekyll-feed (~> 0.9) jekyll-seo-tag (~> 2.1) - minitest (5.18.1) - nokogiri (1.15.3-x86_64-linux) + minitest (5.17.0) + multipart-post (2.1.1) + nokogiri (1.13.9) + mini_portile2 (~> 2.8.0) racc (~> 1.4) - octokit (4.25.1) - faraday (>= 1, < 3) - sawyer (~> 0.9) + octokit (4.21.0) + faraday (>= 0.9) + sawyer (~> 0.8.0, >= 0.5.3) pathutil (0.16.2) forwardable-extended (~> 2.6) - public_suffix (4.0.7) - racc (1.7.1) - rb-fsevent (0.11.2) + public_suffix (4.0.6) + racc (1.6.0) + rb-fsevent (0.11.0) rb-inotify (0.10.1) ffi (~> 1.0) rexml (3.2.5) rouge (3.26.0) - ruby2_keywords (0.0.5) - rubyzip (2.3.2) + ruby-enum (0.9.0) + i18n + ruby2_keywords (0.0.4) + rubyzip (2.3.0) safe_yaml (1.0.5) sass (3.7.4) sass-listen (~> 4.0.0) sass-listen (4.0.0) rb-fsevent (~> 0.9, >= 0.9.4) rb-inotify (~> 0.9, >= 0.9.7) - sawyer (0.9.2) + sawyer (0.8.2) addressable (>= 2.3.5) - faraday (>= 0.17.3, < 3) + faraday (> 0.8, < 2.0) simpleidn (0.2.1) unf (~> 0.1.4) terminal-table (1.8.0) unicode-display_width (~> 1.1, >= 1.1.1) + thread_safe (0.3.6) typhoeus (1.4.0) ethon (>= 0.9.0) - tzinfo (2.0.6) - concurrent-ruby (~> 1.0) + tzinfo (1.2.11) + thread_safe (~> 0.1) unf (0.1.4) unf_ext - unf_ext (0.0.8.2) - unicode-display_width (1.8.0) + unf_ext (0.0.7.7) + unicode-display_width (1.7.0) + zeitwerk (2.6.6) PLATFORMS - x86_64-linux + ruby DEPENDENCIES - github-pages (~> 228) - http_parser.rb (~> 0.6.0) - jekyll-feed (~> 0.12) - minima (~> 2.5) - tzinfo (>= 1, < 3) - tzinfo-data - wdm (~> 0.1.1) + github-pages BUNDLED WITH - 2.2.3 + 2.1.4 diff --git a/docs/LICENSE b/docs/LICENSE new file mode 100644 index 00000000..573599c4 --- /dev/null +++ b/docs/LICENSE @@ -0,0 +1,13 @@ +Copyright 2021 Google LLC + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + https://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/docs/LICENSE-BSD-NAVGOCO.txt b/docs/LICENSE-BSD-NAVGOCO.txt new file mode 100644 index 00000000..7fdefc39 --- /dev/null +++ b/docs/LICENSE-BSD-NAVGOCO.txt @@ -0,0 +1,27 @@ +/* This license pertains to the Navgoco jQuery component used for the sidebar. */ + +Copyright (c) 2013, Christodoulos Tsoulloftas, http://www.komposta.net +All rights reserved. + +Redistribution and use in source and binary forms, with or without modification, +are permitted provided that the following conditions are met: + + * Redistributions of source code must retain the above copyright notice, + this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + * Neither the name of the nor the names of its + contributors may be used to endorse or promote products derived from this + software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND + ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, +INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF +LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE +OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED +OF THE POSSIBILITY OF SUCH DAMAGE. \ No newline at end of file diff --git a/docs/_config.yml b/docs/_config.yml index bd5c0e6d..25e1b230 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -1,55 +1,120 @@ -# Welcome to Jekyll! -# -# This config file is meant for settings that affect your whole blog, values -# which you are expected to set up once and rarely edit after that. If you find -# yourself editing this file very often, consider using Jekyll's data files -# feature for the data you need to update frequently. -# -# For technical reasons, this file is *NOT* reloaded automatically when you use -# 'bundle exec jekyll serve'. If you change this file, please restart the server process. -# -# If you need help with YAML syntax, here are some quick references for you: -# https://learn-the-web.algonquindesign.ca/topics/markdown-yaml-cheat-sheet/#yaml -# https://learnxinyminutes.com/docs/yaml/ -# -# Site settings -# These are used to personalize your new site. If you look in the HTML files, -# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on. -# You can create any custom variable you would like, and they will be accessible -# in the templates via {{ site.myvariable }}. - -title: AnsibleForms Help Documentation -email: info@ansibleforms.com -description: >- # this means to ignore newlines until "baseurl:" - Write an awesome description for your new site here. You can edit this - line in _config.yml. It will appear in your document head meta (for - Google search results) and in your feed.xml site description. -baseurl: "/ansibleforms" # the subpath of your site, e.g. /blog -url: "https://ansibleguy76.github.io" # the base hostname & protocol for your site, e.g. http://example.com -#twitter_username: jekyllrb -github_username: ansibleguy76 - -# Build settings -theme: minima -plugins: - - jekyll-feed - -# Exclude from processing. -# The following items will not be processed, by default. -# Any item listed under the `exclude:` key here will be automatically added to -# the internal "default list". -# -# Excluded items can be processed by explicitly listing the directories or -# their entries' file path in the `include:` list. -# -# exclude: -# - .sass-cache/ -# - .jekyll-cache/ -# - gemfiles/ -# - Gemfile -# - Gemfile.lock -# - node_modules/ -# - vendor/bundle/ -# - vendor/cache/ -# - vendor/gems/ -# - vendor/ruby/ +repository: tomjoht/documentation-theme-jekyll + +output: web +# this property is useful for conditional filtering of content that is separate from the PDF. + +topnav_title: Jekyll Documentation Theme +# this appears on the top navigation bar next to the home button + +site_title: Jekyll theme for documentation +# this appears in the html browser tab for the site title (seen mostly by search engines, not users) + +company_name: Copyright 2021 Google LLC +# this appears in the footer + +github_editme_path: tomjoht/documentation-theme-jekyll/blob/gh-pages/ +# if you're using Github, provide the basepath to the branch you've created for reviews, following the sample here. if not, leave this value blank. + +# gitlab_editme_path: tomjoht/documentation-theme-jekyll/blob/gh-pages/ +# if you're using GitLab, provide the basepath to the branch you've created for reviews, following the sample here. if not, leave this value blank. + +google_analytics: UA-66296557-1 +# if you have google-analytics ID, put it in. if not, edit this value to blank. + +host: 127.0.0.1 +# the preview server used. Leave as is. + +port: 4000 +# the port where the preview is rendered. You can leave this as is unless you have other Jekyll builds using this same port that might cause conflicts. in that case, use another port such as 4006. + +exclude: + - .idea/ + - .gitignore + - vendor +# these are the files and directories that jekyll will exclude from the build + +feedback_subject_line: Jekyll documentation theme + +feedback_email: tomjoht@gmail.com +# used as a contact email for the Feedback link in the top navigation bar + +# feedback_disable: true +# if you uncomment the previous line, the Feedback link gets removed + +# feedback_text: "Need help?" +# if you uncomment the previous line, it changes the Feedback text + +# feedback_link: "http://helpy.io/" +# if you uncomment the previous line, it changes where the feedback link points to + +highlighter: rouge +# library used for syntax highlighting + +markdown: kramdown +kramdown: + input: GFM + auto_ids: true + hard_wrap: false + syntax_highlighter: rouge + +# filter used to process markdown. note that kramdown differs from github-flavored markdown in some subtle ways + +collections: + tooltips: + output: false +# collections are declared here. this renders the content in _tooltips and processes it, but doesn't output it as actual files in the output unless you change output to true + +defaults: + - + scope: + path: "" + type: "pages" + values: + layout: "page" + comments: true + # if you don't want to use Commento.io and just hide comments, change true to false wherever you see the comments property + search: true + sidebar: home_sidebar + topnav: topnav + - + scope: + path: "" + type: "tooltips" + values: + layout: "page" + search: true + tooltip: true + + - + scope: + path: "" + type: "posts" + values: + layout: "post" + comments: true + # if you don't want to use Commento.io and just hide comments, change true to false wherever you see the comments property + search: true + sidebar: home_sidebar + topnav: topnav + +# these are defaults used for the frontmatter for these file types + +sidebars: +- home_sidebar +- mydoc_sidebar +- product1_sidebar +- product2_sidebar +- other + +description: "Intended as a documentation theme based on Jekyll for technical writers documenting software and other technical products, this theme has all the elements you would need to handle multiple products with both multi-level sidebar navigation, tags, and other documentation features." +# the description is used in the feed.xml file + +# needed for sitemap.xml file only +# url: http://idratherbewriting.com +# baseurl: /documentation-theme-jekyll + + +github: [metadata] + + +# Copyright 2021 Google LLC diff --git a/docs/_data/alerts.yml b/docs/_data/alerts.yml new file mode 100644 index 00000000..7dfa163f --- /dev/null +++ b/docs/_data/alerts.yml @@ -0,0 +1,18 @@ +tip: '