├── .circleci
    ├── circle_urls.sh
    └── config.yml
├── .github
    ├── stale.yml
    └── workflows
    │   └── main.yml
├── .gitignore
├── 404.md
├── CHANGELOG.md
├── COPYRIGHT
├── Gemfile
├── LICENSE
├── README.md
├── VERSION
├── _config.yml
├── _data
    ├── navigation.yml
    ├── quizzes
    │   └── example-quiz.yml
    ├── toc-mapping.yml
    ├── toc.yml
    └── versions
    │   └── previous-toc.yml
├── _docs
    ├── Archive
    │   └── Previous
    │   │   ├── example-page.md
    │   │   ├── extras
    │   │       ├── example-quiz.md
    │   │       └── index.md
    │   │   ├── getting-started.md
    │   │   ├── subfolder.md
    │   │   └── subfolder
    │   │       └── example-page.md
    ├── example-page.md
    ├── extras
    │   ├── example-quiz.md
    │   └── index.md
    ├── getting-started.md
    ├── subfolder.md
    ├── subfolder
    │   └── example-page.md
    └── versioning.md
├── _includes
    ├── alert.html
    ├── doc.html
    ├── editable.html
    ├── feedback.html
    ├── footer.html
    ├── google-analytics.html
    ├── head.html
    ├── header.html
    ├── logo.svg
    ├── navigation.html
    ├── permalinks.html
    ├── quiz.html
    ├── quiz
    │   └── multiple-choice.html
    ├── scripts.html
    ├── scrolltop.html
    ├── sidebar.html
    ├── tags.html
    ├── toc.html
    └── versionalert.html
├── _layouts
    ├── default.html
    ├── page.html
    └── post.html
├── _posts
    ├── 2019-06-28-hello-world.md
    └── 2019-06-29-welcome.md
├── assets
    ├── css
    │   ├── main.css
    │   └── palette.css
    ├── favicons
    │   ├── android-icon-144x144.png
    │   ├── android-icon-192x192.png
    │   ├── android-icon-36x36.png
    │   ├── android-icon-48x48.png
    │   ├── android-icon-72x72.png
    │   ├── android-icon-96x96.png
    │   ├── apple-icon-114x114.png
    │   ├── apple-icon-120x120.png
    │   ├── apple-icon-144x144.png
    │   ├── apple-icon-152x152.png
    │   ├── apple-icon-180x180.png
    │   ├── apple-icon-57x57.png
    │   ├── apple-icon-60x60.png
    │   ├── apple-icon-72x72.png
    │   ├── apple-icon-76x76.png
    │   ├── apple-icon-precomposed.png
    │   ├── apple-icon.png
    │   ├── browserconfig.xml
    │   ├── favicon-16x16.png
    │   ├── favicon-32x32.png
    │   ├── favicon-96x96.png
    │   ├── favicon.ico
    │   ├── manifest.json
    │   ├── ms-icon-144x144.png
    │   ├── ms-icon-150x150.png
    │   ├── ms-icon-310x310.png
    │   └── ms-icon-70x70.png
    ├── img
    │   ├── docker-clear.png
    │   ├── docker.png
    │   ├── docsy-jekyll-preview.png
    │   ├── docsy-jekyll-version-search.png
    │   ├── docsy-jekyll.png
    │   ├── favicon.png
    │   ├── logo.png
    │   ├── open-source-halloween-2021.png
    │   ├── versionalertbeta.png
    │   ├── versionalertmain.png
    │   └── versionalertoutdated.png
    ├── js
    │   ├── jquery-3.3.1
    │   │   ├── jquery-3.3.1.js
    │   │   └── jquery-3.3.1.min.js
    │   ├── lunr.min.js
    │   ├── main.js
    │   └── search.js
    └── webfonts
    │   ├── fa-brands-400.eot
    │   ├── fa-brands-400.svg
    │   ├── fa-brands-400.ttf
    │   ├── fa-brands-400.woff
    │   ├── fa-brands-400.woff2
    │   ├── fa-regular-400.eot
    │   ├── fa-regular-400.svg
    │   ├── fa-regular-400.ttf
    │   ├── fa-regular-400.woff
    │   ├── fa-regular-400.woff2
    │   ├── fa-solid-900.eot
    │   ├── fa-solid-900.svg
    │   ├── fa-solid-900.ttf
    │   ├── fa-solid-900.woff
    │   └── fa-solid-900.woff2
├── docker-compose.yaml
└── pages
    ├── about.md
    ├── archive.md
    ├── docs.md
    ├── feed.xml
    ├── index.md
    ├── news.md
    ├── search.html
    ├── sitemap.xml
    └── tags.html


/.circleci/circle_urls.sh:
--------------------------------------------------------------------------------
1 | REPO_ID=$(curl https://api.github.com/repos/${CIRCLE_PROJECT_USERNAME}/${CIRCLE_PROJECT_REPONAME} | jq --raw-output '.id')
2 | echo "Repo ID is ${REPO_ID}"
3 | BASEURL=https://${CIRCLE_BUILD_NUM}-${REPO_ID}-gh.circle-artifacts.com/0/${CIRCLE_PROJECT_REPONAME}
4 | sed -i "26 s,.*,baseurl: $BASEURL,g" "_config.yml"
5 | 


--------------------------------------------------------------------------------
/.circleci/config.yml:
--------------------------------------------------------------------------------
 1 | version: 2.1
 2 | 
 3 | workflows:
 4 |   version: 2
 5 | 
 6 |   # The build workflow will build a preview for the site, intended for PRs
 7 |   build:
 8 |     jobs:
 9 |       - build-site:
10 |           filters:
11 |             branches:
12 |               ignore: master
13 | 
14 | build_jekyll: &build_jekyll
15 |     name: Jekyll Build
16 |     command: |
17 |         echo "Building RSE Blog for Preview"
18 |         cp ~/repo/.circleci/circle_urls.sh ~/repo/circle_urls.sh
19 |         cd ~/repo
20 |         chmod u+x circle_urls.sh
21 |         bash circle_urls.sh              
22 |         bundle exec jekyll build
23 |         
24 | jobs:
25 |   build-site:
26 |     docker:
27 |       - image: circleci/ruby:2.4.1
28 |     working_directory: ~/repo
29 |     environment:
30 |       - JEKYLL_ENV: production
31 |       - NOKOGIRI_USE_SYSTEM_LIBRARIES: true
32 |       - BUNDLE_PATH: ~/repo/vendor/bundle
33 |     steps:
34 |       - checkout
35 |       - restore_cache:
36 |           keys:
37 |           - rubygems-v1
38 |       - run:
39 |           name: Bundle Install
40 |           command: |
41 |               cd ~/repo
42 |               bundle check || bundle install
43 |       - save_cache:
44 |           key: rubygems-v1
45 |           paths:
46 |             - vendor/bundle
47 |       - run: *build_jekyll
48 |       - store_artifacts:
49 |           path: ~/repo/_site
50 |           destination: docsy-jekyll
51 | 


--------------------------------------------------------------------------------
/.github/stale.yml:
--------------------------------------------------------------------------------
 1 | # Number of days of inactivity before an issue becomes stale
 2 | daysUntilStale: 60
 3 | # Number of days of inactivity before a stale issue is closed
 4 | daysUntilClose: 7
 5 | # Issues with these labels will never be considered stale
 6 | exemptLabels:
 7 |   - pinned
 8 |   - security
 9 | # Label to use when marking an issue as stale
10 | staleLabel: wontfix
11 | # Comment to post when marking an issue as stale. Set to `false` to disable
12 | markComment: >
13 |   This issue has been automatically marked as stale because it has not had
14 |   recent activity. It will be closed if no further activity occurs. Thank you
15 |   for your contributions.
16 | # Comment to post when closing a stale issue. Set to `false` to disable
17 | closeComment: false
18 | 


--------------------------------------------------------------------------------
/.github/workflows/main.yml:
--------------------------------------------------------------------------------
 1 | name: check-spelling
 2 | 
 3 | on:
 4 |   push:
 5 |     branches: [master]
 6 |   pull_request: []
 7 | 
 8 | jobs:
 9 |   formatting:
10 |     runs-on: ubuntu-latest
11 |     steps:
12 |       - uses: actions/checkout@v3
13 |       - name: Check for typos
14 |         uses: crate-ci/typos@592b36d23c62cb378f6097a292bc902ee73f93ef # version 1.0.4
15 |         with: 
16 |           files: ./README.md ./_docs ./pages ./_posts
17 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | vendor
2 | _site
3 | Gemfile.lock
4 | 


--------------------------------------------------------------------------------
/404.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | # example 404.md
 3 | 
 4 | layout: default
 5 | permalink: /404.html
 6 | ---
 7 | 
 8 | # Page Not Found
 9 | 
10 | Unfortunately we were unable to find the page you requested. It could be the page doesn't exist or only exists for a specific version of these documents so please use the search feature to see if you are able to locate the information you were after.


--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
 1 | # Changelog
 2 | 
 3 | This is a manually generated log to track changes to the repository for each release. 
 4 | Each section should include general headers such as **Implemented enhancements** 
 5 | and **Merged pull requests**. All closed issued and bug fixes should be 
 6 | represented by the pull requests that fixed them.
 7 | Critical items to know are:
 8 | 
 9 |  - renamed commands
10 |  - deprecated / removed commands
11 |  - changed defaults
12 |  - backward incompatible changes
13 |  - migration guidance
14 |  - changed behaviour
15 | 
16 | ## [master](https://github.com/vsoch/docsy-jekyll/tree/master)
17 |  - bug that site tags and docs tags concating together without a comma (0.0.27)
18 |  - added Windows hash for assets (0.0.26)
19 |  - adding support for documentation versioning (0.0.25)
20 |  - adding more verbose example for subfolders (0.0.24)
21 |  - sidebar fix to support multiple top level menus (0.0.23)
22 |  - added support for github_branch (default 'master') in config (0.0.22)
23 |  - adding support in footer to icon and link to linkedin url (0.0.21)
24 |  - updating repository with copyright notice, google analytics bug fix (0.0.2)
25 |  - fixing link to repository in about.md (0.0.19)
26 |  - use jquery locally, in case that jquery is unreachable in some places (0.0.18)
27 |  - hiding sidebar links to reflect parent functionality (0.0.17)
28 |  - adding breadcrumb link to documentation root (0.0.16)
29 |  - bug with link in top breadcrumb (404) missing baseurl (0.0.15)
30 |  - bug that news items (posts) don't render in search (0.0.14)
31 |  - minimum width of 150px for top right site name (0.0.13)
32 |  - tags page and option to link to it from post/docs tags (0.0.12)
33 |  - adding search endpoint tags to docs (0.0.11)
34 |  - adding site.url to config, making links in readme absolute (0.0.1)
35 |  - start of theme  (0.0.0)
36 | 


--------------------------------------------------------------------------------
/COPYRIGHT:
--------------------------------------------------------------------------------
 1 | Copyright 2019-2021 Vanessa Sochat
 2 | 
 3 | Licensed under the Apache License, Version 2.0 (the "License");
 4 | you may not use this file except in compliance with the License.
 5 | You may obtain a copy of the License at
 6 | 
 7 |     http://www.apache.org/licenses/LICENSE-2.0
 8 | 
 9 | Unless required by applicable law or agreed to in writing, software
10 | distributed under the License is distributed on an "AS IS" BASIS,
11 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | See the License for the specific language governing permissions and
13 | limitations under the License.
14 | 


--------------------------------------------------------------------------------
/Gemfile:
--------------------------------------------------------------------------------
 1 | source "https://rubygems.org"
 2 | ruby RUBY_VERSION
 3 | 
 4 | # Hello! This is where you manage which Jekyll version is used to run.
 5 | # When you want to use a different version, change it below, save the
 6 | # file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
 7 | #
 8 | #     bundle exec jekyll serve
 9 | #
10 | # This will help ensure the proper Jekyll version is running.
11 | # Happy Jekylling!
12 | # gem "jekyll", "3.2.1"
13 | 
14 | # This is the default theme for new Jekyll sites. You may change this to anything you like.
15 | # gem "minima"
16 | 
17 | # If you want to use GitHub Pages, remove the "gem "jekyll"" above and
18 | # uncomment the line below. To upgrade, run `bundle update github-pages`.
19 | gem "github-pages", group: :jekyll_plugins
20 | 
21 | # If you have any plugins, put them here!
22 | # group :jekyll_plugins do
23 | #   gem "jekyll-github-metadata", "~> 1.0"
24 | # end
25 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 |                                  Apache License
  2 |                            Version 2.0, January 2004
  3 |                         http://www.apache.org/licenses/
  4 | 
  5 |    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
  6 | 
  7 |    1. Definitions.
  8 | 
  9 |       "License" shall mean the terms and conditions for use, reproduction,
 10 |       and distribution as defined by Sections 1 through 9 of this document.
 11 | 
 12 |       "Licensor" shall mean the copyright owner or entity authorized by
 13 |       the copyright owner that is granting the License.
 14 | 
 15 |       "Legal Entity" shall mean the union of the acting entity and all
 16 |       other entities that control, are controlled by, or are under common
 17 |       control with that entity. For the purposes of this definition,
 18 |       "control" means (i) the power, direct or indirect, to cause the
 19 |       direction or management of such entity, whether by contract or
 20 |       otherwise, or (ii) ownership of fifty percent (50%) or more of the
 21 |       outstanding shares, or (iii) beneficial ownership of such entity.
 22 | 
 23 |       "You" (or "Your") shall mean an individual or Legal Entity
 24 |       exercising permissions granted by this License.
 25 | 
 26 |       "Source" form shall mean the preferred form for making modifications,
 27 |       including but not limited to software source code, documentation
 28 |       source, and configuration files.
 29 | 
 30 |       "Object" form shall mean any form resulting from mechanical
 31 |       transformation or translation of a Source form, including but
 32 |       not limited to compiled object code, generated documentation,
 33 |       and conversions to other media types.
 34 | 
 35 |       "Work" shall mean the work of authorship, whether in Source or
 36 |       Object form, made available under the License, as indicated by a
 37 |       copyright notice that is included in or attached to the work
 38 |       (an example is provided in the Appendix below).
 39 | 
 40 |       "Derivative Works" shall mean any work, whether in Source or Object
 41 |       form, that is based on (or derived from) the Work and for which the
 42 |       editorial revisions, annotations, elaborations, or other modifications
 43 |       represent, as a whole, an original work of authorship. For the purposes
 44 |       of this License, Derivative Works shall not include works that remain
 45 |       separable from, or merely link (or bind by name) to the interfaces of,
 46 |       the Work and Derivative Works thereof.
 47 | 
 48 |       "Contribution" shall mean any work of authorship, including
 49 |       the original version of the Work and any modifications or additions
 50 |       to that Work or Derivative Works thereof, that is intentionally
 51 |       submitted to Licensor for inclusion in the Work by the copyright owner
 52 |       or by an individual or Legal Entity authorized to submit on behalf of
 53 |       the copyright owner. For the purposes of this definition, "submitted"
 54 |       means any form of electronic, verbal, or written communication sent
 55 |       to the Licensor or its representatives, including but not limited to
 56 |       communication on electronic mailing lists, source code control systems,
 57 |       and issue tracking systems that are managed by, or on behalf of, the
 58 |       Licensor for the purpose of discussing and improving the Work, but
 59 |       excluding communication that is conspicuously marked or otherwise
 60 |       designated in writing by the copyright owner as "Not a Contribution."
 61 | 
 62 |       "Contributor" shall mean Licensor and any individual or Legal Entity
 63 |       on behalf of whom a Contribution has been received by Licensor and
 64 |       subsequently incorporated within the Work.
 65 | 
 66 |    2. Grant of Copyright License. Subject to the terms and conditions of
 67 |       this License, each Contributor hereby grants to You a perpetual,
 68 |       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 69 |       copyright license to reproduce, prepare Derivative Works of,
 70 |       publicly display, publicly perform, sublicense, and distribute the
 71 |       Work and such Derivative Works in Source or Object form.
 72 | 
 73 |    3. Grant of Patent License. Subject to the terms and conditions of
 74 |       this License, each Contributor hereby grants to You a perpetual,
 75 |       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 76 |       (except as stated in this section) patent license to make, have made,
 77 |       use, offer to sell, sell, import, and otherwise transfer the Work,
 78 |       where such license applies only to those patent claims licensable
 79 |       by such Contributor that are necessarily infringed by their
 80 |       Contribution(s) alone or by combination of their Contribution(s)
 81 |       with the Work to which such Contribution(s) was submitted. If You
 82 |       institute patent litigation against any entity (including a
 83 |       cross-claim or counterclaim in a lawsuit) alleging that the Work
 84 |       or a Contribution incorporated within the Work constitutes direct
 85 |       or contributory patent infringement, then any patent licenses
 86 |       granted to You under this License for that Work shall terminate
 87 |       as of the date such litigation is filed.
 88 | 
 89 |    4. Redistribution. You may reproduce and distribute copies of the
 90 |       Work or Derivative Works thereof in any medium, with or without
 91 |       modifications, and in Source or Object form, provided that You
 92 |       meet the following conditions:
 93 | 
 94 |       (a) You must give any other recipients of the Work or
 95 |           Derivative Works a copy of this License; and
 96 | 
 97 |       (b) You must cause any modified files to carry prominent notices
 98 |           stating that You changed the files; and
 99 | 
100 |       (c) You must retain, in the Source form of any Derivative Works
101 |           that You distribute, all copyright, patent, trademark, and
102 |           attribution notices from the Source form of the Work,
103 |           excluding those notices that do not pertain to any part of
104 |           the Derivative Works; and
105 | 
106 |       (d) If the Work includes a "NOTICE" text file as part of its
107 |           distribution, then any Derivative Works that You distribute must
108 |           include a readable copy of the attribution notices contained
109 |           within such NOTICE file, excluding those notices that do not
110 |           pertain to any part of the Derivative Works, in at least one
111 |           of the following places: within a NOTICE text file distributed
112 |           as part of the Derivative Works; within the Source form or
113 |           documentation, if provided along with the Derivative Works; or,
114 |           within a display generated by the Derivative Works, if and
115 |           wherever such third-party notices normally appear. The contents
116 |           of the NOTICE file are for informational purposes only and
117 |           do not modify the License. You may add Your own attribution
118 |           notices within Derivative Works that You distribute, alongside
119 |           or as an addendum to the NOTICE text from the Work, provided
120 |           that such additional attribution notices cannot be construed
121 |           as modifying the License.
122 | 
123 |       You may add Your own copyright statement to Your modifications and
124 |       may provide additional or different license terms and conditions
125 |       for use, reproduction, or distribution of Your modifications, or
126 |       for any such Derivative Works as a whole, provided Your use,
127 |       reproduction, and distribution of the Work otherwise complies with
128 |       the conditions stated in this License.
129 | 
130 |    5. Submission of Contributions. Unless You explicitly state otherwise,
131 |       any Contribution intentionally submitted for inclusion in the Work
132 |       by You to the Licensor shall be under the terms and conditions of
133 |       this License, without any additional terms or conditions.
134 |       Notwithstanding the above, nothing herein shall supersede or modify
135 |       the terms of any separate license agreement you may have executed
136 |       with Licensor regarding such Contributions.
137 | 
138 |    6. Trademarks. This License does not grant permission to use the trade
139 |       names, trademarks, service marks, or product names of the Licensor,
140 |       except as required for reasonable and customary use in describing the
141 |       origin of the Work and reproducing the content of the NOTICE file.
142 | 
143 |    7. Disclaimer of Warranty. Unless required by applicable law or
144 |       agreed to in writing, Licensor provides the Work (and each
145 |       Contributor provides its Contributions) on an "AS IS" BASIS,
146 |       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 |       implied, including, without limitation, any warranties or conditions
148 |       of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 |       PARTICULAR PURPOSE. You are solely responsible for determining the
150 |       appropriateness of using or redistributing the Work and assume any
151 |       risks associated with Your exercise of permissions under this License.
152 | 
153 |    8. Limitation of Liability. In no event and under no legal theory,
154 |       whether in tort (including negligence), contract, or otherwise,
155 |       unless required by applicable law (such as deliberate and grossly
156 |       negligent acts) or agreed to in writing, shall any Contributor be
157 |       liable to You for damages, including any direct, indirect, special,
158 |       incidental, or consequential damages of any character arising as a
159 |       result of this License or out of the use or inability to use the
160 |       Work (including but not limited to damages for loss of goodwill,
161 |       work stoppage, computer failure or malfunction, or any and all
162 |       other commercial damages or losses), even if such Contributor
163 |       has been advised of the possibility of such damages.
164 | 
165 |    9. Accepting Warranty or Additional Liability. While redistributing
166 |       the Work or Derivative Works thereof, You may choose to offer,
167 |       and charge a fee for, acceptance of support, warranty, indemnity,
168 |       or other liability obligations and/or rights consistent with this
169 |       License. However, in accepting such obligations, You may act only
170 |       on Your own behalf and on Your sole responsibility, not on behalf
171 |       of any other Contributor, and only if You agree to indemnify,
172 |       defend, and hold each Contributor harmless for any liability
173 |       incurred by, or claims asserted against, such Contributor by reason
174 |       of your accepting any such warranty or additional liability.
175 | 
176 |    END OF TERMS AND CONDITIONS
177 | 
178 |    APPENDIX: How to apply the Apache License to your work.
179 | 
180 |       To apply the Apache License to your work, attach the following
181 |       boilerplate notice, with the fields enclosed by brackets "[]"
182 |       replaced with your own identifying information. (Don't include
183 |       the brackets!)  The text should be enclosed in the appropriate
184 |       comment syntax for the file format. We also recommend that a
185 |       file or class name and description of purpose be included on the
186 |       same "printed page" as the copyright notice for easier
187 |       identification within third-party archives.
188 | 
189 |    Copyright [yyyy] [name of copyright owner]
190 | 
191 |    Licensed under the Apache License, Version 2.0 (the "License");
192 |    you may not use this file except in compliance with the License.
193 |    You may obtain a copy of the License at
194 | 
195 |        http://www.apache.org/licenses/LICENSE-2.0
196 | 
197 |    Unless required by applicable law or agreed to in writing, software
198 |    distributed under the License is distributed on an "AS IS" BASIS,
199 |    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 |    See the License for the specific language governing permissions and
201 |    limitations under the License.
202 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | # Docsy Jekyll Theme
  2 | 
  3 | [![CircleCI](https://circleci.com/gh/vsoch/docsy-jekyll/tree/master.svg?style=svg)](https://circleci.com/gh/vsoch/docsy-jekyll/tree/master)
  4 | <a href="https://jekyll-themes.com/docsy-jekyll/">
  5 |     <img src="https://img.shields.io/badge/featured%20on-JT-red.svg" height="20" alt="Jekyll Themes Shield" >
  6 | </a>
  7 | 
  8 | ![https://raw.githubusercontent.com/vsoch/docsy-jekyll/master/assets/img/docsy-jekyll.png](https://raw.githubusercontent.com/vsoch/docsy-jekyll/master/assets/img/docsy-jekyll.png)
  9 | 
 10 | This is a [starter template](https://vsoch.github.com/docsy-jekyll/) for a Docsy jekyll theme, based
 11 | on the Beautiful [Docsy](https://github.com/google/docsy) that renders with Hugo. This version is intended for
 12 | native deployment on GitHub pages. The original [Apache License](https://github.com/vsoch/docsy-jekyll/blob/master/LICENSE) is included.
 13 | 
 14 | ## Changes
 15 | 
 16 | The site is intended for purely documentation, so while the front page banner
 17 | is useful for business or similar, this author (@vsoch) preferred to have
 18 | the main site page go directly to the Documentation view. Posts
 19 | are still provided via a feed.
 20 | 
 21 | ## Usage
 22 | 
 23 | ### 1. Get the code
 24 | 
 25 | You can clone the repository right to where you want to host the docs:
 26 | 
 27 | ```bash
 28 | git clone https://github.com/vsoch/docsy-jekyll.git docs
 29 | cd docs
 30 | ```
 31 | 
 32 | ### 2. Customize
 33 | 
 34 | To edit configuration values, customize the [_config.yml](https://github.com/vsoch/docsy-jekyll/blob/master/_config.yml).
 35 | To add pages, write them into the [pages](https://github.com/vsoch/docsy-jekyll/blob/master/pages) folder. 
 36 | You define urls based on the `permalink` attribute in your pages,
 37 | and then add them to the navigation by adding to the content of [_data/toc.myl](https://github.com/vsoch/docsy-jekyll/blob/master/_data/toc.yml).
 38 | The top navigation is controlled by [_data/navigation.yml](https://github.com/vsoch/docsy-jekyll/blob/master/_data/navigation.yml)
 39 | 
 40 | ### 3. Options
 41 | 
 42 | Most of the configuration values in the [_config.yml](https://github.com/vsoch/docsy-jekyll/blob/master/_config.yml) are self explanatory,
 43 | and for more details, see the [getting started page](https://vsoch.github.io/docsy-jekyll/docs/getting-started)
 44 | rendered on the site.
 45 | 
 46 | ### 4. Serve
 47 | 
 48 | Depending on how you installed jekyll:
 49 | 
 50 | ```bash
 51 | jekyll serve
 52 | # or
 53 | bundle exec jekyll serve
 54 | ```
 55 | 
 56 | **NOTE:** If the above serve command throws an error saying `require': cannot load such file -- webrick (LoadError)` try to run `bundle add webrick` to automatically add the webrick gem to your Gemfile, or manually add `gem "webrick"` line to the Gemfile and then run the serve command again.
 57 | 
 58 | 
 59 | ### 5. Run as a container in dev or prod
 60 | 
 61 | #### Software Dependencies
 62 | 
 63 | If you want to run docsy jekyll via a container for development (dev) or production (prod) you can use containers. This approach requires installing [docker-ce](https://docs.docker.com/engine/install/ubuntu/) and [docker-compose](https://docs.docker.com/compose/install/). 
 64 | 
 65 | #### Customization
 66 | 
 67 | Note that the [docker-compose.yml](docker-compose.yml) file is using the [jekyll/jekyll:3.8](https://hub.docker.com/r/jekyll/jekyll/tags) image. If you want to make your build more reproducible, you can specify a particular version for jekyll (tag). Note that at the development time of writing this documentation, the latest was tag 4.0.0,
 68 | and it [had a bug](https://github.com/fastai/fastpages/issues/267#issuecomment-620612896) that prevented the server from deploying.
 69 | 
 70 | If you are deploying a container to production, you should remove the line to
 71 | mount the bundles directory to the host in the docker-compose.yml. Change:
 72 | 
 73 | ```yaml
 74 |     volumes: 
 75 |       - "./:/srv/jekyll"
 76 |       - "./vendor/bundle:/usr/local/bundle"
 77 |       # remove "./vendor/bundle:/usr/local/bundle" volume when deploying in production
 78 | ```
 79 | 
 80 | to:
 81 | 
 82 | ```yaml
 83 |     volumes: 
 84 |       - "./:/srv/jekyll"
 85 | ```
 86 | 
 87 | This additional volume is optimal for development so you can cache the bundle dependencies,
 88 | but should be removed for production. 
 89 | 
 90 | #### Start Container
 91 | 
 92 | Once your docker-compose to download the base container and bring up the server:
 93 | 
 94 | ```bash
 95 | docker-compose up -d
 96 | ```
 97 | 
 98 | You can then open your browser to [http://localhost:4000](http://localhost:4000)
 99 | to see the server running.
100 | 
101 | > Node : changes `baseurl: ""` in _config.yml  when you are running in local and prod according to the requirement.
102 | 


--------------------------------------------------------------------------------
/VERSION:
--------------------------------------------------------------------------------
1 | 0.0.27
2 | 


--------------------------------------------------------------------------------
/_config.yml:
--------------------------------------------------------------------------------
  1 | # Welcome to Jekyll!
  2 | #
  3 | # This config file is meant for settings that affect your whole blog, values
  4 | # which you are expected to set up once and rarely edit after that. If you find
  5 | # yourself editing these this file very often, consider using Jekyll's data files
  6 | # feature for the data you need to update frequently.
  7 | #
  8 | # For technical reasons, this file is *NOT* reloaded automatically when you use
  9 | # 'jekyll serve'. If you change this file, please restart the server process.
 10 | 
 11 | # Site settings
 12 | # These are used to personalize your new site. If you look in the HTML files,
 13 | # you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
 14 | # You can create any custom variable you would like, and they will be accessible
 15 | # in the templates via {{ site.myvariable }}.
 16 | 
 17 | title: Docsy Jekyll
 18 | email: your-email@domain.com
 19 | author: Dinosaur Avocado
 20 | description: > # this means to ignore newlines until "baseurl:"
 21 |   Write an awesome description for your new site here. You can edit this
 22 |   line in _config.yml. It will appear in your document head meta (for
 23 |   Google search results) and in your feed.xml site description.
 24 | 
 25 | # Add your baseurl here (your repository) but DO NOT CHANGE THE LINE NUMBER without editing .circleci/circle_urls.sh
 26 | baseurl: "/docsy-jekyll" # the subpath of your site, e.g. /blog
 27 | 
 28 | # This is mostly for testing
 29 | url: "https://vsoch.github.io" # the base hostname & protocol for your site
 30 | 
 31 | # Social (First three Required)
 32 | repo: "https://github.com/vsoch/docsy-jekyll"
 33 | github_user: "vsoch"
 34 | github_repo: "docsy-jekyll"
 35 | github_branch: "master"
 36 | 
 37 | # Optional
 38 | twitter: vsoch
 39 | linkedin: vsochat
 40 | dockerhub: vanessa
 41 | 
 42 | # These options are used to configure the locations of your version history when you want to serve versioned documents
 43 | version_params:
 44 |   version_menu: "Release"
 45 |   version_dir: Archive
 46 |   tocversion_dir: versions
 47 |   versioning: true
 48 | 
 49 |   # Disable so older versions cannot be searched
 50 |   allow_search: true  
 51 | 
 52 |   # Allow these versions to be searched
 53 |   search_versions:
 54 |     - Previous
 55 |   latest: Current
 56 |   versions:
 57 |     - Current
 58 |     - Previous
 59 | 
 60 | # Should there be feedback buttons at the bottom of pages?
 61 | feedback: true
 62 | 
 63 | # Link to a privacy policy in footer, uncomment and define if wanted
 64 | # privacy: https://domain.com/privacy
 65 | 
 66 | # google-analytics: UA-XXXXXXXXXX
 67 | # Image and (square) dimension for logo (don't start with /)
 68 | # If commented, will use material hat theme
 69 | # logo: "assets/img/logo/SRCC-square-red.png"
 70 | logo_pixels: 34
 71 | color: "#30638e"
 72 | # color: "#8c1515" # primary color for header, buttons
 73 | 
 74 | # Build settings
 75 | markdown: kramdown
 76 | 
 77 | # If you add tags to pages, define this variable to link them to some external search
 78 | # If you want to link to tags locally on the site, leave this commented out
 79 | # tag_search_endpoint: https://ask.cyberinfrastructure.org/search?q=
 80 | tag_color: primary # danger, success, warning, primary, info, secondary
 81 | 
 82 | accentColor: red # purple, green, etc.
 83 | themeColor: red # purple, green, blue, orange, purple, grey
 84 | fixedNav: 'true' # true or false
 85 | 
 86 | permalink: /:year/:title/
 87 | markdown: kramdown
 88 | exclude: [_site, CHANGELOG.md, LICENSE, README.md, vendor]
 89 | 
 90 | # Collections
 91 | collections:
 92 |   docs:
 93 |     output: true
 94 |     permalink: /:collection/:path
 95 | 
 96 | # Defaults
 97 | defaults:
 98 |   - scope:
 99 |       path: "_docs"
100 |       type: "docs"
101 |     values:
102 |       layout: page
103 |   -
104 |     scope:
105 |       path: ""
106 |       type: "pages"
107 |     values:
108 |       layout: "page"
109 |   -
110 |     scope:
111 |       path: "posts"
112 |       type: "posts"
113 |     values:
114 |       layout: "post"
115 | 


--------------------------------------------------------------------------------
/_data/navigation.yml:
--------------------------------------------------------------------------------
1 | - title: About
2 |   url: about
3 | - title: Documentation
4 |   url: docs
5 | 


--------------------------------------------------------------------------------
/_data/quizzes/example-quiz.yml:
--------------------------------------------------------------------------------
 1 | title: This is the Quiz Title
 2 | randomized: false
 3 | questions:
 4 | 
 5 |  - type: "multiple-choice"
 6 |    question: "What is your favorite color?"
 7 |    items:
 8 |     - choice: Red
 9 |       correct: null
10 |     - choice: Blue
11 |       correct: null
12 |     - choice: Green
13 |       correct: null
14 |    followup: There is no correct answer to asking your favorite color! All choices would be good.
15 | 
16 |  - type: "multiple-choice"
17 |    question: "True or False, Pittsburgh is West of Philadelphia"
18 |    items:
19 |     - choice: True
20 |       correct: true
21 |     - choice: False
22 |       correct: false
23 |    followup: | 
24 |       The answer is True! Pittsburgh is 304.9 miles West of Philadelphia, or approximately 
25 |       a car ride of 4 hours and 52 minutes. Buckle up!
26 | 


--------------------------------------------------------------------------------
/_data/toc-mapping.yml:
--------------------------------------------------------------------------------
1 | # This file can be used to explicitly map a release to a specific table-of-contents
2 | # (TOC). You'll want to use this after any revamps to information architecture, to ensure
3 | # that the navigation for older versions still work.
4 | 
5 | Current: toc
6 | Previous: previous-toc
7 | 


--------------------------------------------------------------------------------
/_data/toc.yml:
--------------------------------------------------------------------------------
 1 | - title: Documentation
 2 |   url: docs
 3 |   links:
 4 |     - title: "Getting Started"
 5 |       url: "docs/getting-started"
 6 |       children:
 7 |         - title: Features
 8 |           url: "docs/getting-started#getting-started"
 9 |         - title: Development
10 |           url: "docs/getting-started#development"
11 |         - title: Customization
12 |           url: "docs/getting-started#customization"
13 |     - title: Versioning
14 |       url: "docs/versioning"
15 |     - title: "About"
16 |       url: "about"
17 |     - title: "News"
18 |       url: "news"
19 | - title: "Extras"
20 |   url: "docs/extras"
21 |   links:
22 |     - title: Quizzes
23 |       url: "docs/extras/example-quiz"
24 |     - title: Tags Page
25 |       url: "tags"
26 | 


--------------------------------------------------------------------------------
/_data/versions/previous-toc.yml:
--------------------------------------------------------------------------------
 1 | - title: Documentation
 2 |   url: docs
 3 |   links:
 4 |     - title: "Getting Started"
 5 |       url: "docs/getting-started"
 6 |       children:
 7 |         - title: Features
 8 |           url: "docs/getting-started#getting-started"
 9 |         - title: Development
10 |           url: "docs/getting-started#development"
11 |         - title: Customization
12 |           url: "docs/getting-started#customization"
13 |     - title: "About"
14 |       url: "about"
15 |     - title: "News"
16 |       url: "news"
17 | - title: "Extras"
18 |   url: "docs/extras"
19 |   links:
20 |     - title: Quizzes
21 |       url: "docs/extras/example-quiz"
22 |     - title: Tags Page
23 |       url: "tags"
24 | 


--------------------------------------------------------------------------------
/_docs/Archive/Previous/example-page.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | title: A Nested Page
 3 | description: An example of a nested page
 4 | ---
 5 | 
 6 | # A Nested Page
 7 | 
 8 | This is an example of a page that doesn't have a permalink defined, and
 9 | is not included in the table of contents (`_data/toc.yml`). This means
10 | that it will render based on it's path. Since it's in `docs/example-page.md`,
11 | the url will be `docs/example-page/`.
12 | 
13 | ## Link to a subfolder
14 | 
15 | Now let's say we want to link to a subfolder, specifically with this
16 | setup:
17 | 
18 | ```
19 | docs/
20 |   example-page.md  (-- we are here
21 |   subfolder/
22 |      example-page.md  (-- we want to link here
23 | ```
24 | 
25 | You can provide the relative path to the file, like `subfolder/example-page.md`
26 | and Jekyll will handle parsing it. For example:
27 | 
28 |  - [here is that link](subfolder/example-page)
29 |  
30 | And {% include doc.html name="here" path="subfolder/example-page" %} is the same link, 
31 | but generated with the include statement:
32 | 
33 | ```
34 | {% raw %}{% include doc.html name="here" path="subfolder/example-page" %}{% endraw %}
35 | ```
36 | 
37 | 


--------------------------------------------------------------------------------
/_docs/Archive/Previous/extras/example-quiz.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | title: Quiz
 3 | description: How to add interactive quizzes to your site.
 4 | ---
 5 | 
 6 | # Quizzes
 7 | 
 8 | As of version 0.0.12, docsy-jekyll has support for basic quizzes! These are
 9 | intended to help educate your users about the content of your documentation.
10 | For a quiz, you can add a new file to the folder `_data/quizzes`, and write a 
11 | questions file based on the format shown in `_data/quizzes/example-quiz.yml`.
12 | Here is a simple example of a multiple choice question (which can also serve as 
13 | True/False):
14 | 
15 | ```yaml
16 | title: This is the Quiz Title
17 | randomized: false
18 | questions:
19 | 
20 |  - type: "multiple-choice"
21 |    question: "True or False, Pittsburgh is West of Philadelphia"
22 |    items:
23 |     - choice: True
24 |       correct: true
25 |     - choice: False
26 |       correct: false
27 |    followup: | 
28 |       The answer is True! Pittsburgh is 304.9 miles West of 
29 |       Philadelphia, or approximately a car ride of 
30 |       4 hours and 52 minutes. Buckle up!
31 | ```
32 | 
33 | The quiz is rendered with a "Show Answer" button below each question, and when
34 | the user clicks it, any questions that are flagged with `correct: true` will be 
35 | bolded, and if a followup section is included, it will be displayed.
36 | See the live example at the end of this page.
37 | 
38 | ## Options
39 | 
40 | #### Title
41 | 
42 | If you include a title, it will be rendered at the top of the quiz. This is
43 | optional - you can leave it out and add it before the include on the page.
44 | 
45 | #### Random
46 | 
47 | If you want your questions to be presented randomly, just add randomized: true
48 | to the data.
49 | 
50 | 
51 | ## Example Quiz
52 | 
53 | If I want to include the quiz located at `_data/quizzes/example-quiz.yml`, I 
54 | can do so like this:
55 | 
56 | ```
57 | {% raw %}{% include quiz.html file='example-quiz' %}{% endraw %}
58 | ```
59 | 
60 | The rendered quiz is shown here:
61 | 
62 | 
63 | {% include quiz.html file='example-quiz' %}
64 | 


--------------------------------------------------------------------------------
/_docs/Archive/Previous/extras/index.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | title: Extras
 3 | description: Extras, including quizzes.
 4 | tags:
 5 |  - survey
 6 | ---
 7 | 
 8 | # Extras
 9 | 
10 | Extras include other integrations that aren't relevant to style or customization,
11 | but can further enhance your documentation pages. Currently, we have support
12 | for adding interactive quizzes.
13 | 
14 |  - [Quizzes](example-quiz)
15 |  - [Tags]({{ site.baseurl }}/tags/)
16 | 
17 | Would you like to see another question type, or another kind of extra? Please [open an issue]({{ site.repo }}/issues/new).
18 | 


--------------------------------------------------------------------------------
/_docs/Archive/Previous/getting-started.md:
--------------------------------------------------------------------------------
  1 | ---
  2 | title: Getting Started
  3 | tags: 
  4 |  - jekyll
  5 |  - github
  6 | description: Getting started with Docsy Jekyll
  7 | ---
  8 | 
  9 | # Getting Started
 10 | 
 11 | ## Features
 12 | 
 13 | ### User Interaction
 14 | 
 15 | 
 16 | On the right side of any page, you'll notice links to edit the page, or
 17 | open an issue. This ensures that any time you have a question or want to 
 18 | suggest or request a change, you can do so immediately and link directly
 19 | to the section of interest. The sections on the page also have permalinks so
 20 | you can link directly to them.
 21 | 
 22 | ### Search
 23 | 
 24 | The entire site, including posts and documentation, is indexed and then available
 25 | for search at the top or side of the page. Give it a try! The content is rendered
 26 | into window data that is used by lunr.js to generate the search results.
 27 | If you want to exclude any file from search, add this to its front end matter:
 28 | 
 29 | ```
 30 | ---
 31 | layout: null
 32 | excluded_in_search: true
 33 | ---
 34 | ```
 35 | 
 36 | The example above is for a javascript file in the assets folder that is used as a template,
 37 | but should not be included in search.
 38 | 
 39 | ### External Search
 40 | 
 41 | If you have an external site with a search GET endpoint (meaning one that ends
 42 | in `?q=<term>`, then you can automatically link page tags to search this endpoint.
 43 | For example, on an HPC site I'd want a tag like "mpi" to do a search on 
 44 | [http://ask.cyberinfrastructure.org](http://ask.cyberinfrastructure.org) for mpi.
 45 | See the [tags](#tags) section below for how to configure this.
 46 | 
 47 | ### Documentation
 48 | 
 49 | Documentation pages should be written in the `docs` folder of the repository,
 50 | and you are allowed to use whatever level of nesting (subfolders) that 
 51 | works for you! It's a Jekyll [collection](https://jekyllrb.com/docs/collections/), which means that you
 52 | can add other content (images, scripts) and it will be included for linking to.
 53 | To create subfolders with files, you can simply create new markdon files. For example:
 54 | 
 55 |  - `_docs/subfolder/example-page.md` renders to `http://localhost:4000/docsy-jekyll/docs/subfolder/example-page/`
 56 |  - `_docs/subfolder.md` renders to `http://localhost:4000/docsy-jekyll/docs/subfolder/`
 57 | 
 58 | And the page you are reading now renders from `_docs/getting-started.md`
 59 | 
 60 | #### Organization
 61 | 
 62 | The url that will render is based on the path. For example, if we had the following structure:
 63 | 
 64 | ```
 65 | docs/
 66 |   getting-started.md
 67 |   clusters/
 68 |      sherlock/
 69 |          getting-started.md
 70 | ```
 71 | 
 72 | The first page (akin to the one you are reading) would render at it's path,
 73 | `/docs/getting-started/`.
 74 | 
 75 | 
 76 | #### Linking
 77 | 
 78 | From that page, we could provide the
 79 | direct path in markdown to any subfolder to link to it, such as the second
 80 | getting started page for sherlock:
 81 | 
 82 | ```
 83 | {% raw %}[example](clusters/sherlock/getting-started.md){% endraw %}
 84 | ```
 85 | 
 86 | [Here](example-page) is an example link to a relative path of a file (`example-page.md`)
 87 | in the same directory, and from that page you can test linking to a subfolder.
 88 | In the case of not having a subfolder, we could write the link out directly:
 89 | 
 90 | ```
 91 | {% raw %}[example]({{ site.baseurl }}/docs/clusters/sherlock/getting-started.md){% endraw %}
 92 | ```
 93 | 
 94 | or just put the relative path:
 95 | 
 96 | ```
 97 | {% raw %}[Here](example-page){% endraw %}
 98 | ```
 99 | 
100 | or better, there is a shortand trick! We can use the provided "includes" 
101 | template to do the same based on the path to create a link:
102 | 
103 | ```
104 | {% raw %}{% include doc.html name="Sherlock Cluster" path="clusters/sherlock/getting-started" %}{% endraw %}
105 | ```
106 | The path should be relative to the docs folder.
107 | 
108 | ### Pages
109 | 
110 | The `pages` folder uses the same page layout, but is not part of the docs collection.
111 | The two are provided to create a distinction between website pages (e.g., about,
112 | feed.xml) and documentation pages.  
113 | 
114 | ### Navigation
115 | 
116 | Whether you place your page under "pages" or "docs," for those pages that you want added to the navigation, 
117 | you should add them to `_data/toc.yml`. If you've defined a `permalink` in the
118 | front end matter, you can use that (e.g., "About" below). If you haven't and
119 | want to link to docs, the url is the path starting with the docs folder.
120 | Here is an example (currently the active example):
121 | 
122 | ```yaml
123 | - title: Documentation
124 |   url: docs
125 |   links:
126 |     - title: "Getting Started"
127 |       url: "docs/getting-started"
128 |       children:
129 |         - title: Features
130 |           url: "docs/getting-started#getting-started"
131 |         - title: Development
132 |           url: "docs/getting-started#development"
133 |         - title: Customization
134 |           url: "docs/getting-started#customization"
135 |     - title: "Extras"
136 |       url: "docs/extras"
137 |       children:
138 |         - title: Quizzes
139 |           url: "docs/extras/example-quiz"
140 |     - title: "About"
141 |       url: "about"
142 |     - title: "News"
143 |       url: "news
144 | ```
145 | 
146 | If you want to add an external url for a parent or child, do this:
147 | 
148 | ```yaml
149 |   - title: GitHub Repository
150 |     external_url: https://www.github.com/vsoch/mkdocs-jekyll
151 | ```
152 | 
153 | ### News Posts
154 | 
155 | It might be the case that your site or group has news items that would
156 | warrant sharing with the community, and should be available as a feed.
157 | For this reason, you can write traditional [posts](https://jekyllrb.com/docs/posts/) in the `_posts`
158 | folder that will parse into the site [feed]({{ site.baseurl }}/feed.xml)
159 | The bottom of the page links the user to a post archive, where posts are organized
160 | according to the year.
161 | 
162 | ### Buttons
163 | 
164 | Buttons come in a nice array of colors. Here is the code for a basic example,
165 | and you'd want to vary the `.btn-<tag>` to get different classes.
166 | 
167 | ```html
168 | <button class="btn btn-success">.btn-success</button>
169 | ```
170 | 
171 | <button class="btn btn-success">.btn-success</button>
172 | <button class="btn btn-info">.btn-info</button>
173 | <button class="btn btn-secondary">.btn-secondary</button>
174 | <button class="btn btn-primary">.btn-primary</button>
175 | <button class="btn btn-danger">.btn-danger</button>
176 | <button class="btn btn-warning">.btn-warning</button>
177 | 
178 | ### Badges
179 | 
180 | For news post items, it's nice to be able to tag it with something that indicates
181 | a status, such as "warning" or "alert." For this reason, you can add badges to
182 | the front end matter of any post page, and they will render colored by a type,
183 | with the tag of your choice. For example, here is an example header for
184 | a post:
185 | 
186 | ```yaml
187 | ---
188 | title:  "Two Thousand Nineteen"
189 | date:   2019-06-28 18:52:21
190 | categories: jekyll update
191 | badges:
192 |  - type: warning
193 |    tag: warning-badge
194 |  - type: danger
195 |    tag: danger-badge
196 | ---
197 | ```
198 | 
199 | And here is the post preview with the rendered badges that it produces:
200 | 
201 | <span class="badge badge-warning">warning-badge</span>
202 | <span class="badge badge-danger">danger-badge</span>
203 | 
204 | And the other badges that you can define include success, info, secondary,
205 | and primary.
206 | 
207 | <span class="badge badge-success">success-badge</span>
208 | <span class="badge badge-info">info-badge</span>
209 | <span class="badge badge-secondary">secondary-badge</span>
210 | <span class="badge badge-primary">primary-badge</span>
211 | 
212 | ### Alerts
213 | 
214 | {% include alert.html type="info" title="What is an alert?" content="An alert is a box that can stand out to indicate important information. You can choose from levels success, warning, danger, info, and primary. This example is an info box, and the code for another might look like this:" %}
215 | 
216 | ```
217 | {%raw%}{% include alert.html type="info" title="Here is another!" %}{%endraw%}
218 | ```
219 | 
220 | Just for fun, here are all the types:
221 | 
222 | {% include alert.html type="warning" content="This is a warning" %}
223 | {% include alert.html type="danger" content="This alerts danger!" %}
224 | {% include alert.html type="success" content="This alerts success" %}
225 | {% include alert.html type="info" content="This is useful information." %}
226 | {% include alert.html type="primary" content="This is a primary alert" %}
227 | {% include alert.html type="secondary" content="This is a secondary alert" %}
228 | 
229 | ### Quotes
230 | 
231 | You can include block quotes to emphasize text. 
232 | 
233 | > Here is an example. Isn't this much more prominent to the user?
234 | 
235 | ## Development
236 | 
237 | Initially (on OS X), you will need to setup [Brew](http://brew.sh/) which is a package manager for OS X and [Git](https://git-scm.com/). To install Brew and Git, run the following commands:
238 | 
239 | ```bash
240 | /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
241 | brew install git
242 | ```
243 | 
244 | If you are on Debian/Ubuntu, then you can easily install git with `apt-get`
245 | 
246 | ```bash
247 | apt-get update && apt-get install -y git
248 | ```
249 | 
250 | ### Install Jekyll
251 | 
252 | You can also install Jekyll with brew.
253 | 
254 | ```bash
255 | $ brew install ruby
256 | $ gem install jekyll
257 | $ gem install bundler
258 | $ bundle install
259 | ```
260 | 
261 | On Ubuntu I do a different method:
262 | 
263 | ```bash
264 | git clone https://github.com/rbenv/ruby-build.git ~/.rbenv/plugins/ruby-build
265 | echo 'export PATH="$HOME/.rbenv/plugins/ruby-build/bin:$PATH"' >> ~/.bashrc
266 | exec $SHELL
267 | rbenv install 2.3.1
268 | rbenv global 2.3.1
269 | gem install bundler
270 | rbenv rehash
271 | ruby -v
272 | 
273 | # Rails
274 | curl -sL https://deb.nodesource.com/setup_4.x | sudo -E bash -
275 | sudo apt-get install -y nodejs
276 | gem install rails -v 4.2.6
277 | rbenv rehash
278 | 
279 | # Jekyll
280 | gem install jekyll
281 | gem install github-pages
282 | gem install jekyll-sass-converter
283 | 
284 | rbenv rehash
285 | ```
286 | 
287 | ### Get the code
288 | 
289 | You should first fork the repository to your GitHub organization or username,
290 | and then clone it.
291 | 
292 | ```bash
293 | $ git clone https://github.com/<username>/mkdocs-jekyll.git docs
294 | $ cd docs
295 | ```
296 | 
297 | You can clone the repository right to where you want to host the docs:
298 | 
299 | ```bash
300 | $ git clone https://github.com/<username>/mkdocs-jekyll.git docs
301 | $ cd docs
302 | ```
303 | 
304 | 
305 | ### Serve
306 | 
307 | Depending on how you installed jekyll:
308 | 
309 | ```bash
310 | jekyll serve
311 | # or
312 | bundle exec jekyll serve
313 | ```
314 | 
315 | 
316 | ### Preview
317 | 
318 | We provide a [CircleCI](https://circleci.com/) configuration recipe that you
319 | can use to preview your site on CircleCI before merging into master. You
320 | should follow the instructions to [set up a project](https://circleci.com/docs/enterprise/quick-start/),
321 | and then in the project settings be sure to enable building forked build requests,
322 | and to cancel redundant builds. The preview will be built on CircleCI, and saved
323 | to static files for you to browse. The only change you will need is to edit
324 | the static files location to be the name of your repository, which is at te
325 | bottom of the `.circleci/config.yml` file:
326 | 
327 | ```yaml
328 |       - store_artifacts:
329 |           path: ~/repo/_site
330 |           destination: mkdocs-jekyll
331 | ```
332 | 
333 | In the above, the destination should coincide with your repository name.
334 | Remember that for most links, CircleCI won't honor an `index.html` file in a subfolder
335 | (e.g., `subfolder/index.html` will not be served as `subfolder/`, so for example,
336 | you might need to turn this:
337 | 
338 | ```
339 | https://<circleci>/0/mkdocs-jekyll/docs/getting-started/
340 | ```
341 | into this:
342 | 
343 | ```
344 | https://<circleci>/0/mkdocs-jekyll/docs/getting-started/index.html
345 | ```
346 | 
347 | ## Customization
348 | 
349 | #### config.yml
350 | 
351 | To edit configuration values, customize the [_config.yml](_config.yml).
352 | Most are documented there, and please [open an issue](https://www.github.com/{{ site.github_user }}/{{ site.github_user }}/issues) if you have questions.
353 | 
354 | #### Adding pages
355 | 
356 | To add pages, write them into the [pages](pages) folder. 
357 | You define urls based on the `permalink` attribute in your pages,
358 | and then add them to the navigation by adding to the content of [_data/toc.yml](_data/toc.yml).
359 | 
360 | #### Tags
361 | 
362 | If you include tags on a page, by default they will link to the [tags page]({{ site.url }}{{ site.baseurl }}/tags) on the site. However, if you define a `tag_search_endpoint` url in your configuration file, by clicking
363 | the tag, the user will be taken to this page to search for it. As an example,
364 | we define the current search endpoint to be Ask Cyberinfrastructure, and
365 | page tags link to a search on it:
366 | 
367 | ```yaml
368 | tag_search_endpoint: https://ask.cyberinfrastructure.org/search?q=
369 | tag_color: danger # danger, success, warning, primary, secondary, info
370 | ```
371 | 
372 | Note that you can also choose a color! The tags appear at the top of the page,
373 | as they do on this page. The tags should be defined like this in the front end
374 | matter:
375 | 
376 | ```yaml
377 | tags: 
378 |  - jekyll
379 |  - github
380 | ```
381 | 
382 | They are appended to the first h1 block, so generally your pages should have a header.
383 | If you comment out this variable, then each of your tags will link to it's appropriate
384 | spot on the tags page linked above.
385 | 
386 | ```yaml
387 | #tag_search_endpoint: https://ask.cyberinfrastructure.org/search?q=
388 | tag_color: primary # danger, success, warning, primary, info, secondary
389 | ```
390 | 
391 | 


--------------------------------------------------------------------------------
/_docs/Archive/Previous/subfolder.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | title: The Subfolder Page
 3 | description: An example of a subfolder page.
 4 | ---
 5 | 
 6 | # A Subfolder Page.
 7 | 
 8 | This is an example of a page that doesn't have a permalink defined, and
 9 | is not included in the table of contents (`_data/toc.yml`).
10 | 


--------------------------------------------------------------------------------
/_docs/Archive/Previous/subfolder/example-page.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | title: A Nested Page
 3 | description: An example of a nested page in a subfolder.
 4 | ---
 5 | 
 6 | # A Nested Page
 7 | 
 8 | This is an example of a page that doesn't have a permalink defined, and
 9 | is not included in the table of contents (`_data/toc.yml`).
10 | 


--------------------------------------------------------------------------------
/_docs/example-page.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | title: A Nested Page
 3 | description: An example of a nested page
 4 | ---
 5 | 
 6 | # A Nested Page
 7 | 
 8 | This is an example of a page that doesn't have a permalink defined, and
 9 | is not included in the table of contents (`_data/toc.yml`). This means
10 | that it will render based on it's path. Since it's in `docs/example-page.md`,
11 | the url will be `docs/example-page/`.
12 | 
13 | ## Link to a subfolder
14 | 
15 | Now let's say we want to link to a subfolder, specifically with this
16 | setup:
17 | 
18 | ```
19 | docs/
20 |   example-page.md  (-- we are here
21 |   subfolder/
22 |      example-page.md  (-- we want to link here
23 | ```
24 | 
25 | You can provide the relative path to the file, like `subfolder/example-page.md`
26 | and Jekyll will handle parsing it. For example:
27 | 
28 |  - [here is that link](subfolder/example-page)
29 |  
30 | And {% include doc.html name="here" path="subfolder/example-page" %} is the same link, 
31 | but generated with the include statement:
32 | 
33 | ```
34 | {% raw %}{% include doc.html name="here" path="subfolder/example-page" %}{% endraw %}
35 | ```
36 | 
37 | 


--------------------------------------------------------------------------------
/_docs/extras/example-quiz.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | title: Quiz
 3 | description: How to add interactive quizzes to your site.
 4 | ---
 5 | 
 6 | # Quizzes
 7 | 
 8 | As of version 0.0.12, docsy-jekyll has support for basic quizzes! These are
 9 | intended to help educate your users about the content of your documentation.
10 | For a quiz, you can add a new file to the folder `_data/quizzes`, and write a 
11 | questions file based on the format shown in `_data/quizzes/example-quiz.yml`.
12 | Here is a simple example of a multiple choice question (which can also serve as 
13 | True/False):
14 | 
15 | ```yaml
16 | title: This is the Quiz Title
17 | randomized: false
18 | questions:
19 | 
20 |  - type: "multiple-choice"
21 |    question: "True or False, Pittsburgh is West of Philadelphia"
22 |    items:
23 |     - choice: True
24 |       correct: true
25 |     - choice: False
26 |       correct: false
27 |    followup: | 
28 |       The answer is True! Pittsburgh is 304.9 miles West of 
29 |       Philadelphia, or approximately a car ride of 
30 |       4 hours and 52 minutes. Buckle up!
31 | ```
32 | 
33 | The quiz is rendered with a "Show Answer" button below each question, and when
34 | the user clicks it, any questions that are flagged with `correct: true` will be 
35 | bolded, and if a followup section is included, it will be displayed.
36 | See the live example at the end of this page.
37 | 
38 | ## Options
39 | 
40 | #### Title
41 | 
42 | If you include a title, it will be rendered at the top of the quiz. This is
43 | optional - you can leave it out and add it before the include on the page.
44 | 
45 | #### Random
46 | 
47 | If you want your questions to be presented randomly, just add randomized: true
48 | to the data.
49 | 
50 | 
51 | ## Example Quiz
52 | 
53 | If I want to include the quiz located at `_data/quizzes/example-quiz.yml`, I 
54 | can do so like this:
55 | 
56 | ```
57 | {% raw %}{% include quiz.html file='example-quiz' %}{% endraw %}
58 | ```
59 | 
60 | The rendered quiz is shown here:
61 | 
62 | 
63 | {% include quiz.html file='example-quiz' %}
64 | 


--------------------------------------------------------------------------------
/_docs/extras/index.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | title: Extras
 3 | description: Extras, including quizzes.
 4 | tags:
 5 |  - survey
 6 | ---
 7 | 
 8 | # Extras
 9 | 
10 | Extras include other integrations that aren't relevant to style or customization,
11 | but can further enhance your documentation pages. Currently, we have support
12 | for adding interactive quizzes.
13 | 
14 |  - [Quizzes](example-quiz)
15 |  - [Tags]({{ site.baseurl }}/tags/)
16 | 
17 | Would you like to see another question type, or another kind of extra? Please [open an issue]({{ site.repo }}/issues/new).
18 | 


--------------------------------------------------------------------------------
/_docs/getting-started.md:
--------------------------------------------------------------------------------
  1 | ---
  2 | title: Getting Started
  3 | tags: 
  4 |  - jekyll
  5 |  - github
  6 | description: Getting started with Docsy Jekyll
  7 | ---
  8 | 
  9 | # Getting Started
 10 | 
 11 | ## Features
 12 | 
 13 | ### User Interaction
 14 | 
 15 | 
 16 | On the right side of any page, you'll notice links to edit the page, or
 17 | open an issue. This ensures that any time you have a question or want to 
 18 | suggest or request a change, you can do so immediately and link directly
 19 | to the section of interest. The sections on the page also have permalinks so
 20 | you can link directly to them.
 21 | 
 22 | ### Search
 23 | 
 24 | The entire site, including posts and documentation, is indexed and then available
 25 | for search at the top or side of the page. Give it a try! The content is rendered
 26 | into window data that is used by lunr.js to generate the search results.
 27 | If you want to exclude any file from search, add this to its front end matter:
 28 | 
 29 | ```
 30 | ---
 31 | layout: null
 32 | excluded_in_search: true
 33 | ---
 34 | ```
 35 | 
 36 | The example above is for a javascript file in the assets folder that is used as a template,
 37 | but should not be included in search.
 38 | 
 39 | ### External Search
 40 | 
 41 | If you have an external site with a search GET endpoint (meaning one that ends
 42 | in `?q=<term>`, then you can automatically link page tags to search this endpoint.
 43 | For example, on an HPC site I'd want a tag like "mpi" to do a search on 
 44 | [http://ask.cyberinfrastructure.org](http://ask.cyberinfrastructure.org) for mpi.
 45 | See the [tags](#tags) section below for how to configure this.
 46 | 
 47 | ### Documentation
 48 | 
 49 | Documentation pages should be written in the `docs` folder of the repository,
 50 | and you are allowed to use whatever level of nesting (subfolders) that 
 51 | works for you! It's a Jekyll [collection](https://jekyllrb.com/docs/collections/), which means that you
 52 | can add other content (images, scripts) and it will be included for linking to.
 53 | To create subfolders with files, you can simply create new markdon files. For example:
 54 | 
 55 |  - `_docs/subfolder/example-page.md` renders to `http://localhost:4000/docsy-jekyll/docs/subfolder/example-page/`
 56 |  - `_docs/subfolder.md` renders to `http://localhost:4000/docsy-jekyll/docs/subfolder/`
 57 | 
 58 | And the page you are reading now renders from `_docs/getting-started.md`
 59 | 
 60 | #### Organization
 61 | 
 62 | The url that will render is based on the path. For example, if we had the following structure:
 63 | 
 64 | ```
 65 | docs/
 66 |   getting-started.md
 67 |   clusters/
 68 |      sherlock/
 69 |          getting-started.md
 70 | ```
 71 | 
 72 | The first page (akin to the one you are reading) would render at it's path,
 73 | `/docs/getting-started/`.
 74 | 
 75 | 
 76 | #### Linking
 77 | 
 78 | From that page, we could provide the
 79 | direct path in markdown to any subfolder to link to it, such as the second
 80 | getting started page for sherlock:
 81 | 
 82 | ```
 83 | {% raw %}[example](clusters/sherlock/getting-started.md){% endraw %}
 84 | ```
 85 | 
 86 | [Here](example-page) is an example link to a relative path of a file (`example-page.md`)
 87 | in the same directory, and from that page you can test linking to a subfolder.
 88 | In the case of not having a subfolder, we could write the link out directly:
 89 | 
 90 | ```
 91 | {% raw %}[example]({{ site.baseurl }}/docs/clusters/sherlock/getting-started.md){% endraw %}
 92 | ```
 93 | 
 94 | or just put the relative path:
 95 | 
 96 | ```
 97 | {% raw %}[Here](example-page){% endraw %}
 98 | ```
 99 | 
100 | or better, there is a shortand trick! We can use the provided "includes" 
101 | template to do the same based on the path to create a link:
102 | 
103 | ```
104 | {% raw %}{% include doc.html name="Sherlock Cluster" path="clusters/sherlock/getting-started" %}{% endraw %}
105 | ```
106 | The path should be relative to the docs folder.
107 | 
108 | ### Pages
109 | 
110 | The `pages` folder uses the same page layout, but is not part of the docs collection.
111 | The two are provided to create a distinction between website pages (e.g., about,
112 | feed.xml) and documentation pages.  
113 | 
114 | ### Navigation
115 | 
116 | Whether you place your page under "pages" or "docs," for those pages that you want added to the navigation, 
117 | you should add them to `_data/toc.yml`. If you've defined a `permalink` in the
118 | front end matter, you can use that (e.g., "About" below). If you haven't and
119 | want to link to docs, the url is the path starting with the docs folder.
120 | Here is an example (currently the active example):
121 | 
122 | ```yaml
123 | - title: Documentation
124 |   url: docs
125 |   links:
126 |     - title: "Getting Started"
127 |       url: "docs/getting-started"
128 |       children:
129 |         - title: Features
130 |           url: "docs/getting-started#getting-started"
131 |         - title: Development
132 |           url: "docs/getting-started#development"
133 |         - title: Customization
134 |           url: "docs/getting-started#customization"
135 |     - title: "Extras"
136 |       url: "docs/extras"
137 |       children:
138 |         - title: Quizzes
139 |           url: "docs/extras/example-quiz"
140 |     - title: "About"
141 |       url: "about"
142 |     - title: "News"
143 |       url: "news
144 | ```
145 | 
146 | If you want to add an external url for a parent or child, do this:
147 | 
148 | ```yaml
149 |   - title: GitHub Repository
150 |     external_url: https://www.github.com/vsoch/mkdocs-jekyll
151 | ```
152 | 
153 | ### News Posts
154 | 
155 | It might be the case that your site or group has news items that would
156 | warrant sharing with the community, and should be available as a feed.
157 | For this reason, you can write traditional [posts](https://jekyllrb.com/docs/posts/) in the `_posts`
158 | folder that will parse into the site [feed]({{ site.baseurl }}/feed.xml)
159 | The bottom of the page links the user to a post archive, where posts are organized
160 | according to the year.
161 | 
162 | ### Buttons
163 | 
164 | Buttons come in a nice array of colors. Here is the code for a basic example,
165 | and you'd want to vary the `.btn-<tag>` to get different classes.
166 | 
167 | ```html
168 | <button class="btn btn-success">.btn-success</button>
169 | ```
170 | 
171 | <button class="btn btn-success">.btn-success</button>
172 | <button class="btn btn-info">.btn-info</button>
173 | <button class="btn btn-secondary">.btn-secondary</button>
174 | <button class="btn btn-primary">.btn-primary</button>
175 | <button class="btn btn-danger">.btn-danger</button>
176 | <button class="btn btn-warning">.btn-warning</button>
177 | 
178 | ### Badges
179 | 
180 | For news post items, it's nice to be able to tag it with something that indicates
181 | a status, such as "warning" or "alert." For this reason, you can add badges to
182 | the front end matter of any post page, and they will render colored by a type,
183 | with the tag of your choice. For example, here is an example header for
184 | a post:
185 | 
186 | ```yaml
187 | ---
188 | title:  "Two Thousand Nineteen"
189 | date:   2019-06-28 18:52:21
190 | categories: jekyll update
191 | badges:
192 |  - type: warning
193 |    tag: warning-badge
194 |  - type: danger
195 |    tag: danger-badge
196 | ---
197 | ```
198 | 
199 | And here is the post preview with the rendered badges that it produces:
200 | 
201 | <span class="badge badge-warning">warning-badge</span>
202 | <span class="badge badge-danger">danger-badge</span>
203 | 
204 | And the other badges that you can define include success, info, secondary,
205 | and primary.
206 | 
207 | <span class="badge badge-success">success-badge</span>
208 | <span class="badge badge-info">info-badge</span>
209 | <span class="badge badge-secondary">secondary-badge</span>
210 | <span class="badge badge-primary">primary-badge</span>
211 | 
212 | ### Alerts
213 | 
214 | {% include alert.html type="info" title="What is an alert?" content="An alert is a box that can stand out to indicate important information. You can choose from levels success, warning, danger, info, and primary. This example is an info box, and the code for another might look like this:" %}
215 | 
216 | ```
217 | {%raw%}{% include alert.html type="info" title="Here is another!" %}{%endraw%}
218 | ```
219 | 
220 | Just for fun, here are all the types:
221 | 
222 | {% include alert.html type="warning" content="This is a warning" %}
223 | {% include alert.html type="danger" content="This alerts danger!" %}
224 | {% include alert.html type="success" content="This alerts success" %}
225 | {% include alert.html type="info" content="This is useful information." %}
226 | {% include alert.html type="primary" content="This is a primary alert" %}
227 | {% include alert.html type="secondary" content="This is a secondary alert" %}
228 | 
229 | ### Quotes
230 | 
231 | You can include block quotes to emphasize text. 
232 | 
233 | > Here is an example. Isn't this much more prominent to the user?
234 | 
235 | ## Development
236 | 
237 | Initially (on OS X), you will need to setup [Brew](http://brew.sh/) which is a package manager for OS X and [Git](https://git-scm.com/). To install Brew and Git, run the following commands:
238 | 
239 | ```bash
240 | /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
241 | brew install git
242 | ```
243 | 
244 | If you are on Debian/Ubuntu, then you can easily install git with `apt-get`
245 | 
246 | ```bash
247 | apt-get update && apt-get install -y git
248 | ```
249 | 
250 | ### Install Jekyll
251 | 
252 | You can also install Jekyll with brew.
253 | 
254 | ```bash
255 | $ brew install ruby
256 | $ gem install jekyll
257 | $ gem install bundler
258 | $ bundle install
259 | ```
260 | 
261 | On Ubuntu I do a different method:
262 | 
263 | ```bash
264 | git clone https://github.com/rbenv/ruby-build.git ~/.rbenv/plugins/ruby-build
265 | echo 'export PATH="$HOME/.rbenv/plugins/ruby-build/bin:$PATH"' >> ~/.bashrc
266 | exec $SHELL
267 | rbenv install 2.3.1
268 | rbenv global 2.3.1
269 | gem install bundler
270 | rbenv rehash
271 | ruby -v
272 | 
273 | # Rails
274 | curl -sL https://deb.nodesource.com/setup_4.x | sudo -E bash -
275 | sudo apt-get install -y nodejs
276 | gem install rails -v 4.2.6
277 | rbenv rehash
278 | 
279 | # Jekyll
280 | gem install jekyll
281 | gem install github-pages
282 | gem install jekyll-sass-converter
283 | 
284 | rbenv rehash
285 | ```
286 | 
287 | ### Get the code
288 | 
289 | You should first fork the repository to your GitHub organization or username,
290 | and then clone it.
291 | 
292 | ```bash
293 | $ git clone https://github.com/<username>/mkdocs-jekyll.git docs
294 | $ cd docs
295 | ```
296 | 
297 | You can clone the repository right to where you want to host the docs:
298 | 
299 | ```bash
300 | $ git clone https://github.com/<username>/mkdocs-jekyll.git docs
301 | $ cd docs
302 | ```
303 | 
304 | 
305 | ### Serve
306 | 
307 | Depending on how you installed jekyll:
308 | 
309 | ```bash
310 | jekyll serve
311 | # or
312 | bundle exec jekyll serve
313 | ```
314 | 
315 | 
316 | ### Preview
317 | 
318 | We provide a [CircleCI](https://circleci.com/) configuration recipe that you
319 | can use to preview your site on CircleCI before merging into master. You
320 | should follow the instructions to [set up a project](https://circleci.com/docs/enterprise/quick-start/),
321 | and then in the project settings be sure to enable building forked build requests,
322 | and to cancel redundant builds. The preview will be built on CircleCI, and saved
323 | to static files for you to browse. The only change you will need is to edit
324 | the static files location to be the name of your repository, which is at te
325 | bottom of the `.circleci/config.yml` file:
326 | 
327 | ```yaml
328 |       - store_artifacts:
329 |           path: ~/repo/_site
330 |           destination: mkdocs-jekyll
331 | ```
332 | 
333 | In the above, the destination should coincide with your repository name.
334 | Remember that for most links, CircleCI won't honor an `index.html` file in a subfolder
335 | (e.g., `subfolder/index.html` will not be served as `subfolder/`, so for example,
336 | you might need to turn this:
337 | 
338 | ```
339 | https://<circleci>/0/mkdocs-jekyll/docs/getting-started/
340 | ```
341 | into this:
342 | 
343 | ```
344 | https://<circleci>/0/mkdocs-jekyll/docs/getting-started/index.html
345 | ```
346 | 
347 | ## Customization
348 | 
349 | #### config.yml
350 | 
351 | To edit configuration values, customize the [_config.yml](_config.yml).
352 | Most are documented there, and please [open an issue](https://www.github.com/{{ site.github_user }}/{{ site.github_user }}/issues) if you have questions.
353 | 
354 | #### Adding pages
355 | 
356 | To add pages, write them into the [pages](pages) folder. 
357 | You define urls based on the `permalink` attribute in your pages,
358 | and then add them to the navigation by adding to the content of [_data/toc.yml](_data/toc.yml).
359 | 
360 | #### Tags
361 | 
362 | If you include tags on a page, by default they will link to the [tags page]({{ site.url }}{{ site.baseurl }}/tags) on the site. However, if you define a `tag_search_endpoint` url in your configuration file, by clicking
363 | the tag, the user will be taken to this page to search for it. As an example,
364 | we define the current search endpoint to be Ask Cyberinfrastructure, and
365 | page tags link to a search on it:
366 | 
367 | ```yaml
368 | tag_search_endpoint: https://ask.cyberinfrastructure.org/search?q=
369 | tag_color: danger # danger, success, warning, primary, secondary, info
370 | ```
371 | 
372 | Note that you can also choose a color! The tags appear at the top of the page,
373 | as they do on this page. The tags should be defined like this in the front end
374 | matter:
375 | 
376 | ```yaml
377 | tags: 
378 |  - jekyll
379 |  - github
380 | ```
381 | 
382 | They are appended to the first h1 block, so generally your pages should have a header.
383 | If you comment out this variable, then each of your tags will link to it's appropriate
384 | spot on the tags page linked above.
385 | 
386 | ```yaml
387 | #tag_search_endpoint: https://ask.cyberinfrastructure.org/search?q=
388 | tag_color: primary # danger, success, warning, primary, info, secondary
389 | ```
390 | 
391 | 


--------------------------------------------------------------------------------
/_docs/subfolder.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | title: The Subfolder Page
 3 | description: An example of a subfolder page.
 4 | ---
 5 | 
 6 | # A Subfolder Page.
 7 | 
 8 | This is an example of a page that doesn't have a permalink defined, and
 9 | is not included in the table of contents (`_data/toc.yml`).
10 | 


--------------------------------------------------------------------------------
/_docs/subfolder/example-page.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | title: A Nested Page
 3 | description: An example of a nested page in a subfolder.
 4 | ---
 5 | 
 6 | # A Nested Page
 7 | 
 8 | This is an example of a page that doesn't have a permalink defined, and
 9 | is not included in the table of contents (`_data/toc.yml`).
10 | 


--------------------------------------------------------------------------------
/_docs/versioning.md:
--------------------------------------------------------------------------------
  1 | ---
  2 | title: Versioning your Docs
  3 | description: How to turn on and use versioning
  4 | ---
  5 | 
  6 | # Versioning
  7 | 
  8 | Versioning documentation is a useful feature that can be achieved using Docsy Jekyll. It allows you to take snapshots of your documentation that may align with a specific version of a product or service, or you may wish to just keep a historical view of the changes that have been made to your documents over time.
  9 | 
 10 | {% include alert.html type="info" title="Note: This only allows you to version documents inside the _docs folder, it does not allow you to version any files outside of that, such as Pages, Posts etc." %}
 11 | 
 12 | The following information will take you through the detailed setup of versioning your documentation but in summary there will be four tasks that need to be completed to version your documents.
 13 | 
 14 | 1. Copy the current _docs content into a subfolder of _docs/Archive (e.g., within a folder named by the version)
 15 | 2. Add a corresponding table of contents to _data/versions
 16 | 3. Update the _data/toc-mapping.yml file to point the new table of contents
 17 | 4. Test your site locally to ensure it works as expected!
 18 | 
 19 | ## Implementation
 20 | 
 21 | The way in which versioning is achieved is by duplicating your whole document directory and placing it inside an 'archive' subdirectory with the name of that version. The following illustrates what the base document root looks like *without* another version for this Docsy Jekyll site.
 22 | 
 23 | ```
 24 | document root
 25 | │      
 26 | └─── _data
 27 | └─── _docs
 28 |         └─── extras
 29 |         └─── subfolder
 30 |         example-page.md
 31 |         getting-started.md
 32 |         subfolder.md
 33 |         versioning.md
 34 | ```
 35 | To create a version of this documentation we first create a folder with the version name we want to use inside of the 'archive' folder and copy all the files and folders from our root _docs folder into that new folder. You could use the following commands to achieve this:
 36 | 
 37 | ```shell
 38 | # Our last release is version "Previous" (could also be 1.0.0 or semver), we are pinning the docs to this version`
 39 | mkdir -p _docs/Archive/Previous
 40 | # copy all content under _docs except Archive into this new folder.`
 41 | cp -r _docs/!(Archive) _docs/Archive/Previous
 42 | ```
 43 | 
 44 | After we do this, we end up with a structure shown below - the older documentation is moved into the folder 'Previous'. This step effectively takes a snapshot of our documents at a point in time and the expectation is that we will no longer maintain these pages. If you look at the structure of this site you will see the 'Previous' folder, which now holds our previous documentation, does not contain the versioning.md markdown file as this is new in the current release. This means that if you look at this page on the current site and then choose "Previous" from the version dropdown, you will get a 404 error (not found).
 45 | 
 46 | <pre><code>
 47 | document root
 48 | │      
 49 | └─── _data
 50 | └─── _docs
 51 |         └─── extras
 52 |         └─── subfolder
 53 |         └─── Archive
 54 |               └─── <span style="color:blue;"><b>Previous</b></span>
 55 |                   └─── extras
 56 |                   └─── subfolder
 57 |                   example-page.md
 58 |                   getting-started.md
 59 |                   subfolder.md
 60 |         example-page.md
 61 |         getting-started.md
 62 |         subfolder.md
 63 |         versioning.md
 64 | </code></pre>
 65 | 
 66 | You would now continue to add, update or remove markdown files from the main _docs directory in order to work on the current version of your documentation. 
 67 | 
 68 | Once the versioning has been correctly configured and you have created a snapshot, you can access those documents by adding the version to the url to access that archived version (e.g. /docs/Archive/Previous/getting-started). 
 69 | 
 70 | To enable the users to interact with these versioned documents through the UI there needs to be some updates to the _config.yml file to setup and enable it. The following is a snippet from the _config.yml file specific to the versioning options that are available.
 71 | 
 72 | ```yml
 73 | version_params:
 74 |   version_menu: "Release"
 75 |   version_dir: Archive
 76 |   tocversion_dir: versions
 77 |   versioning: true
 78 |   latest: current
 79 |   allow_search: true  
 80 |   search_versions:
 81 |     - main
 82 |     - current
 83 |     - beta
 84 |   versions:
 85 |     - main
 86 |     - current
 87 |     - beta
 88 |     - v3.1
 89 |     - v3.0.1
 90 |     - v3.0
 91 |     - v2.4.5
 92 |     - v2.4.4
 93 | ```
 94 | 
 95 | ### Versioning Options
 96 | 
 97 | 
 98 | | Parameter | Description | Values |
 99 | | --------- | ----------- | ------ | 
100 | | versioning | This determines whether the versioning functionality is enabled | true \| false 
101 | | version_menu | In addition to the version dropdown you can specify some text to display alongside it<br/> If you do not wish to use this then make this value an empty string | Release
102 | | version_dir | This is the directory where all the alternative versions of the documentation will be contained beneath the _docs directory <br/>i.e. setting this to the value of Archive (Note: **No** trailing slash) will mean all alternative versions will be found in _docs/Archive/ | Archive
103 | |  tocversion_dir | This is the directory inside your _data directory where Docsy Jekyll will find the alternative TOC files that are used for other versions of the documentation. You can configure this to be whatever name you like, just ensure your other TOCs can be found there! | versions 
104 | | latest | From the list of versions this determines the one which relates to your base docs directory.<br/> Note the url for your docs will not contain a version identifier for this particular version| current \| v3.1
105 | | allow_search | A boolean to indicate if we should allow searching over versions. If False, only the current is displayed in results | true \| false 
106 | | search_version | A list of versions to include in the search. Current or latest will be tagged with the site.tag_color, the rest will be gray | current \| previous
107 | | versions | A list of versions you wish to display in the version dropdown <br/> Note that there are several special keywords that can be used: current, main, alpha, beta, rc and pre, see below for more details  | current \| v1.0 \| v2.1.3
108 | 
109 | {% include alert.html type="warning" title="Note: The versions listed must have the same name as the folder name in which that version of the documentation resides otherwise jekyll it will not find it! The exception is the version 'current' which does not have a separate folder and is used to inform jekyll to utilize the base _docs folder." %}
110 | 
111 | ### Version Keywords
112 | There are six special keywords that can be used in the versions config.
113 | * main
114 | * alpha
115 | * beta
116 | * rc
117 | * pre
118 | * *current*
119 | 
120 | The value **main**, is used to display the latest development version of the documentation, a banner is used to denote that the code and documentation maybe unstable and that they are not guaranteed to be correct or up to date and could change at any time.
121 | 
122 | The value of **alpha**, **beta**, **rc** and **pre** are used to denote that the documentation is a pre-production version and as such a banner is displayed announcing that the code/documentation maybe unstable and the content in the pages are still work in progress so may not be completely up to date or correct.
123 | 
124 | If you wish to utilize this feature then you must create folders within your _docs/*Archive* directory with the names of those you wish to use and place your documentation inside it/them.
125 | 
126 | The value of **current** is used to align with the latest version of your documentation in your base _docs folder so there **doesn't** need to be a specific folder created and named 'current' to serve them. The name 'current', for the value of 'latest' in the previous example, can be changed to whatever you wish to name the current release but be aware that the version set in the _config.yml file also needs to match it! See the example below where we have called the latest release v3.2 rather than 'current' and we also have a version exactly named v3.2 too, as mentioned this version will point to your base _docs directory. 
127 | 
128 | ```yml
129 | version_params:
130 |   version_menu: "Release"
131 |   version_dir: Archive
132 |   tocversion_dir: versions
133 |   versioning: true
134 |   latest: v3.2
135 |   versions:
136 |     - main
137 |     - v3.2
138 |     - beta
139 |     - v3.1
140 | ```
141 | 
142 | ### Configuring Version Alerts
143 | 
144 | Depending on the version keywords you may use Docsy Jekyll tries to determine if the documentation is historical (e.g. out of date) or is a upcoming release of information and will show one of the following banners to alert users to the fact that they are not reviewing the current version of the documentation. 
145 | 
146 | |![Historical Versions]({{ site.baseurl }}/assets/img/versionalertoutdated.png)|
147 | |:--:| 
148 | | *This banner is shown for historical versions of your documentation* |
149 | 
150 | |![Beta Versions]({{ site.baseurl }}/assets/img/versionalertbeta.png)|
151 | |:--:| 
152 | | *This banner is shown for pre-production versions of your documentation* |
153 | 
154 | |![Development Versions]({{ site.baseurl }}/assets/img/versionalertmain.png)|
155 | |:--:| 
156 | | *This banner is shown for development versions of your documentation* |
157 | 
158 | These banners can be customised to have the wording or imagery you require by altering the HTML in the _includes/versionalert.html file.
159 | 
160 | ## Table of Contents Handling (TOC)
161 | 
162 | As with the documents, your TOC contents also need to be updated so they correctly point to the document versions you are viewing.
163 | 
164 | You will need to update the toc file as the structure of your documentation/toc changes over time but as we have taken a snapshot of our documentation so we need to do the same thing for our toc so it reflects the document structure at that point in time too. You will see that for this site we have the versions of Current and Previous and you will see that the Current version has all the information about versioning which didn't exist in the prior version.
165 | 
166 | To enable the TOC to change based on the version, we have to create a new toc file and name it {version}-toc.yml and it must be placed in a subdirectory of _data whose name is specified by the tocversion_dir parameter in the _config.yml file (for this site it can be found in the _data/versions subdirectory). We have created previous-toc.yml in the _data/versions directory that has the TOC structure for the prior version where we did not have the versioning.md file present. 
167 | 
168 | 
169 | To create this version of the toc file file we can use the following commands
170 | ```shell
171 | # Our last release is version "Previous" so we want to create a TOC for that inside our versions directory
172 | mkdir -p _data/versions
173 | # copy the existing TOC file to our version subdirectory and name it as {version}-toc.yml
174 | cp  _data/toc.yml _data/versions/previous-toc.yml
175 | ```
176 | 
177 | 
178 | {% include alert.html type="info" title="Note: The toc.yml file will always be our current table of contents pointing to the most recent version of the documentation in the base of our _docs folder. When adding additional items to your toc.yml file you do not need to worry about the version identifier as that is taken care of by Docsy Jekyll when viewing alternative versions, continue to have the urls pointing to the files in the base docs directory." %}
179 | 
180 | Here is what our current toc.yml file in our _data directory looks like, the previous-toc.yml file will look identical apart from omitting the 'Versioning' title and link which was added for this release, and of course will live in the versions subdirectory of _data as well.
181 | 
182 | ```yml
183 | title: Documentation
184 |   url: docs
185 |   links:
186 |     - title: "Getting Started"
187 |       url: "docs/getting-started"
188 |       children:
189 |         - title: Features
190 |           url: "docs/getting-started#getting-started"
191 |         - title: Development
192 |           url: "docs/getting-started#development"
193 |         - title: Customization
194 |           url: "docs/getting-started#customization"
195 |     - title: Versioning
196 |       url: "docs/versioning"
197 |     - title: "About"
198 |       url: "about"
199 |     - title: "News"
200 |       url: "news"
201 | - title: "Extras"
202 |   url: "docs/extras"
203 |   links:
204 |     - title: Quizzes
205 |       url: "docs/extras/example-quiz"
206 |     - title: Tags Page
207 |       url: "tags"
208 | ```
209 | 
210 | Now not every version of your documentation will have a change in structure and therefore require an update to toc.yml. To remove this overhead a mapping file is used to tell Docsy Jekyll which TOC it should use for a particular version,
211 | the benefit of this is that if the structure of your site does not change then you do not need to create an additional toc.yml file.
212 | 
213 | You will have a toc-mapping.yml file in your _data directory and the contents will contain the code below to map a particular version with a particular TOC file to use. You need to update this file for each version you create even if you do not need to create a new TOC file.
214 | 
215 | ```yml
216 | # This file can be used to explicitly map a release to a specific table-of-contents
217 | # (TOC). You'll want to use this after any revamps to information architecture, to ensure
218 | # that the navigation for older versions still works.
219 | 
220 | Current: toc
221 | Previous: previous-toc
222 | ```
223 | **You do not need to prefix the name of the new TOC filename with the folder (in our case versions) as Docsy Jekyll will retrieve that from the _config.yml file and add that to the path.**  
224 | 
225 | {% include alert.html type="info" title="Note: If a version cannot be found in this mapping file then the standard toc.yml in the _data directory will be used instead." %}
226 | 
227 | Because we added the versioning.md markdown file to this site we needed a new toc so that this new content could be accessed from the TOC menu. If we had only made an update to the content of the files that already existed, then we could have pointed Previous to toc in the yml above to use the same toc.yml file.
228 | 
229 | ## Versioning and Search
230 | 
231 | As you will have seen in the [Versioning Options](#versioning-options) you have the ability to configure Docsy Jekyll to perform it's searches over the entire site's documentation, or only certain versions which you can specify. If you choose not to enable it in _config.yml (allow_search = false) then the searches that get performed will only be over the most current version of the documentation in your base _docs folder. If you prefer to have this enabled then you will need to provide a list of search versions (search_version in _config.yml) that you wish to be displayed if a match is found. The following image shows what your users would be shown if you have this enabled. You can see that the search was for the term 'start' and we have several results returned but two both for the 'Getting Started' topic. The reason for this is due to a result being returned within the current version as well as a result being returned for the previous version as denoted by the badges of 'Current' and 'Previous' below the titles. 
232 | 
233 | 
234 | | *Searching with Versioning enabled*|
235 | |:--:|
236 | |![Search with Versions]({{ site.baseurl }}/assets/img/docsy-jekyll-version-search.png)
237 | 
238 | 
239 | ## Issues with Permalinks
240 | 
241 | Please do not use permalinks in your archive documentation Front Matter if you wish to use versioning as this will break the versioning system. If you have permalinks in your current documentation you will need to remove them when you place the documents into a subdirectory so that Jekyll can serve them correctly. 
242 | 
243 | {% include alert.html type="warning" title="Using permalinks in your archive documentation Front Matter will cause issues with versioning as this effectively 'hardcodes' the url of that page and will break the versioning links. Please be aware!" %}
244 | 
245 | ## 404 Errors
246 | 
247 | There will be times where users will navigate around the documentation and could end up pointing to an invalid page that doesn't exist. For instance while you are reading this page on the **Current** version if you were to change this to the Previous version, via the dropdown, then you will get a page not found as this versioning page did not exist in the prior version. We have created a 404.md page in the base of the site so that the user still gets to navigate even though the page was not found. You can update this page with your own information should you so wish.
248 | 
249 | {% include alert.html type="info" title="When pages are not found and the 404 page is displayed the TOC menus default back to links pointing to the current release." %}
250 | 


--------------------------------------------------------------------------------
/_includes/alert.html:
--------------------------------------------------------------------------------
1 | <div class="alert alert-{{ include.type }}" role="alert">
2 | <h4 class="alert-heading">{% if include.title %}{{ include.title }}{% else %}{{ include.type }}{% endif %}</h4>
3 | {{ include.content }}
4 | </div>
5 | 


--------------------------------------------------------------------------------
/_includes/doc.html:
--------------------------------------------------------------------------------
1 | <a href="{{ site.baseurl }}/docs/{{ include.path }}">{% if include.name %}{{ include.name }}{% else %}{{ include.path }}{% endif %}</a>
2 | 


--------------------------------------------------------------------------------
/_includes/editable.html:
--------------------------------------------------------------------------------
1 | <a href="{{ site.repo }}/edit/{% if site.github_branch %}{{ site.github_branch }}{% else %}master{% endif %}/{{ page.path }}" target="_blank"><i class="fa fa-edit fa-fw"></i> Edit this page</a>
2 | <a href="{{ site.repo }}/issues/new?labels={% if page.editable %}{{ page.editable }}{% else %}question{% endif %}&title=Question:&body=Question on: {{ site.repo }}/tree/master/{{ page.path }}" target="_blank"><i class="fab fa-github fa-fw"></i> Create documentation issue</a>
3 | <a href="{{ site.repo }}/issues/new" target="_blank"><i class="fas fa-tasks fa-fw"></i> Create project issue</a>
4 | <!-- this will parse through the header fields and add a button to open
5 |      an issue / ask a question on Github. The editable field should be in
6 |      the post frontend matter, and refer to the label to open the issue for -->
7 | 


--------------------------------------------------------------------------------
/_includes/feedback.html:
--------------------------------------------------------------------------------
 1 | {% if site.feedback %}<style>
 2 |   .feedback--answer {
 3 |     display: inline-block;
 4 |   }
 5 |   .feedback--answer-no {
 6 |     margin-left: 1em;
 7 |   }
 8 |   .feedback--response {
 9 |     display: none;
10 |     margin-top: 1em;
11 |   }
12 |   .feedback--response__visible {
13 |     display: block;
14 |   }
15 | </style>
16 | <h5 class="feedback--title">Feedback</h5>
17 | <p class="feedback--question">Was this page helpful?</p>
18 | <button class="feedback--answer feedback--answer-yes">Yes</button>
19 | <button class="feedback--answer feedback--answer-no">No</button>
20 | <p class="feedback--response feedback--response-yes">
21 |   Glad to hear it! Please <a href="{{ site.repo }}/issues/new">tell us how we can improve</a>.
22 | </p>
23 | <p class="feedback--response feedback--response-no">
24 |   Sorry to hear that. Please <a href="{{ site.repo  }}/issues/new">tell us how we can improve</a>.
25 | </p>
26 | <script>
27 |   const yesButton = document.querySelector('.feedback--answer-yes');
28 |   const noButton = document.querySelector('.feedback--answer-no');
29 |   const yesResponse = document.querySelector('.feedback--response-yes');
30 |   const noResponse = document.querySelector('.feedback--response-no');
31 |   const disableButtons = () => {
32 |     yesButton.disabled = true;
33 |     noButton.disabled = true;
34 |   };
35 |   const sendFeedback = (value) => {
36 |     if (typeof ga !== 'function') return;
37 |     const args = {
38 |       command: 'send',
39 |       hitType: 'event',
40 |       category: 'Helpful',
41 |       action: 'click',
42 |       label: window.location.pathname,
43 |       value: value
44 |     };
45 |     ga(args.command, args.hitType, args.category, args.action, args.label, args.value);
46 |   };
47 |   yesButton.addEventListener('click', () => {
48 |     yesResponse.classList.add('feedback--response__visible');
49 |     disableButtons();
50 |     sendFeedback(1);
51 |   });
52 |   noButton.addEventListener('click', () => {
53 |     noResponse.classList.add('feedback--response__visible');
54 |     disableButtons();
55 |     sendFeedback(0);
56 |   });
57 | </script>{% endif %}<br/>
58 | 
59 | 


--------------------------------------------------------------------------------
/_includes/footer.html:
--------------------------------------------------------------------------------
 1 | <footer class="bg-dark py-5 row d-print-none">
 2 |   <div class="container-fluid mx-sm-5">
 3 |     <div class="row">
 4 |       <div class="col-6 col-sm-4 text-xs-center order-sm-2">
 5 |         <ul class="list-inline mb-0">  
 6 |           {% if site.twitter %}
 7 |             <li class="list-inline-item mx-2 h3" data-toggle="tooltip" data-placement="top" title="" aria-label="Twitter" data-original-title="Twitter">
 8 |               <a class="text-white" target="_blank" href="https://twitter.com/{{ site.twitter }}">
 9 |                 <i class="fab fa-twitter"></i>
10 |               </a>
11 |             </li>
12 |           {% endif %}
13 |           {% if site.linkedin %}
14 |             <li class="list-inline-item mx-2 h3" data-toggle="tooltip" data-placement="top" title="" aria-label="LinkedIn" data-original-title="LinkedIn">
15 |               <a class="text-white" target="_blank" href="https://linkedin.com/in/{{ site.linkedin }}">
16 |                 <i class="fab fa-linkedin"></i>
17 |               </a>
18 |             </li>
19 |           {% endif %}
20 |         </ul>
21 |       </div>
22 |       <div class="col-6 col-sm-4 text-right text-xs-center order-sm-3">
23 |         <ul class="list-inline mb-0">  
24 |           <li class="list-inline-item mx-2 h3" data-toggle="tooltip" data-placement="top" title="" aria-label="GitHub" data-original-title="GitHub">
25 |             <a class="text-white" target="_blank" href="{{ site.repo }}">
26 |               <i class="fab fa-github"></i>
27 |             </a>
28 |           </li>
29 |         </ul>
30 |       </div>
31 |       <div class="col-12 col-sm-4 text-center py-2 order-sm-2">
32 |         <small class="text-white">© {{ 'now' | date: "%Y" }} {{ site.author }} All Rights Reserved</small>
33 |         {% if site.privacy %}<small class="ml-1"><a href="{{ site.privacy }}" target="_blank">Privacy Policy</a></small>{% endif %}
34 |         <p class="mt-2"><a href="/about/">About Docsy</a></p>	
35 |       </div>
36 |     </div>
37 |   </div>
38 | </footer>
39 | 


--------------------------------------------------------------------------------
/_includes/google-analytics.html:
--------------------------------------------------------------------------------
 1 | {% if site.google-analytics %}<script async src='https://www.google-analytics.com/analytics.js'></script>
 2 | <script type="application/javascript">
 3 | var doNotTrack = false;
 4 | if (!doNotTrack) {
 5 | 	window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)};ga.l=+new Date;
 6 | 	ga('create', '{{ site.google-analytics }}', 'auto');
 7 | 	ga('send', 'pageview');
 8 | }
 9 | </script>{% endif %}
10 | 


--------------------------------------------------------------------------------
/_includes/head.html:
--------------------------------------------------------------------------------
 1 | <head>
 2 | <meta charset="utf-8">
 3 | <!-- Copyright 2019-2021 Vanessa Sochat-->
 4 | 
 5 | <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
 6 | <meta name="generator" content="Hugo 0.55.6" />
 7 | 
 8 | <META NAME="ROBOTS" CONTENT="INDEX, FOLLOW">
 9 | 
10 | <link rel="alternate" type="application/rss&#43;xml" href="/docs/index.xml">
11 | 
12 | <link rel="shortcut icon" href="{{ site.baseurl }}/assets/favicons/favicon.ico" >
13 | <link rel="apple-touch-icon" href="{{ site.baseurl }}/assets/favicons/apple-touch-icon-180x180.png" sizes="180x180">
14 | <link rel="icon" type="image/png" href="{{ site.baseurl }}/assets/favicons/favicon-16x16.png" sizes="16x16">
15 | <link rel="icon" type="image/png" href="{{ site.baseurl }}/assets/favicons/favicon-32x32.png" sizes="32x32">
16 | <link rel="icon" type="image/png" href="{{ site.baseurl }}/assets/favicons/android-icon-36x36.png" sizes="36x36">
17 | <link rel="icon" type="image/png" href="{{ site.baseurl }}/assets/favicons/android-icon-48x48.png" sizes="48x48">
18 | <link rel="icon" type="image/png" href="{{ site.baseurl }}/assets/favicons/android-icon-72x72.png" sizes="72x72">
19 | <link rel="icon" type="image/png" href="{{ site.baseurl }}/assets/favicons/android-icon-96x196.png" sizes="96x196">
20 | <link rel="icon" type="image/png" href="{{ site.baseurl }}/assets/favicons/android-icon-144x144.png" sizes="144x144">
21 | <link rel="icon" type="image/png" href="{{ site.baseurl }}/assets/favicons/android-icon-192x192.png"sizes="192x192">
22 | 
23 | <title>{% if page.title %}{{ page.title }}{% else %}{{ site.title }}{% endif %}</title>
24 | <meta property="og:title" content="{% if page.title %}{{ page.title }}{% else %}{{ site.title }}{% endif %}" />
25 | <meta property="og:description" content="{% if page.description %}{{ page.description }}{% else %}{{ site.description }}{% endif %}" />
26 | <meta property="og:type" content="website" />
27 | <meta property="og:url" content="{{ site.url }}" />
28 | <meta property="og:site_name" content="{{ site.url }}" />
29 | 
30 | <meta itemprop="name" content="{% if page.title %}{{ page.title }}{% else %}{{ site.title }}{% endif %}">
31 | <meta itemprop="description" content="{% if page.description %}{{ page.description | strip_html | strip_newlines | truncate: 160 }}{% else %}{{ site.description }}{% endif %}">
32 | 
33 | <meta name="twitter:card" content="summary"/>
34 | <meta name="twitter:title" content="{% if page.title %}{{ page.title }}{% else %}{{ site.title }}{% endif %}"/>
35 | <meta name="twitter:description" content="{% if page.description %}{{ page.description | strip_html | strip_newlines | truncate: 160 }}{% else %}{{ site.description }}{% endif %}"/>
36 | 
37 | <link rel="stylesheet" href="{{ site.baseurl }}/assets/css/main.css">
38 | <link rel="stylesheet" href="{{ site.baseurl }}/assets/css/palette.css">
39 | <script
40 |   src="{{ site.baseurl }}/assets/js/jquery-3.3.1/jquery-3.3.1.min.js"
41 |   integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8= sha256-T+aPohYXbm0fRYDpJLr+zJ9RmYTswGsahAoIsNiMld4="
42 |   crossorigin="anonymous"></script>
43 | </head>
44 | 


--------------------------------------------------------------------------------
/_includes/header.html:
--------------------------------------------------------------------------------
 1 | <header>
 2 |         <nav class="js-navbar-scroll navbar navbar-expand navbar-dark flex-column flex-md-row td-navbar">
 3 |         <a class="navbar-brand" href="{{ site.baseurl }}/">
 4 |             <span class="navbar-logo"></span>{% include logo.svg %}<span class="text-uppercase font-weight-bold">{{ site.title }}</span>
 5 | 	</a>
 6 | 	<div class="td-navbar-nav-scroll ml-md-auto" id="main_navbar">
 7 | 		<ul class="navbar-nav mt-2 mt-lg-0">{% if site.repo %}
 8 | 			<li class="nav-item mr-4 mb-2 mb-lg-0">
 9 |                             <a class="nav-link" href="{{ site.repo }}" target="_blank"><span>GitHub</span></a>
10 | 			</li>{% endif %}{% for link in site.data.navigation %}
11 | 			<li class="nav-item mr-4 mb-2 mb-lg-0">
12 |                             <a class="nav-link" href="{% if link.url %}{{ site.baseurl }}/{{ link.url }}{% else %}{{ link.external_url }}{% endif %}" ><span>{{ link.title }}</span></a>
13 | 			</li>{% endfor %}
14 |       {% if site.version_params.versioning == true %}
15 |       <!-- <li class="nav-item mr-4 mb-2 mb-lg-0"> -->
16 |         {% if site.version_params.version_menu != '' %}
17 |           <span class="nav-link ">{{site.version_params.version_menu}}:</span>
18 |         {% endif %}
19 |         <li class="nav-item dropdown d-none d-lg-block">
20 |           <a class="nav-link dropdown-toggle" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">{{ currentpageversion }}</a>
21 |           <div class="dropdown-menu" aria-labelledby="navbarDropdownMenuLink">
22 |             {% for version in site.version_params.versions %}
23 |             {% capture civersion %}
24 |               {{ version | downcase}}
25 |             {% endcapture %}
26 |               {% if version == site.version_params.latest %}
27 |                 <a class="dropdown-item" href="{{ site.baseurl }}{{ latestversion }}">{{version}}</a>
28 |               {% else %}
29 |                 {% if site.version_params.version_dir != "" %}
30 |                   {% assign versionlink = '/docs/' | append: site.version_params.version_dir | append: '/' | append: version | append: '/' %}
31 |                 {% else %}
32 |                   {% assign versionlink = '/docs/' | append: version | append: '/' %}
33 |                 {% endif %}
34 |                 <a class="dropdown-item" href="{{ site.baseurl }}{{ latestversion | replace: '/docs/', versionlink }}">{{version}}</a>
35 |               {% endif %}
36 |             {% endfor %}
37 |           </div>
38 |         </li>
39 |       <!-- </li> -->
40 |       {% endif %}
41 | 		</ul>
42 | 	</div>
43 | 	<div class="navbar-nav d-none d-lg-block">
44 |  <input type="search" class="form-control td-search-input" placeholder="&#xf002 Search this site…" aria-label="Search this site…" autocomplete="off">
45 |         </div>
46 | 
47 | 	<div class="navbar-nav d-none d-lg-block">
48 |           <a class="gh-source" data-gh-source="github" href="{{ site.repo }}" title="Go to repository" data-md-state="done">
49 |           <div class="gh-source__repository">
50 |             <i class="fab fa fa-github fa-2x" style='padding-right:20px; float:left; margin-top:5px'></i>
51 |             {{ site.github_user }}/{{ site.github_repo }}
52 |           <ul class="gh-source__facts"><li class="gh-source__fact" id='stars'></li><li id="forks" class="gh-source__fact"></li></ul></div></a>
53 |         </div>
54 |       </div>
55 | 
56 | 
57 | </nav>
58 | </header>
59 | 
60 | <script>
61 | $(document).ready(function() {
62 |   var url = "https://api.github.com/search/repositories?q={{ site.github_user }}/{{ site.github_repo }}";
63 |   fetch(url, { 
64 |       headers: {"Accept":"application/vnd.github.preview"}
65 |   }).then(function(e) {
66 |     return e.json()
67 |   }).then(function(r) {
68 |      console.log(r.items[0])
69 |      stars = r.items[0]['stargazers_count']
70 |      forks = r.items[0]['forks_count']
71 |      $('#stars').text(stars + " Stars")
72 |      $('#forks').text(forks + " Forks")
73 |   });
74 | });
75 | </script>
76 | 


--------------------------------------------------------------------------------
/_includes/logo.svg:
--------------------------------------------------------------------------------
1 | <svg id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 500 500" style="enable-background:new 0 0 500 500"><g><path style="fill:#fff" d="M116.8525 421.9722c-5.7041.0-10.3442-4.3127-10.3442-9.6129V88.183c0-5.3002 4.6401-9.6117 10.3442-9.6117H320.858c3.0347.0 9.3959.5498 11.7506 2.6302l.3545.3442 58.905 63.2912c2.3101 2.491 2.9202 8.4928 2.9202 11.3184v256.2039c0 5.3002-4.6407 9.6129-10.3436 9.6129H116.8525z"/><g><g><g><path style="fill:#767676" d="M384.4445 423.2066H116.852c-6.3839.0-11.5786-4.8658-11.5786-10.8474V88.1831c0-5.9804 5.1947-10.8461 11.5786-10.8461h204.0062c.377.0 9.2786.0329 12.568 2.9389l.3947.3833 58.9508 63.337c3.2135 3.4652 3.2514 11.7924 3.2514 12.1593v256.2036C396.0231 418.3408 390.8284 423.2066 384.4445 423.2066zM116.5079 411.9189c.0848.0278.1999.0531.3441.0531h267.5925c.1442.0.2581-.0253.3441-.0531V156.1556c-.0076-.9033-.3593-3.7347-.7034-5.0037l-57.6527-61.9416c-1.4651-.3176-4.4533-.6389-5.5742-.6389H116.852c-.143.0-.2594.024-.3441.0531V411.9189zm267.4533-261.149v0 0zM327.0321 89.371v.0013V89.371z"/></g></g></g><g><g><path style="fill:#5b7fc0" d="M189.0874 210.1754l.0012-.0012c7.7751.0012 15.0295 4.1862 18.932 10.9234 1.9177 3.3159 2.9305 7.1011 2.9293 10.9378.0 5.8394-2.2733 11.3304-6.4032 15.4604-4.1288 4.1288-9.6186 6.4032-15.458 6.4032-5.8394.0-11.328-2.2733-15.458-6.4032s-6.4032-9.6186-6.4056-15.4628c.0012-6.025 2.454-11.4897 6.4116-15.4473C177.5953 212.627 183.0601 210.1742 189.0874 210.1754zM197.0804 232.033c.0012-1.4042-.3687-2.7868-1.063-3.9887-1.4293-2.4684-4.0833-3.9995-6.9299-4.0019-4.4077.0024-7.993 3.5877-7.993 7.993.0 2.1356.832 4.1431 2.3427 5.6539 1.5083 1.5083 3.5159 2.3403 5.6503 2.3415 2.1356.0 4.1443-.8308 5.6539-2.3403S197.0816 234.1722 197.0804 232.033z"/><path style="opacity:.3;fill:#fff" d="M189.0898 210.176c7.7763.0 15.0283 4.1826 18.926 10.9151 1.9201 3.3136 2.9377 7.0988 2.9353 10.9462.0024 12.0643-9.8065 21.8636-21.8613 21.8613-12.0547.0024-21.8636-9.8066-21.8612-21.8613.0-6.0285 2.4516-11.4921 6.4116-15.452C177.5977 212.6276 183.0612 210.176 189.0898 210.176zM197.0839 232.0372c0-1.4078-.3711-2.7892-1.0702-3.9959-1.4269-2.466-4.0797-3.9983-6.924-3.9983-4.4005-.0048-7.9918 3.5817-7.9942 7.9942.0024 4.4077 3.5865 7.9918 7.9942 7.9942 2.2027.0 4.2018-.8978 5.6479-2.3439C196.1861 236.239 197.0839 234.2399 197.0839 232.0372z"/><g><defs><path id="SVGID_1_" d="M194.7376 237.6875c-1.4461 1.4461-3.4452 2.3439-5.6479 2.3439-4.4077-.0024-7.9918-3.5865-7.9942-7.9942.0024-4.4125 3.5937-7.999 7.9942-7.9942 2.8443.0 5.497 1.5323 6.924 3.9983.6991 1.2067 1.0702 2.5881 1.0702 3.9959C197.0839 234.2399 196.1861 236.239 194.7376 237.6875z"/></defs><clipPath id="SVGID_2_"><use xlink:href="#SVGID_1_" style="overflow:visible"/></clipPath><path style="clip-path:url(#SVGID_2_);fill:#fff" d="M190.0704 225.0237c-4.4005-.0048-7.9918 3.5817-7.9942 7.9942.0011 1.9546.7088 3.7452 1.8782 5.1354-1.7447-1.4674-2.8575-3.663-2.8588-6.116.0024-4.4125 3.5936-7.999 7.9942-7.9942 2.3802-1e-4 4.616 1.0833 6.1218 2.8788C193.7885 225.7247 191.9774 225.0237 190.0704 225.0237z"/><path style="opacity:.13;clip-path:url(#SVGID_2_);fill:#020202" d="M190.0704 225.0237c-4.4005-.0048-7.9918 3.5817-7.9942 7.9942.0011 1.9546.7088 3.7452 1.8782 5.1354-1.7447-1.4674-2.8575-3.663-2.8588-6.116.0024-4.4125 3.5936-7.999 7.9942-7.9942 2.3802-1e-4 4.616 1.0833 6.1218 2.8788C193.7885 225.7247 191.9774 225.0237 190.0704 225.0237z"/></g><g><defs><path id="SVGID_3_" d="M189.0898 210.176c7.7763.0 15.0283 4.1826 18.926 10.9151 1.9201 3.3136 2.9377 7.0988 2.9353 10.9462.0024 12.0643-9.8065 21.8636-21.8613 21.8613-12.0547.0024-21.8636-9.8066-21.8612-21.8613.0-6.0285 2.4516-11.4921 6.4116-15.452C177.5977 212.6276 183.0612 210.176 189.0898 210.176zM197.0839 232.0372c0-1.4078-.3711-2.7892-1.0702-3.9959-1.4269-2.466-4.0797-3.9983-6.924-3.9983-4.4005-.0048-7.9918 3.5817-7.9942 7.9942.0024 4.4077 3.5865 7.9918 7.9942 7.9942 2.2027.0 4.2018-.8978 5.6479-2.3439C196.1861 236.239 197.0839 234.2399 197.0839 232.0372z"/></defs><clipPath id="SVGID_4_"><use xlink:href="#SVGID_3_" style="overflow:visible"/></clipPath><path style="clip-path:url(#SVGID_4_);fill:#5b7fc0" d="M172.6595 215.6045c-3.96 3.96-6.4116 9.4235-6.4116 15.452-.0024 12.0547 9.8066 21.8636 21.8613 21.8612 12.0547.0024 21.8636-9.797 21.8613-21.8612.0024-3.8475-1.0151-7.6326-2.9353-10.9462-3.8977-6.7324-11.1497-10.9151-18.926-10.9151C182.0806 209.1953 176.6171 211.647 172.6595 215.6045z"/></g></g><path style="fill:#5b7fc0" d="M198.8952 225.1043h122.6266v13.8671H198.8952z"/></g><g><path style="fill:#d95140" d="M189.0874 155.7611l.0012-.0012c7.7751.0012 15.0295 4.1862 18.932 10.9234 1.9177 3.3159 2.9305 7.1011 2.9293 10.9378.0 5.8394-2.2733 11.3304-6.4032 15.4604-4.1288 4.1288-9.6186 6.4032-15.458 6.4032-5.8394.0-11.328-2.2733-15.458-6.4032s-6.4032-9.6186-6.4056-15.4628c.0012-6.0249 2.454-11.4897 6.4116-15.4473C177.5953 158.2128 183.0601 155.7599 189.0874 155.7611zM197.0804 177.6188c.0012-1.4042-.3687-2.7868-1.063-3.9887-1.4293-2.4684-4.0833-3.9995-6.9299-4.0019-4.4077.0024-7.993 3.5877-7.993 7.993.0 2.1356.832 4.1431 2.3427 5.6539 1.5083 1.5083 3.5159 2.3403 5.6503 2.3415 2.1356.0 4.1443-.8308 5.6539-2.3403C196.2508 181.7667 197.0816 179.758 197.0804 177.6188z"/><path style="opacity:.3;fill:#fff" d="M189.0898 155.7617c7.7763.0 15.0283 4.1826 18.926 10.9151 1.9201 3.3135 2.9377 7.0987 2.9353 10.9462.0024 12.0643-9.8065 21.8636-21.8613 21.8613-12.0547.0024-21.8636-9.8066-21.8612-21.8613.0-6.0285 2.4516-11.4921 6.4116-15.452C177.5977 158.2134 183.0612 155.7617 189.0898 155.7617zM197.0839 177.623c0-1.4078-.3711-2.7892-1.0702-3.9959-1.4269-2.466-4.0797-3.9983-6.924-3.9983-4.4005-.0048-7.9918 3.5817-7.9942 7.9942.0024 4.4077 3.5865 7.9918 7.9942 7.9942 2.2027.0 4.2018-.8978 5.6479-2.3439C196.1861 181.8248 197.0839 179.8256 197.0839 177.623z"/><g><defs><path id="SVGID_5_" d="M194.7376 183.2733c-1.4461 1.4461-3.4452 2.3439-5.6479 2.3439-4.4077-.0024-7.9918-3.5865-7.9942-7.9942.0024-4.4125 3.5937-7.9989 7.9942-7.9942 2.8443.0 5.497 1.5323 6.924 3.9983.6991 1.2067 1.0702 2.5881 1.0702 3.9959C197.0839 179.8256 196.1861 181.8248 194.7376 183.2733z"/></defs><clipPath id="SVGID_6_"><use xlink:href="#SVGID_5_" style="overflow:visible"/></clipPath><path style="clip-path:url(#SVGID_6_);fill:#fff" d="M190.0704 170.6095c-4.4005-.0048-7.9918 3.5817-7.9942 7.9942.0011 1.9546.7088 3.7452 1.8782 5.1354-1.7447-1.4674-2.8575-3.663-2.8588-6.116.0024-4.4125 3.5936-7.999 7.9942-7.9942 2.3802-1e-4 4.616 1.0833 6.1218 2.8788C193.7885 171.3104 191.9774 170.6095 190.0704 170.6095z"/><path style="opacity:.13;clip-path:url(#SVGID_6_);fill:#020202" d="M190.0704 170.6095c-4.4005-.0048-7.9918 3.5817-7.9942 7.9942.0011 1.9546.7088 3.7452 1.8782 5.1354-1.7447-1.4674-2.8575-3.663-2.8588-6.116.0024-4.4125 3.5936-7.999 7.9942-7.9942 2.3802-1e-4 4.616 1.0833 6.1218 2.8788C193.7885 171.3104 191.9774 170.6095 190.0704 170.6095z"/></g><g><defs><path id="SVGID_7_" d="M189.0898 155.7617c7.7763.0 15.0283 4.1826 18.926 10.9151 1.9201 3.3135 2.9377 7.0987 2.9353 10.9462.0024 12.0643-9.8065 21.8636-21.8613 21.8613-12.0547.0024-21.8636-9.8066-21.8612-21.8613.0-6.0285 2.4516-11.4921 6.4116-15.452C177.5977 158.2134 183.0612 155.7617 189.0898 155.7617zM197.0839 177.623c0-1.4078-.3711-2.7892-1.0702-3.9959-1.4269-2.466-4.0797-3.9983-6.924-3.9983-4.4005-.0048-7.9918 3.5817-7.9942 7.9942.0024 4.4077 3.5865 7.9918 7.9942 7.9942 2.2027.0 4.2018-.8978 5.6479-2.3439C196.1861 181.8248 197.0839 179.8256 197.0839 177.623z"/></defs><clipPath id="SVGID_8_"><use xlink:href="#SVGID_7_" style="overflow:visible"/></clipPath><path style="clip-path:url(#SVGID_8_);fill:#d95140" d="M172.6595 161.1903c-3.96 3.96-6.4116 9.4235-6.4116 15.452-.0024 12.0547 9.8066 21.8636 21.8613 21.8613 12.0547.0024 21.8636-9.797 21.8613-21.8613.0024-3.8474-1.0151-7.6326-2.9353-10.9462-3.8977-6.7324-11.1497-10.9151-18.926-10.9151C182.0806 154.7811 176.6171 157.2327 172.6595 161.1903z"/></g><path style="fill:#d95140" d="M198.8952 170.69h122.6266v13.8671H198.8952z"/></g><g><g><path style="fill:#56a55c" d="M189.5379 264.6147l.0012-.0012c7.7751.0012 15.0294 4.1862 18.932 10.9235 1.9177 3.3159 2.9305 7.1011 2.9293 10.9378.0 5.8394-2.2733 11.3304-6.4032 15.4604-4.1288 4.1288-9.6186 6.4032-15.458 6.4032-5.8394.0-11.3281-2.2733-15.458-6.4032-4.13-4.13-6.4032-9.6186-6.4056-15.4628.0012-6.0249 2.454-11.4897 6.4116-15.4472C178.0458 267.0663 183.5105 264.6135 189.5379 264.6147zM197.5309 286.4723c.0012-1.4042-.3687-2.7868-1.063-3.9887-1.4293-2.4684-4.0833-3.9995-6.9299-4.0019-4.4077.0024-7.993 3.5877-7.993 7.993.0 2.1356.832 4.1431 2.3427 5.6538 1.5083 1.5083 3.5159 2.3403 5.6503 2.3415 2.1356.0 4.1443-.8308 5.6539-2.3403C196.7013 290.6202 197.5321 288.6115 197.5309 286.4723z"/><path style="opacity:.3;fill:#fff" d="M189.5403 264.6153c7.7763.0 15.0283 4.1826 18.926 10.9151 1.9201 3.3135 2.9377 7.0987 2.9353 10.9462.0024 12.0643-9.8065 21.8636-21.8613 21.8613-12.0547.0024-21.8636-9.8065-21.8612-21.8613.0-6.0285 2.4516-11.492 6.4116-15.452C178.0482 267.0669 183.5117 264.6153 189.5403 264.6153zM197.5344 286.4765c0-1.4078-.3711-2.7892-1.0702-3.9959-1.4269-2.466-4.0797-3.9983-6.924-3.9983-4.4005-.0048-7.9918 3.5817-7.9942 7.9941.0024 4.4077 3.5865 7.9918 7.9942 7.9942 2.2027.0 4.2018-.8978 5.6479-2.3439C196.6366 290.6783 197.5344 288.6792 197.5344 286.4765z"/><g><defs><path id="SVGID_9_" d="M195.1881 292.1268c-1.4461 1.4461-3.4452 2.3439-5.6479 2.3439-4.4077-.0024-7.9918-3.5865-7.9942-7.9942.0024-4.4125 3.5937-7.9989 7.9942-7.9941 2.8443.0 5.497 1.5323 6.924 3.9983.6991 1.2067 1.0702 2.5881 1.0702 3.9959C197.5344 288.6792 196.6366 290.6783 195.1881 292.1268z"/></defs><clipPath id="SVGID_10_"><use xlink:href="#SVGID_9_" style="overflow:visible"/></clipPath><path style="clip-path:url(#SVGID_10_);fill:#fff" d="M190.5209 279.463c-4.4005-.0048-7.9918 3.5817-7.9942 7.9941.0011 1.9547.7088 3.7452 1.8782 5.1354-1.7446-1.4674-2.8575-3.6631-2.8588-6.1161.0024-4.4125 3.5936-7.999 7.9942-7.9941 2.3802-1e-4 4.616 1.0833 6.1218 2.8788C194.239 280.164 192.4279 279.463 190.5209 279.463z"/><path style="opacity:.13;clip-path:url(#SVGID_10_);fill:#020202" d="M190.5209 279.463c-4.4005-.0048-7.9918 3.5817-7.9942 7.9941.0011 1.9547.7088 3.7452 1.8782 5.1354-1.7446-1.4674-2.8575-3.6631-2.8588-6.1161.0024-4.4125 3.5936-7.999 7.9942-7.9941 2.3802-1e-4 4.616 1.0833 6.1218 2.8788C194.239 280.164 192.4279 279.463 190.5209 279.463z"/></g><g><defs><path id="SVGID_11_" d="M189.5403 264.6153c7.7763.0 15.0283 4.1826 18.926 10.9151 1.9201 3.3135 2.9377 7.0987 2.9353 10.9462.0024 12.0643-9.8065 21.8636-21.8613 21.8613-12.0547.0024-21.8636-9.8065-21.8612-21.8613.0-6.0285 2.4516-11.492 6.4116-15.452C178.0482 267.0669 183.5117 264.6153 189.5403 264.6153zM197.5344 286.4765c0-1.4078-.3711-2.7892-1.0702-3.9959-1.4269-2.466-4.0797-3.9983-6.924-3.9983-4.4005-.0048-7.9918 3.5817-7.9942 7.9941.0024 4.4077 3.5865 7.9918 7.9942 7.9942 2.2027.0 4.2018-.8978 5.6479-2.3439C196.6366 290.6783 197.5344 288.6792 197.5344 286.4765z"/></defs><clipPath id="SVGID_12_"><use xlink:href="#SVGID_11_" style="overflow:visible"/></clipPath><path style="clip-path:url(#SVGID_12_);fill:#56a55c" d="M173.11 270.0439c-3.96 3.96-6.4116 9.4235-6.4116 15.452-.0024 12.0547 9.8066 21.8636 21.8613 21.8613 12.0547.0024 21.8636-9.797 21.8613-21.8613.0024-3.8474-1.0151-7.6326-2.9353-10.9462-3.8977-6.7325-11.1497-10.9151-18.926-10.9151C182.5311 263.6346 177.0676 266.0863 173.11 270.0439z"/></g></g><path style="fill:#56a55c" d="M199.3456 279.5436h122.6266v13.8671H199.3456z"/></g><g><g><path style="fill:#f1bc42" d="M189.0874 318.7208l.0012-.0012c7.7751.0012 15.0295 4.1862 18.932 10.9234 1.9177 3.3159 2.9305 7.1011 2.9293 10.9378.0 5.8394-2.2733 11.3305-6.4032 15.4604-4.1288 4.1288-9.6186 6.4032-15.458 6.4032-5.8394.0-11.328-2.2733-15.458-6.4032-4.13-4.1299-6.4032-9.6186-6.4056-15.4628.0012-6.025 2.454-11.4897 6.4116-15.4472C177.5953 321.1724 183.0601 318.7196 189.0874 318.7208zM197.0804 340.5784c.0012-1.4042-.3687-2.7868-1.063-3.9887-1.4293-2.4684-4.0833-3.9995-6.9299-4.0019-4.4077.0024-7.993 3.5877-7.993 7.993.0 2.1356.832 4.1431 2.3427 5.6539 1.5083 1.5083 3.5159 2.3403 5.6503 2.3415 2.1356.0 4.1443-.8308 5.6539-2.3403S197.0816 342.7176 197.0804 340.5784z"/><path style="opacity:.3;fill:#fff" d="M189.0898 318.7214c7.7763.0 15.0283 4.1826 18.926 10.915 1.9201 3.3136 2.9377 7.0988 2.9353 10.9462.0024 12.0643-9.8065 21.8636-21.8613 21.8612-12.0547.0024-21.8636-9.8065-21.8612-21.8612.0-6.0285 2.4516-11.4921 6.4116-15.452C177.5977 321.173 183.0612 318.7214 189.0898 318.7214zM197.0839 340.5826c0-1.4078-.3711-2.7892-1.0702-3.9959-1.4269-2.466-4.0797-3.9983-6.924-3.9983-4.4005-.0048-7.9918 3.5817-7.9942 7.9942.0024 4.4077 3.5865 7.9918 7.9942 7.9942 2.2027.0 4.2018-.8978 5.6479-2.3439C196.1861 344.7844 197.0839 342.7853 197.0839 340.5826z"/><g><defs><path id="SVGID_13_" d="M194.7376 346.2329c-1.4461 1.4461-3.4452 2.3439-5.6479 2.3439-4.4077-.0024-7.9918-3.5865-7.9942-7.9942.0024-4.4125 3.5937-7.999 7.9942-7.9942 2.8443.0 5.497 1.5323 6.924 3.9983.6991 1.2067 1.0702 2.5881 1.0702 3.9959C197.0839 342.7853 196.1861 344.7844 194.7376 346.2329z"/></defs><clipPath id="SVGID_14_"><use xlink:href="#SVGID_13_" style="overflow:visible"/></clipPath><path style="clip-path:url(#SVGID_14_);fill:#fff" d="M190.0704 333.5691c-4.4005-.0048-7.9918 3.5817-7.9942 7.9942.0011 1.9547.7088 3.7452 1.8782 5.1354-1.7447-1.4674-2.8575-3.6631-2.8588-6.1161.0024-4.4125 3.5936-7.999 7.9942-7.9942 2.3802-1e-4 4.616 1.0834 6.1218 2.8788C193.7885 334.2701 191.9774 333.5691 190.0704 333.5691z"/><path style="opacity:.13;clip-path:url(#SVGID_14_);fill:#020202" d="M190.0704 333.5691c-4.4005-.0048-7.9918 3.5817-7.9942 7.9942.0011 1.9547.7088 3.7452 1.8782 5.1354-1.7447-1.4674-2.8575-3.6631-2.8588-6.1161.0024-4.4125 3.5936-7.999 7.9942-7.9942 2.3802-1e-4 4.616 1.0834 6.1218 2.8788C193.7885 334.2701 191.9774 333.5691 190.0704 333.5691z"/></g><g><defs><path id="SVGID_15_" d="M189.0898 318.7214c7.7763.0 15.0283 4.1826 18.926 10.915 1.9201 3.3136 2.9377 7.0988 2.9353 10.9462.0024 12.0643-9.8065 21.8636-21.8613 21.8612-12.0547.0024-21.8636-9.8065-21.8612-21.8612.0-6.0285 2.4516-11.4921 6.4116-15.452C177.5977 321.173 183.0612 318.7214 189.0898 318.7214zM197.0839 340.5826c0-1.4078-.3711-2.7892-1.0702-3.9959-1.4269-2.466-4.0797-3.9983-6.924-3.9983-4.4005-.0048-7.9918 3.5817-7.9942 7.9942.0024 4.4077 3.5865 7.9918 7.9942 7.9942 2.2027.0 4.2018-.8978 5.6479-2.3439C196.1861 344.7844 197.0839 342.7853 197.0839 340.5826z"/></defs><clipPath id="SVGID_16_"><use xlink:href="#SVGID_15_" style="overflow:visible"/></clipPath><path style="clip-path:url(#SVGID_16_);fill:#f1bc42" d="M172.6595 324.15c-3.96 3.96-6.4116 9.4235-6.4116 15.452-.0024 12.0547 9.8066 21.8636 21.8613 21.8612 12.0547.0024 21.8636-9.797 21.8613-21.8612.0024-3.8474-1.0151-7.6327-2.9353-10.9462-3.8977-6.7324-11.1497-10.9151-18.926-10.9151C182.0806 317.7407 176.6171 320.1924 172.6595 324.15z"/></g></g><path style="fill:#f1bc42" d="M198.8952 333.6497h122.6266v13.8671H198.8952z"/></g></g></svg>
2 | 


--------------------------------------------------------------------------------
/_includes/navigation.html:
--------------------------------------------------------------------------------
 1 | <svg class="md-svg">
 2 | <defs>
 3 |   <svg>
 4 |   <path d="M160 304q0 10-3.125 20.5t-10.75 19-18.125 8.5-18.125-8.5-10.75-19-3.125-20.5 3.125-20.5 10.75-19 18.125-8.5 18.125 8.5 10.75 19 3.125 20.5zM320 304q0 10-3.125 20.5t-10.75 19-18.125 8.5-18.125-8.5-10.75-19-3.125-20.5 3.125-20.5 10.75-19 18.125-8.5 18.125 8.5 10.75 19 3.125 20.5zM360 304q0-30-17.25-51t-46.75-21q-10.25 0-48.75 5.25-17.75 2.75-39.25 2.75t-39.25-2.75q-38-5.25-48.75-5.25-29.5 0-46.75 21t-17.25 51q0 22 8 38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0 37.25-1.75t35-7.375 30.5-15 20.25-25.75 8-38.375zM416 260q0 51.75-15.25 82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5-41.75 1.125q-19.5 0-35.5-0.75t-36.875-3.125-38.125-7.5-34.25-12.875-30.25-20.25-21.5-28.75q-15.5-30.75-15.5-82.75 0-59.25 34-99-6.75-20.5-6.75-42.5 0-29 12.75-54.5 27 0 47.5 9.875t47.25 30.875q36.75-8.75 77.25-8.75 37 0 70 8 26.25-20.5 46.75-30.25t47.25-9.75q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34 99.5z" fill="currentColor"></path></svg>
 5 | </defs></svg>
 6 | 
 7 |     <input class=md-toggle data-md-toggle=drawer type=checkbox id=__drawer autocomplete=off>
 8 |     <input class=md-toggle data-md-toggle=search type=checkbox id=__search autocomplete=off>
 9 |     <label class=md-overlay data-md-component=overlay for=__drawer></label> <a href="#{{ page.title | slugify }}" tabindex=1 class=md-skip> Skip to content </a>
10 |     <header class=md-header data-md-component=header>
11 |         <nav class="md-header-nav md-grid">
12 |             <div class=md-flex>
13 |                 <div class="md-flex__cell md-flex__cell--shrink">
14 |                   <a class="md-header-nav__button md-logo" href="{{ site.url }}" title="{{ site.title }}">
15 |                     {% if site.logo %}<img height="{{ site.logo_pixels }}" src="{{ site.baseurl }}/{{ site.logo }}" width="{{ site.logo_pixels }}">{% else %}<i class="md-icon" style="margin-top:5px"></i>{% endif %}</a>
16 |                 </div>
17 |                 <div class="md-flex__cell md-flex__cell--shrink">
18 |                     <label class="md-icon md-icon--menu md-header-nav__button" for=__drawer></label>
19 |                 </div>
20 |                 <div class="md-flex__cell md-flex__cell--stretch">
21 |                     <div class="md-flex__ellipsis md-header-nav__title" data-md-component=title> 
22 |                         <span class=md-header-nav__topic>{{ site.title }}</span>
23 |                         <span class=md-header-nav__topic>{{ page.title }}</span>
24 |                     </div>
25 |                 </div>
26 |                 <div class="md-flex__cell md-flex__cell--shrink">
27 |                     <label class="md-icon md-icon--search md-header-nav__button" for=__search></label>
28 |                     <div class=md-search data-md-component=search role=dialog>
29 |                         <label class=md-search__overlay for=__search></label>
30 |                         <div class=md-search__inner role=search>
31 |                             <form class=md-search__form name=search>
32 |                                 <input type=text class=md-search__input name=query placeholder=Search autocapitalize=off autocorrect=off autocomplete=off spellcheck=false data-md-component=query data-md-state=active>
33 |                                 <label class="md-icon md-search__icon" for=__search></label>
34 |                                 <button type=reset class="md-icon md-search__icon" data-md-component=reset tabindex=-1> &#xE5CD; </button>
35 |                             </form>
36 |                             <div class=md-search__output>
37 |                                 <div class=md-search__scrollwrap data-md-scrollfix>
38 |                                     <div class=md-search-result data-md-component=result>
39 |                                         <div class=md-search-result__meta> Type to start searching </div>
40 |                                         <ol class=md-search-result__list></ol>
41 |                                     </div>
42 |                                 </div>
43 |                             </div>
44 |                         </div>
45 |                     </div>
46 |                 </div>
47 |       <div class="md-flex__cell md-flex__cell--shrink">
48 |         <div class="md-header-nav__source">
49 |           <a class="md-source" data-md-source="github" href="{{ site.repo }}" title="Go to repository">
50 |           <div class="md-source__icon" style="padding-top:5px">
51 |             <i class="fa fa-github fa-3x"></i>
52 |           </div>
53 |           <div class="md-source__repository" style="min-width:150px">
54 |             {{ site.github_user }}/{{ site.github_repo }}
55 |           </div></a>
56 |         </div>
57 |       </div>
58 |     </div>
59 |   </nav>
60 | </header>
61 | 


--------------------------------------------------------------------------------
/_includes/permalinks.html:
--------------------------------------------------------------------------------
 1 | <script>
 2 | var headers = ["h1", "h2", "h3", "h4"]
 3 | var colors = ["red", "orange", "green", "blue"]
 4 | 
 5 | $.each(headers, function(i, header){
 6 |     var color = colors[i];
 7 |     $(header).each(function () {
 8 |         var href=$(this).attr("id");
 9 |         $(this).append('<a class="headerlink" style="color:' + color + '" href="#' + href + '" title="Permanent link">¶</a>')
10 |     });
11 | })
12 | </script>
13 | 


--------------------------------------------------------------------------------
/_includes/quiz.html:
--------------------------------------------------------------------------------
1 | {% assign quiz = site.data.quizzes[include.file] %}
2 | {% if quiz.randomize == true %}{% assign questions = quiz.questions | sample %}{% else %}{% assign questions = quiz.questions %}{% endif %}{% if quiz.title %}<h2>{{ quiz.title }}</h2>{% endif %}{% for item in questions %}
3 | {% if item.type == "multiple-choice" %}{% include quiz/multiple-choice.html item=item count=forloop.index %}{% endif %}<br>{% endfor %}
4 | 


--------------------------------------------------------------------------------
/_includes/quiz/multiple-choice.html:
--------------------------------------------------------------------------------
1 | <div class="admonition question">
2 | <p class="admonition-title">{% if include.item.question %}{{ include.item.question }}{% else %}Question {{ include.count }}{% endif %}</p>
3 | <p>{% for choice in include.item.items %}{% if choice.correct == true %}<span class="correct-{{ include.count }}">{% endif %}{{ forloop.index }}. {{ choice.choice }}{% if choice.correct == true %}</span>{% endif %}<br>{% endfor %}</p>
4 | </div><button class="btn btn-success" onclick='$(".correct-{{ include.count }}").css("font-weight", 600);$(".correct-more-{{ include.count }}").css("display", "inline")'>Show Answer</button>
5 | {% if include.item.followup %}<p class="well correct-more-{{ include.count }}" style="display:none">{{ include.item.followup }}</p>{% endif %}
6 | 


--------------------------------------------------------------------------------
/_includes/scripts.html:
--------------------------------------------------------------------------------
1 | <script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.3/umd/popper.min.js" integrity="sha384-ZMP7rVo3mIykV+2+9J3UJ46jBk0WLaUAdn689aCwoqbBJiSnjAK/l8WvCWPIPm49" crossorigin="anonymous"></script>
2 | <script src="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/js/bootstrap.min.js" integrity="sha384-ChfqqxuZUCnJSK3+MXmPNIyE6ZbWh2IMqE241rYiqJxyMiZ6OW/JmZQ5stwEULTy" crossorigin="anonymous"></script>
3 | <script src="{{ site.baseurl }}/assets/js/main.js"></script>
4 | 


--------------------------------------------------------------------------------
/_includes/scrolltop.html:
--------------------------------------------------------------------------------
 1 | <style>
 2 | #scrolltop {
 3 |   display: none; /* Hidden by default */
 4 |   position: fixed; /* Fixed/sticky position */
 5 |   bottom: 20px; /* Place the button at the bottom of the page */
 6 |   right: 30px; /* Place the button 30px from the right */
 7 |   z-index: 99; /* Make sure it does not overlap */
 8 |   border: none; /* Remove borders */
 9 |   outline: none; /* Remove outline */
10 |   background-color: {{ site.color }}; /* Set a background color */
11 |   color: white; /* Text color */
12 |   cursor: pointer; /* Add a mouse pointer on hover */
13 |   padding: 10px 15px; /* Some padding */
14 |   border-radius: 100px; /* Rounded corners */
15 |   font-size: 18px; /* Increase font size */
16 |   font-weight: 600;
17 | }
18 | 
19 | #scrolltop:hover {
20 |   background-color: #555; /* Add a dark-grey background on hover */
21 | }
22 | </style>
23 | <button onclick="topFunction()" id="scrolltop" title="Go to top">🔝</button>
24 | 
25 | <script>
26 | // When the user scrolls down 20px from the top of the document, show the button
27 | window.onscroll = function() {scrollFunction()};
28 | 
29 | function scrollFunction() {
30 |   if (document.body.scrollTop > 20 || document.documentElement.scrollTop > 20) {
31 |     document.getElementById("scrolltop").style.display = "block";
32 |   } else {
33 |     document.getElementById("scrolltop").style.display = "none";
34 |   }
35 | }
36 | 
37 | // When the user clicks on the button, scroll to the top of the document
38 | function topFunction() {
39 |   document.body.scrollTop = 0; // For Safari
40 |   document.documentElement.scrollTop = 0; // For Chrome, Firefox, IE and Opera
41 | }
42 | </script>
43 | 


--------------------------------------------------------------------------------
/_includes/sidebar.html:
--------------------------------------------------------------------------------
 1 | <div id="td-sidebar-menu" class="td-sidebar__inner">
 2 |   
 3 |   <form class="td-sidebar__search d-flex align-items-center">
 4 |     <input type="search" class="form-control td-search-input" placeholder="&#xf002 Search this site…" aria-label="Search this site…" autocomplete="off">
 5 |       <button class="btn btn-link td-sidebar__toggle d-md-none p-0 ml-3 fas fa-bars" type="button" data-toggle="collapse" data-target="#td-section-nav" aria-controls="td-docs-nav" aria-expanded="false" aria-label="Toggle section navigation">
 6 |       </button>
 7 |   </form>  
 8 |   
 9 |   <nav class="collapse td-sidebar-nav pt-2 pl-4" id="td-section-nav">
10 |     {% if site.version_params.versioning == true %}
11 |       {% if site.data.toc-mapping contains currentpageversion %}
12 |           {% assign tocfilename = site.data.toc-mapping[currentpageversion] %}
13 |       {% else %}
14 |         {% assign tocfilename = "toc" %}
15 |       {% endif %}
16 |     {% else %}
17 |       {% assign tocfilename = "toc" %}
18 |     {% endif %}
19 |     
20 |     {% comment %}
21 |      Previous toc versions are held in a version subdirectory which can be user configured
22 |     {% endcomment %}
23 |     {% if tocfilename == "toc" %}
24 |       {% assign tocdata = site.data[tocfilename] %}
25 |     {% else %}
26 |       {% assign tocdata = site.data.[site.version_params.tocversion_dir][tocfilename] %}
27 |     {% endif %}
28 |     
29 |     {% for section in tocdata %}
30 |       <ul class="td-sidebar-nav__section pr-md-3">
31 |         {% capture sectionUrl %} 
32 |           {{ section.url | replace: "/", "" }} 
33 |         {% endcapture %}
34 |         {% capture pageUrl %} 
35 |           {{ page.url | replace: "/", "" }} 
36 |         {% endcapture %}
37 |       
38 |         {% if currentpageversion == site.version_params.latest %}
39 |           {% assign versionlink = 'docs'  %}
40 |         {% else %}
41 |           {% assign versionlink = 'docs/' | append: site.version_params.version_dir | append: '/' | append: currentpageversion  %}
42 |         {% endif %}
43 |         
44 |         <li class="td-sidebar-nav__section-title">
45 |           <a  href="{% if section.url %}{{ site.baseurl }}/{{ section.url | replace: 'docs', versionlink }}{% else %}{{ section.external_url }}{% endif %}" class="align-left pl-0 pr-2 active td-sidebar-link td-sidebar-link__section">{{ section.title }}</a>
46 |         </li>
47 |         {% if section.links %}
48 |           <ul>
49 |             <li class="collapse show" id="{{ section.title | slugify }}">
50 |               <ul class="td-sidebar-nav__section pr-md-3">
51 |                 {% for entry in section.links %}
52 |                   {% if site.version_params.versioning == true %}
53 |                     {% if currentpageversion == site.version_params.latest %}
54 |                       {% assign versionlink = 'docs'  %}
55 |                     {% else %}
56 |                       {% assign versionlink = 'docs/' | append: site.version_params.version_dir | append: '/' | append: currentpageversion %}
57 |                     {% endif %}
58 |                   {% else %}
59 |                     {% assign versionlink = 'docs'  %}
60 |                   {% endif %}
61 |                   
62 |                   {% capture fullentryurl %} 
63 |                     {{- "/" | append: entry.url | replace: 'docs', versionlink -}} 
64 |                   {% endcapture %}
65 |                   <li class="td-sidebar-nav__section-title">
66 |                     <a href="{% if entry.url %}
67 |                                 {{ site.baseurl }}/{{ entry.url | replace: 'docs', versionlink}}
68 |                              {% else %}
69 |                                 {{ entry.external_url }}
70 |                              {% endif %}" 
71 |                        class="align-left pl-0 pr-2 td-sidebar-link td-sidebar-link__section {% if page.url == fullentryurl | strip %}active{% endif %}">{{ entry.title }}
72 |                     </a>
73 |                   </li>
74 |                   {% if page.url contains fullentryurl or pageUrl == sectionUrl %}
75 |                     <ul>
76 |                       <li class="collapse show" id="{{ child.title | slugify }}">
77 |                         {% if entry.children %}
78 |                           {% for child in entry.children %}
79 |                             <a class="td-sidebar-link td-sidebar-link__page {% if page.url == fullentryurl | strip %}active{% endif %}" id="m-{{ section.title | slugify }}-{{ entry.title | slugify }}-{{ child.title | slugify }}" href="{% if child.url %}{{ site.baseurl }}/{{ child.url | replace: 'docs', versionlink }}{% else %}{{ child.external_url }}{% endif %}">{{ child.title }}</a>{% endfor %}
80 |                         {% endif %}
81 |                       </li>
82 |                     </ul>
83 |                   {% endif %}
84 |                 {% endfor %}
85 |               </ul>
86 |             </li>
87 |           </ul>
88 |         {% endif %}
89 |       </ul>
90 |     {% endfor %}
91 |   </nav>
92 | </div>


--------------------------------------------------------------------------------
/_includes/tags.html:
--------------------------------------------------------------------------------
1 | {% if page.tags %}<script>
2 | $('h1').first().append('<div>{% for tag in page.tags %}<span style="font-size:12px" class="badge badge-{{ site.tag_color }}"><a style="cursor:pointer; color:white" href="{% if site.tag_search_endpoint %}{{ site.tag_search_endpoint }}{{ tag }}{% else %}{{ site.url }}{{ site.baseurl }}/tags#{{ tag }} {% endif %}">{{ tag }}</a></span>{% endfor %}</div>')</script>{% endif %}
3 | 


--------------------------------------------------------------------------------
/_includes/toc.html:
--------------------------------------------------------------------------------
 1 | <script
 2 |   src="{{ site.baseurl }}/assets/js/jquery-3.3.1/jquery-3.3.1.min.js"
 3 |   integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8= sha256-T+aPohYXbm0fRYDpJLr+zJ9RmYTswGsahAoIsNiMld4="
 4 |   crossorigin="anonymous"></script>
 5 | 
 6 | <script>
 7 | $(document).ready(function() {
 8 | 
 9 |     var toc = $('#TOC');
10 | 
11 |     // Select each header
12 |     sections = $('.td-content h1');
13 |         $.each(sections, function(idx, v) {
14 |             section = $(v);
15 |             var div_id = $(section).attr('id');
16 |             var div_text = section.text().split('¶')[0];
17 |             var parent = $("#" + div_id)
18 |             var content = '<li id="link_' + div_id + '" class="md-nav__item"><a class="md-nav__link" href="#' + div_id + '" title="' + div_text +'">' + div_text +'</a></li>';
19 |             $(toc).append(content);
20 | 
21 |             // Add section code to subnavigation
22 |             var children = $('<nav class="md-nav"><ul class="md-nav__list"></nav></ul>')
23 |             var contenders = $("#" + div_id).nextUntil("h1");
24 |             $.each(contenders, function(idx, contender){
25 |                if($(contender).is('h2') || $(contender).is('h3')) {
26 |                    var contender_id = $(contender).attr('id');
27 |                    var contender_text = $(contender).text().split('¶')[0];
28 |                    var content = '<li class="md-nav__item"><a class="md-nav__link" href="#' + contender_id + '" title="' + contender_text +'">' + contender_text +'</a></li>';
29 |                    children.append(content);
30 |                 }
31 |              })
32 |              $("#link_" + div_id).append(children);
33 |         });
34 |     });
35 | </script>
36 | 


--------------------------------------------------------------------------------
/_includes/versionalert.html:
--------------------------------------------------------------------------------
 1 | <div class="archive_note">
 2 |     {% if civersion == "main" %}
 3 |     <div>
 4 |       <div style="float:left; margin-right:20px; margin-bottom:20px"><i class="fa fa-3x fa-exclamation-triangle" aria-hidden="true" style="color:orange;"></i></div>
 5 |       <div>
 6 |         This documentation is for the latest development version so both code and documentation may be unstable. The content in these pages are not guaranteed to be up to date or correct and may change at any time so please refer to the <a href="{{ site.url }}{{ site.baseurl }}{{ latestversion }}">latest version</a> where necessary.
 7 |       </div>
 8 |     </div>
 9 |     {% elsif civersion == "beta" or civersion == "alpha" or civersion == "rc" or civersion == "pre" %}
10 |     <div>
11 |       <div style="float:left; margin-right:20px; margin-bottom:20px"><i class="fa fa-3x fa-exclamation-triangle" aria-hidden="true" style="color:blue;"></i></div>
12 |       <div>
13 |         This documentation is for the latest pre-production version so both code and documentation may be unstable. The content in these pages are still work in progress so may not be completely up to date or correct. Please see the <a href="{{ site.url }}{{ site.baseurl }}{{ latestversion }}">latest version</a> where necessary.
14 |       </div>
15 |     </div>
16 |     {% else %}
17 |     <div>
18 |       <div style="float:left; margin-right:20px; margin-bottom:20px"><i class="fa fa-3x fa-exclamation-triangle" aria-hidden="true" style="color:red;"></i></div>
19 |       <div>
20 |             Version {{currentpageversion}} of the documentation is no longer actively maintained. The site that you are currently viewing is an archived snapshot. For the most up-to-date documentation, please see the <a href="{{ site.url }}{{ site.baseurl }}{{ latestversion }}">latest version.</a>  
21 |       </div>
22 |     </div>
23 |     {% endif %}
24 | </div>
25 | 


--------------------------------------------------------------------------------
/_layouts/default.html:
--------------------------------------------------------------------------------
 1 | <!DOCTYPE html>
 2 | <html lang="en" class="no-js">
 3 |   <!-- Copyright 2019-2021 Vanessa Sochat-->
 4 |   {% include head.html %}
 5 |   {% include google-analytics.html %}
 6 |   {% if site.version_params.versioning == true %}
 7 |     {% assign pageversion = page.url | append: "/"  | replace: '//', '/' | split: '/' %}
 8 |     {% assign currentpageversion = pageversion[3] %}
 9 |     {% comment %}
10 |       Let's check to see if we have one of the versions in the URL if not then we are on the latest version
11 |     {% endcomment %}
12 |       {% if site.version_params.versions contains currentpageversion %}
13 |         {% assign currentpageversionpath = site.version_params.version_dir | append: '/' | append: pageversion[3] | append: '/' %}
14 |         {% comment %}
15 |           Remove the version from the URL to get the latest document url for use in the alerts etc
16 |         {% endcomment %}        
17 |         {% assign latestversion = page.url | replace: currentpageversionpath, '' %}
18 |       {% else %}
19 |         {% comment %}
20 |           Otherwise we are using the latest version
21 |         {% endcomment %}
22 |         {% assign latestversion = page.url %}
23 |         {% assign currentpageversion = site.version_params.latest %}
24 |       {% endif %}
25 |   {% endif %}
26 |   <body class="td-section">
27 |     {% include header.html %}
28 |     <div class="container-fluid td-outer">
29 |       <div class="td-main">
30 |         <div class="row flex-xl-nowrap">
31 |           <div class="col-12 col-md-3 col-xl-2 td-sidebar d-print-none">
32 |           {% include sidebar.html %}
33 |           </div>
34 |           <div class="d-none d-xl-block col-xl-2 td-toc d-print-none">
35 |               <div class="td-page-meta ml-2 pb-1 pt-2 mb-0">
36 |                   {% include editable.html %}
37 |               </div>
38 |               <nav id="TableOfContents"><ul>
39 |               <li><ul id="TOC">
40 |                 <!-- Links will be appended here-->
41 |               </ul></li>
42 |               </ul></nav>
43 |           </div>
44 |           <main class="col-12 col-md-9 col-xl-8 pl-md-5" role="main">
45 |             <nav aria-label="breadcrumb" class="d-none d-md-block d-print-none">
46 | 	      <ol class="breadcrumb spb-1">
47 |               {% assign crumbs = page.url | append: "/"  | replace: '//', '/' | split: '/' %}
48 |               {% for crumb in crumbs offset: 1 %}
49 |                 {% if crumb != "index" %}
50 |                   {% if forloop.last %}
51 |                     <li class="breadcrumb-item active" aria-current="page">
52 |                       <a href="{{ site.url }}{{ site.baseurl }}{{ page.url }}">{{ page.title }}</a>
53 |                     </li>
54 |                   {% else %}
55 |                     {% if page.url != "/docs/" %}
56 |                       {% if site.version_params.versioning == true and crumb == currentpageversion or crumb == site.version_params.version_dir %}
57 |                       <!-- Don't display the version number or directory in the breadcrumb -->
58 |                       {% else %}
59 |                       <li class="breadcrumb-item">
60 |                         <a href="{{ site.url }}{{ site.baseurl }}{% assign crumb_limit = forloop.index | plus: 1 %}{% for crumb in crumbs limit: crumb_limit %}{{ crumb | append: '/' }}{% endfor %}">{% if crumb == "docs" %}Documentation{% else %}{{ crumb | replace:'-',' ' | remove:'.html' | capitalize }}{% endif %}</a>
61 |                       </li>
62 |                       {% endif %}
63 |                     {% endif %}
64 |                   {% endif %}
65 |                 {% endif %}
66 |               {% endfor %}
67 | 	      </ol>
68 |            </nav>
69 |            <div class="td-content">        
70 |             {% if site.version_params.versioning == true %}
71 |               {% if site.version_params.latest != currentpageversion %}
72 |               {% capture civersion %}
73 |                 {{- currentpageversion | downcase | strip -}}
74 |               {% endcapture %}
75 |                 {% include versionalert.html %}
76 |               {% endif %}
77 |             {% endif %}
78 |             
79 | 	      {{ content }}	
80 |               {% if section.links %}<div class="section-index">
81 |                <hr class="panel-line">{% for child in section.links %}
82 |                  <div class="entry">
83 |                     <h5>
84 |                         <a href="{% if child.url %}{{ site.baseurl }}{{ child.url }}{% else %}{{ child.external_url }}{% endif %}">{{ child.title }}</a>
85 |                     </h5>
86 |                     <p>{{ child.description }}</p>
87 |                  </div>{% endfor %}
88 |               </div>{% endif %}
89 |               {% include feedback.html %}
90 |            </div>
91 |           </main>
92 |         </div>
93 |       </div>
94 |       {% include footer.html %}
95 |     </div>
96 |     {% include scripts.html %}
97 |   </body>
98 | </html>
99 | 


--------------------------------------------------------------------------------
/_layouts/page.html:
--------------------------------------------------------------------------------
1 | ---
2 | layout: default
3 | ---
4 | {{ content }}
5 | {% include toc.html %}
6 | {% include permalinks.html %}
7 | {% include tags.html %}
8 | 


--------------------------------------------------------------------------------
/_layouts/post.html:
--------------------------------------------------------------------------------
1 | ---
2 | layout: page
3 | ---
4 | <!-- Copyright 2019-2021 Vanessa Sochat-->
5 | <h1 style="margin-bottom:0px">{{ page.title }}</h1>
6 | {% if page.badges %}{% for badge in page.badges %}<span class="badge badge-{{ badge.type }}">{{ badge.tag }}</span>{% endfor %}{% endif %}
7 | <span class="post-date" style="font-style: italic;">{{ page.date | date: "%B %d, %Y" }}</span>
8 | {{ content }}
9 | 


--------------------------------------------------------------------------------
/_posts/2019-06-28-hello-world.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | title:  "Two Thousand Nineteen"
 3 | date:   2019-06-28 18:52:21
 4 | categories: jekyll update
 5 | badges:
 6 |  - type: warning
 7 |    tag: warning-badge
 8 |  - type: danger
 9 |    tag: danger-badge
10 | ---
11 | 
12 | Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
13 | 


--------------------------------------------------------------------------------
/_posts/2019-06-29-welcome.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | title: "Welcome to Docsy Jekyll"
 3 | date: 2019-06-28 5:52:21 -0500
 4 | categories: jekyll update
 5 | badges:
 6 |  - type: primary
 7 |    tag: primary-badge
 8 |  - type: secondary
 9 |    tag: secondary-badge
10 |  - type: info
11 |    tag: info-badge
12 |  - type: success
13 |    tag: success-badge
14 | ---
15 | 
16 | 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.
17 | 
18 | <!--more-->
19 | 
20 | To add new posts, simply add a file in the `_posts` directory that follows the convention `YYYY-MM-DD-name-of-post.ext` and includes the necessary front matter. Take a look at the source for this post to get an idea about how it works.
21 | 
22 | Jekyll also offers powerful support for code snippets:
23 | 
24 | {% highlight ruby %}
25 | def print_hi(name)
26 |   puts "Hi, #{name}"
27 | end
28 | print_hi('Tom')
29 | #=> prints 'Hi, Tom' to STDOUT.
30 | {% endhighlight %}
31 | 
32 | 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].
33 | 
34 | [jekyll-docs]: http://jekyllrb.com/docs/home
35 | [jekyll-gh]:   https://github.com/jekyll/jekyll
36 | [jekyll-talk]: https://talk.jekyllrb.com/
37 | 


--------------------------------------------------------------------------------
/assets/css/palette.css:
--------------------------------------------------------------------------------
  1 | ---
  2 | layout: null
  3 | excluded_in_search: true
  4 | ---
  5 | 
  6 | .highlight pre {
  7 |   border: none !important;
  8 | }
  9 | 
 10 | .highlight table td { padding: 5px; }
 11 | .highlight table pre { margin: 0; }
 12 | .highlight .cm {
 13 |   color: #999988;
 14 |   font-style: italic;
 15 | }
 16 | .highlight .cp {
 17 |   color: #999999;
 18 |   font-weight: bold;
 19 | }
 20 | .highlight .c1 {
 21 |   color: #999988;
 22 |   font-style: italic;
 23 | }
 24 | .highlight .cs {
 25 |   color: #999999;
 26 |   font-weight: bold;
 27 |   font-style: italic;
 28 | }
 29 | .highlight .c, .highlight .ch, .highlight .cd, .highlight .cpf {
 30 |   color: #999988;
 31 |   font-style: italic;
 32 | }
 33 | .highlight .err {
 34 |   color: #a61717;
 35 |   background-color: #e3d2d2;
 36 | }
 37 | .highlight .gd {
 38 |   color: #000000;
 39 |   background-color: #ffdddd;
 40 | }
 41 | .highlight .ge {
 42 |   color: #000000;
 43 |   font-style: italic;
 44 | }
 45 | .highlight .gr {
 46 |   color: #aa0000;
 47 | }
 48 | .highlight .gh {
 49 |   color: #999999;
 50 | }
 51 | .highlight .gi {
 52 |   color: #000000;
 53 |   background-color: #ddffdd;
 54 | }
 55 | .highlight .go {
 56 |   color: #888888;
 57 | }
 58 | .highlight .gp {
 59 |   color: #555555;
 60 | }
 61 | .highlight .gs {
 62 |   font-weight: bold;
 63 | }
 64 | .highlight .gu {
 65 |   color: #aaaaaa;
 66 | }
 67 | .highlight .gt {
 68 |   color: #aa0000;
 69 | }
 70 | .highlight .kc {
 71 |   color: #000000;
 72 |   font-weight: bold;
 73 | }
 74 | .highlight .kd {
 75 |   color: #000000;
 76 |   font-weight: bold;
 77 | }
 78 | .highlight .kn {
 79 |   color: #000000;
 80 |   font-weight: bold;
 81 | }
 82 | .highlight .kp {
 83 |   color: #000000;
 84 |   font-weight: bold;
 85 | }
 86 | .highlight .kr {
 87 |   color: #000000;
 88 |   font-weight: bold;
 89 | }
 90 | .highlight .kt {
 91 |   color: #445588;
 92 |   font-weight: bold;
 93 | }
 94 | .highlight .k, .highlight .kv {
 95 |   color: #000000;
 96 |   font-weight: bold;
 97 | }
 98 | .highlight .mf {
 99 |   color: #009999;
100 | }
101 | .highlight .mh {
102 |   color: #009999;
103 | }
104 | .highlight .il {
105 |   color: #009999;
106 | }
107 | .highlight .mi {
108 |   color: #009999;
109 | }
110 | .highlight .mo {
111 |   color: #009999;
112 | }
113 | .highlight .m, .highlight .mb, .highlight .mx {
114 |   color: #009999;
115 | }
116 | .highlight .sb {
117 |   color: #d14;
118 | }
119 | .highlight .sc {
120 |   color: #d14;
121 | }
122 | .highlight .sd {
123 |   color: #d14;
124 | }
125 | .highlight .s2 {
126 |   color: #d14;
127 | }
128 | .highlight .se {
129 |   color: #d14;
130 | }
131 | .highlight .sh {
132 |   color: #d14;
133 | }
134 | .highlight .si {
135 |   color: #d14;
136 | }
137 | .highlight .sx {
138 |   color: #d14;
139 | }
140 | .highlight .sr {
141 |   color: #009926;
142 | }
143 | .highlight .s1 {
144 |   color: #d14;
145 | }
146 | .highlight .ss {
147 |   color: #990073;
148 | }
149 | .highlight .s, .highlight .sa, .highlight .dl {
150 |   color: #d14;
151 | }
152 | .highlight .na {
153 |   color: #008080;
154 | }
155 | .highlight .bp {
156 |   color: #999999;
157 | }
158 | .highlight .nb {
159 |   color: #0086B3;
160 | }
161 | .highlight .nc {
162 |   color: #445588;
163 |   font-weight: bold;
164 | }
165 | .highlight .no {
166 |   color: #008080;
167 | }
168 | .highlight .nd {
169 |   color: #3c5d5d;
170 |   font-weight: bold;
171 | }
172 | .highlight .ni {
173 |   color: #800080;
174 | }
175 | .highlight .ne {
176 |   color: #990000;
177 |   font-weight: bold;
178 | }
179 | .highlight .nf, .highlight .fm {
180 |   color: #990000;
181 |   font-weight: bold;
182 | }
183 | .highlight .nl {
184 |   color: #990000;
185 |   font-weight: bold;
186 | }
187 | .highlight .nn {
188 |   color: #555555;
189 | }
190 | .highlight .nt {
191 |   color: #000080;
192 | }
193 | .highlight .vc {
194 |   color: #008080;
195 | }
196 | .highlight .vg {
197 |   color: #008080;
198 | }
199 | .highlight .vi {
200 |   color: #008080;
201 | }
202 | .highlight .nv, .highlight .vm {
203 |   color: #008080;
204 | }
205 | .highlight .ow {
206 |   color: #000000;
207 |   font-weight: bold;
208 | }
209 | .highlight .o {
210 |   color: #000000;
211 |   font-weight: bold;
212 | }
213 | .highlight .w {
214 |   color: #bbbbbb;
215 | }
216 | .highlight {
217 |   background-color: #f8f8f8;
218 | }
219 | 


--------------------------------------------------------------------------------
/assets/favicons/android-icon-144x144.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vsoch/docsy-jekyll/216c579a05ee9dc233da8d49ffd25858d5bca1b0/assets/favicons/android-icon-144x144.png


--------------------------------------------------------------------------------
/assets/favicons/android-icon-192x192.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vsoch/docsy-jekyll/216c579a05ee9dc233da8d49ffd25858d5bca1b0/assets/favicons/android-icon-192x192.png


--------------------------------------------------------------------------------
/assets/favicons/android-icon-36x36.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vsoch/docsy-jekyll/216c579a05ee9dc233da8d49ffd25858d5bca1b0/assets/favicons/android-icon-36x36.png


--------------------------------------------------------------------------------
/assets/favicons/android-icon-48x48.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vsoch/docsy-jekyll/216c579a05ee9dc233da8d49ffd25858d5bca1b0/assets/favicons/android-icon-48x48.png


--------------------------------------------------------------------------------
/assets/favicons/android-icon-72x72.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vsoch/docsy-jekyll/216c579a05ee9dc233da8d49ffd25858d5bca1b0/assets/favicons/android-icon-72x72.png


--------------------------------------------------------------------------------
/assets/favicons/android-icon-96x96.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vsoch/docsy-jekyll/216c579a05ee9dc233da8d49ffd25858d5bca1b0/assets/favicons/android-icon-96x96.png


--------------------------------------------------------------------------------
/assets/favicons/apple-icon-114x114.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vsoch/docsy-jekyll/216c579a05ee9dc233da8d49ffd25858d5bca1b0/assets/favicons/apple-icon-114x114.png


--------------------------------------------------------------------------------
/assets/favicons/apple-icon-120x120.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vsoch/docsy-jekyll/216c579a05ee9dc233da8d49ffd25858d5bca1b0/assets/favicons/apple-icon-120x120.png


--------------------------------------------------------------------------------
/assets/favicons/apple-icon-144x144.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vsoch/docsy-jekyll/216c579a05ee9dc233da8d49ffd25858d5bca1b0/assets/favicons/apple-icon-144x144.png


--------------------------------------------------------------------------------
/assets/favicons/apple-icon-152x152.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vsoch/docsy-jekyll/216c579a05ee9dc233da8d49ffd25858d5bca1b0/assets/favicons/apple-icon-152x152.png


--------------------------------------------------------------------------------
/assets/favicons/apple-icon-180x180.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vsoch/docsy-jekyll/216c579a05ee9dc233da8d49ffd25858d5bca1b0/assets/favicons/apple-icon-180x180.png


--------------------------------------------------------------------------------
/assets/favicons/apple-icon-57x57.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vsoch/docsy-jekyll/216c579a05ee9dc233da8d49ffd25858d5bca1b0/assets/favicons/apple-icon-57x57.png


--------------------------------------------------------------------------------
/assets/favicons/apple-icon-60x60.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vsoch/docsy-jekyll/216c579a05ee9dc233da8d49ffd25858d5bca1b0/assets/favicons/apple-icon-60x60.png


--------------------------------------------------------------------------------
/assets/favicons/apple-icon-72x72.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vsoch/docsy-jekyll/216c579a05ee9dc233da8d49ffd25858d5bca1b0/assets/favicons/apple-icon-72x72.png


--------------------------------------------------------------------------------
/assets/favicons/apple-icon-76x76.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vsoch/docsy-jekyll/216c579a05ee9dc233da8d49ffd25858d5bca1b0/assets/favicons/apple-icon-76x76.png


--------------------------------------------------------------------------------
/assets/favicons/apple-icon-precomposed.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vsoch/docsy-jekyll/216c579a05ee9dc233da8d49ffd25858d5bca1b0/assets/favicons/apple-icon-precomposed.png


--------------------------------------------------------------------------------
/assets/favicons/apple-icon.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vsoch/docsy-jekyll/216c579a05ee9dc233da8d49ffd25858d5bca1b0/assets/favicons/apple-icon.png


--------------------------------------------------------------------------------
/assets/favicons/browserconfig.xml:
--------------------------------------------------------------------------------
1 | <?xml version="1.0" encoding="utf-8"?>
2 | <browserconfig><msapplication><tile><square70x70logo src="/ms-icon-70x70.png"/><square150x150logo src="/ms-icon-150x150.png"/><square310x310logo src="/ms-icon-310x310.png"/><TileColor>#ffffff</TileColor></tile></msapplication></browserconfig>


--------------------------------------------------------------------------------
/assets/favicons/favicon-16x16.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vsoch/docsy-jekyll/216c579a05ee9dc233da8d49ffd25858d5bca1b0/assets/favicons/favicon-16x16.png


--------------------------------------------------------------------------------
/assets/favicons/favicon-32x32.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vsoch/docsy-jekyll/216c579a05ee9dc233da8d49ffd25858d5bca1b0/assets/favicons/favicon-32x32.png


--------------------------------------------------------------------------------
/assets/favicons/favicon-96x96.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vsoch/docsy-jekyll/216c579a05ee9dc233da8d49ffd25858d5bca1b0/assets/favicons/favicon-96x96.png


--------------------------------------------------------------------------------
/assets/favicons/favicon.ico:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vsoch/docsy-jekyll/216c579a05ee9dc233da8d49ffd25858d5bca1b0/assets/favicons/favicon.ico


--------------------------------------------------------------------------------
/assets/favicons/manifest.json:
--------------------------------------------------------------------------------
 1 | {
 2 |  "name": "App",
 3 |  "icons": [
 4 |   {
 5 |    "src": "\/android-icon-36x36.png",
 6 |    "sizes": "36x36",
 7 |    "type": "image\/png",
 8 |    "density": "0.75"
 9 |   },
10 |   {
11 |    "src": "\/android-icon-48x48.png",
12 |    "sizes": "48x48",
13 |    "type": "image\/png",
14 |    "density": "1.0"
15 |   },
16 |   {
17 |    "src": "\/android-icon-72x72.png",
18 |    "sizes": "72x72",
19 |    "type": "image\/png",
20 |    "density": "1.5"
21 |   },
22 |   {
23 |    "src": "\/android-icon-96x96.png",
24 |    "sizes": "96x96",
25 |    "type": "image\/png",
26 |    "density": "2.0"
27 |   },
28 |   {
29 |    "src": "\/android-icon-144x144.png",
30 |    "sizes": "144x144",
31 |    "type": "image\/png",
32 |    "density": "3.0"
33 |   },
34 |   {
35 |    "src": "\/android-icon-192x192.png",
36 |    "sizes": "192x192",
37 |    "type": "image\/png",
38 |    "density": "4.0"
39 |   }
40 |  ]
41 | }


--------------------------------------------------------------------------------
/assets/favicons/ms-icon-144x144.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vsoch/docsy-jekyll/216c579a05ee9dc233da8d49ffd25858d5bca1b0/assets/favicons/ms-icon-144x144.png


--------------------------------------------------------------------------------
/assets/favicons/ms-icon-150x150.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vsoch/docsy-jekyll/216c579a05ee9dc233da8d49ffd25858d5bca1b0/assets/favicons/ms-icon-150x150.png


--------------------------------------------------------------------------------
/assets/favicons/ms-icon-310x310.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vsoch/docsy-jekyll/216c579a05ee9dc233da8d49ffd25858d5bca1b0/assets/favicons/ms-icon-310x310.png


--------------------------------------------------------------------------------
/assets/favicons/ms-icon-70x70.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vsoch/docsy-jekyll/216c579a05ee9dc233da8d49ffd25858d5bca1b0/assets/favicons/ms-icon-70x70.png


--------------------------------------------------------------------------------
/assets/img/docker-clear.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vsoch/docsy-jekyll/216c579a05ee9dc233da8d49ffd25858d5bca1b0/assets/img/docker-clear.png


--------------------------------------------------------------------------------
/assets/img/docker.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vsoch/docsy-jekyll/216c579a05ee9dc233da8d49ffd25858d5bca1b0/assets/img/docker.png


--------------------------------------------------------------------------------
/assets/img/docsy-jekyll-preview.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vsoch/docsy-jekyll/216c579a05ee9dc233da8d49ffd25858d5bca1b0/assets/img/docsy-jekyll-preview.png


--------------------------------------------------------------------------------
/assets/img/docsy-jekyll-version-search.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vsoch/docsy-jekyll/216c579a05ee9dc233da8d49ffd25858d5bca1b0/assets/img/docsy-jekyll-version-search.png


--------------------------------------------------------------------------------
/assets/img/docsy-jekyll.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vsoch/docsy-jekyll/216c579a05ee9dc233da8d49ffd25858d5bca1b0/assets/img/docsy-jekyll.png


--------------------------------------------------------------------------------
/assets/img/favicon.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vsoch/docsy-jekyll/216c579a05ee9dc233da8d49ffd25858d5bca1b0/assets/img/favicon.png


--------------------------------------------------------------------------------
/assets/img/logo.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vsoch/docsy-jekyll/216c579a05ee9dc233da8d49ffd25858d5bca1b0/assets/img/logo.png


--------------------------------------------------------------------------------
/assets/img/open-source-halloween-2021.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vsoch/docsy-jekyll/216c579a05ee9dc233da8d49ffd25858d5bca1b0/assets/img/open-source-halloween-2021.png


--------------------------------------------------------------------------------
/assets/img/versionalertbeta.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vsoch/docsy-jekyll/216c579a05ee9dc233da8d49ffd25858d5bca1b0/assets/img/versionalertbeta.png


--------------------------------------------------------------------------------
/assets/img/versionalertmain.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vsoch/docsy-jekyll/216c579a05ee9dc233da8d49ffd25858d5bca1b0/assets/img/versionalertmain.png


--------------------------------------------------------------------------------
/assets/img/versionalertoutdated.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vsoch/docsy-jekyll/216c579a05ee9dc233da8d49ffd25858d5bca1b0/assets/img/versionalertoutdated.png


--------------------------------------------------------------------------------
/assets/js/lunr.min.js:
--------------------------------------------------------------------------------
1 | /**
2 |  * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 0.7.0
3 |  * Copyright (C) 2016 Oliver Nightingale
4 |  * MIT Licensed
5 |  * @license
6 |  */
7 | !function(){var t=function(e){var n=new t.Index;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),e&&e.call(n,n),n};t.version="0.7.0",t.utils={},t.utils.warn=function(t){return function(e){t.console&&console.warn&&console.warn(e)}}(this),t.utils.asString=function(t){return void 0===t||null===t?"":t.toString()},t.EventEmitter=function(){this.events={}},t.EventEmitter.prototype.addListener=function(){var t=Array.prototype.slice.call(arguments),e=t.pop(),n=t;if("function"!=typeof e)throw new TypeError("last argument must be a function");n.forEach(function(t){this.hasHandler(t)||(this.events[t]=[]),this.events[t].push(e)},this)},t.EventEmitter.prototype.removeListener=function(t,e){if(this.hasHandler(t)){var n=this.events[t].indexOf(e);this.events[t].splice(n,1),this.events[t].length||delete this.events[t]}},t.EventEmitter.prototype.emit=function(t){if(this.hasHandler(t)){var e=Array.prototype.slice.call(arguments,1);this.events[t].forEach(function(t){t.apply(void 0,e)})}},t.EventEmitter.prototype.hasHandler=function(t){return t in this.events},t.tokenizer=function(e){return arguments.length&&null!=e&&void 0!=e?Array.isArray(e)?e.map(function(e){return t.utils.asString(e).toLowerCase()}):e.toString().trim().toLowerCase().split(t.tokenizer.seperator):[]},t.tokenizer.seperator=/[\s\-]+/,t.tokenizer.load=function(t){var e=this.registeredFunctions[t];if(!e)throw new Error("Cannot load un-registered function: "+t);return e},t.tokenizer.label="default",t.tokenizer.registeredFunctions={"default":t.tokenizer},t.tokenizer.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing tokenizer: "+n),e.label=n,this.registeredFunctions[n]=e},t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions={},t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn("Function is not registered with pipeline. This may cause problems when serialising the index.\n",e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(e){var i=t.Pipeline.registeredFunctions[e];if(!i)throw new Error("Cannot load un-registered function: "+e);n.add(i)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(e){t.Pipeline.warnIfFunctionNotRegistered(e),this._stack.push(e)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var i=this._stack.indexOf(e);if(-1==i)throw new Error("Cannot find existingFn");i+=1,this._stack.splice(i,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var i=this._stack.indexOf(e);if(-1==i)throw new Error("Cannot find existingFn");this._stack.splice(i,0,n)},t.Pipeline.prototype.remove=function(t){var e=this._stack.indexOf(t);-1!=e&&this._stack.splice(e,1)},t.Pipeline.prototype.run=function(t){for(var e=[],n=t.length,i=this._stack.length,r=0;n>r;r++){for(var o=t[r],s=0;i>s&&(o=this._stack[s](o,r,t),void 0!==o&&""!==o);s++);void 0!==o&&""!==o&&e.push(o)}return e},t.Pipeline.prototype.reset=function(){this._stack=[]},t.Pipeline.prototype.toJSON=function(){return this._stack.map(function(e){return t.Pipeline.warnIfFunctionNotRegistered(e),e.label})},t.Vector=function(){this._magnitude=null,this.list=void 0,this.length=0},t.Vector.Node=function(t,e,n){this.idx=t,this.val=e,this.next=n},t.Vector.prototype.insert=function(e,n){this._magnitude=void 0;var i=this.list;if(!i)return this.list=new t.Vector.Node(e,n,i),this.length++;if(e<i.idx)return this.list=new t.Vector.Node(e,n,i),this.length++;for(var r=i,o=i.next;void 0!=o;){if(e<o.idx)return r.next=new t.Vector.Node(e,n,o),this.length++;r=o,o=o.next}return r.next=new t.Vector.Node(e,n,o),this.length++},t.Vector.prototype.magnitude=function(){if(this._magnitude)return this._magnitude;for(var t,e=this.list,n=0;e;)t=e.val,n+=t*t,e=e.next;return this._magnitude=Math.sqrt(n)},t.Vector.prototype.dot=function(t){for(var e=this.list,n=t.list,i=0;e&&n;)e.idx<n.idx?e=e.next:e.idx>n.idx?n=n.next:(i+=e.val*n.val,e=e.next,n=n.next);return i},t.Vector.prototype.similarity=function(t){return this.dot(t)/(this.magnitude()*t.magnitude())},t.SortedSet=function(){this.length=0,this.elements=[]},t.SortedSet.load=function(t){var e=new this;return e.elements=t,e.length=t.length,e},t.SortedSet.prototype.add=function(){var t,e;for(t=0;t<arguments.length;t++)e=arguments[t],~this.indexOf(e)||this.elements.splice(this.locationFor(e),0,e);this.length=this.elements.length},t.SortedSet.prototype.toArray=function(){return this.elements.slice()},t.SortedSet.prototype.map=function(t,e){return this.elements.map(t,e)},t.SortedSet.prototype.forEach=function(t,e){return this.elements.forEach(t,e)},t.SortedSet.prototype.indexOf=function(t){for(var e=0,n=this.elements.length,i=n-e,r=e+Math.floor(i/2),o=this.elements[r];i>1;){if(o===t)return r;t>o&&(e=r),o>t&&(n=r),i=n-e,r=e+Math.floor(i/2),o=this.elements[r]}return o===t?r:-1},t.SortedSet.prototype.locationFor=function(t){for(var e=0,n=this.elements.length,i=n-e,r=e+Math.floor(i/2),o=this.elements[r];i>1;)t>o&&(e=r),o>t&&(n=r),i=n-e,r=e+Math.floor(i/2),o=this.elements[r];return o>t?r:t>o?r+1:void 0},t.SortedSet.prototype.intersect=function(e){for(var n=new t.SortedSet,i=0,r=0,o=this.length,s=e.length,a=this.elements,h=e.elements;;){if(i>o-1||r>s-1)break;a[i]!==h[r]?a[i]<h[r]?i++:a[i]>h[r]&&r++:(n.add(a[i]),i++,r++)}return n},t.SortedSet.prototype.clone=function(){var e=new t.SortedSet;return e.elements=this.toArray(),e.length=e.elements.length,e},t.SortedSet.prototype.union=function(t){var e,n,i;this.length>=t.length?(e=this,n=t):(e=t,n=this),i=e.clone();for(var r=0,o=n.toArray();r<o.length;r++)i.add(o[r]);return i},t.SortedSet.prototype.toJSON=function(){return this.toArray()},t.Index=function(){this._fields=[],this._ref="id",this.pipeline=new t.Pipeline,this.documentStore=new t.Store,this.tokenStore=new t.TokenStore,this.corpusTokens=new t.SortedSet,this.eventEmitter=new t.EventEmitter,this.tokenizerFn=t.tokenizer,this._idfCache={},this.on("add","remove","update",function(){this._idfCache={}}.bind(this))},t.Index.prototype.on=function(){var t=Array.prototype.slice.call(arguments);return this.eventEmitter.addListener.apply(this.eventEmitter,t)},t.Index.prototype.off=function(t,e){return this.eventEmitter.removeListener(t,e)},t.Index.load=function(e){e.version!==t.version&&t.utils.warn("version mismatch: current "+t.version+" importing "+e.version);var n=new this;return n._fields=e.fields,n._ref=e.ref,n.tokenizer=t.tokenizer.load(e.tokenizer),n.documentStore=t.Store.load(e.documentStore),n.tokenStore=t.TokenStore.load(e.tokenStore),n.corpusTokens=t.SortedSet.load(e.corpusTokens),n.pipeline=t.Pipeline.load(e.pipeline),n},t.Index.prototype.field=function(t,e){var e=e||{},n={name:t,boost:e.boost||1};return this._fields.push(n),this},t.Index.prototype.ref=function(t){return this._ref=t,this},t.Index.prototype.tokenizer=function(e){var n=e.label&&e.label in t.tokenizer.registeredFunctions;return n||t.utils.warn("Function is not a registered tokenizer. This may cause problems when serialising the index"),this.tokenizerFn=e,this},t.Index.prototype.add=function(e,n){var i={},r=new t.SortedSet,o=e[this._ref],n=void 0===n?!0:n;this._fields.forEach(function(t){var n=this.pipeline.run(this.tokenizerFn(e[t.name]));i[t.name]=n;for(var o=0;o<n.length;o++){var s=n[o];r.add(s),this.corpusTokens.add(s)}},this),this.documentStore.set(o,r);for(var s=0;s<r.length;s++){for(var a=r.elements[s],h=0,u=0;u<this._fields.length;u++){var l=this._fields[u],c=i[l.name],f=c.length;if(f){for(var d=0,p=0;f>p;p++)c[p]===a&&d++;h+=d/f*l.boost}}this.tokenStore.add(a,{ref:o,tf:h})}n&&this.eventEmitter.emit("add",e,this)},t.Index.prototype.remove=function(t,e){var n=t[this._ref],e=void 0===e?!0:e;if(this.documentStore.has(n)){var i=this.documentStore.get(n);this.documentStore.remove(n),i.forEach(function(t){this.tokenStore.remove(t,n)},this),e&&this.eventEmitter.emit("remove",t,this)}},t.Index.prototype.update=function(t,e){var e=void 0===e?!0:e;this.remove(t,!1),this.add(t,!1),e&&this.eventEmitter.emit("update",t,this)},t.Index.prototype.idf=function(t){var e="@"+t;if(Object.prototype.hasOwnProperty.call(this._idfCache,e))return this._idfCache[e];var n=this.tokenStore.count(t),i=1;return n>0&&(i=1+Math.log(this.documentStore.length/n)),this._idfCache[e]=i},t.Index.prototype.search=function(e){var n=this.pipeline.run(this.tokenizerFn(e)),i=new t.Vector,r=[],o=this._fields.reduce(function(t,e){return t+e.boost},0),s=n.some(function(t){return this.tokenStore.has(t)},this);if(!s)return[];n.forEach(function(e,n,s){var a=1/s.length*this._fields.length*o,h=this,u=this.tokenStore.expand(e).reduce(function(n,r){var o=h.corpusTokens.indexOf(r),s=h.idf(r),u=1,l=new t.SortedSet;if(r!==e){var c=Math.max(3,r.length-e.length);u=1/Math.log(c)}o>-1&&i.insert(o,a*s*u);for(var f=h.tokenStore.get(r),d=Object.keys(f),p=d.length,v=0;p>v;v++)l.add(f[d[v]].ref);return n.union(l)},new t.SortedSet);r.push(u)},this);var a=r.reduce(function(t,e){return t.intersect(e)});return a.map(function(t){return{ref:t,score:i.similarity(this.documentVector(t))}},this).sort(function(t,e){return e.score-t.score})},t.Index.prototype.documentVector=function(e){for(var n=this.documentStore.get(e),i=n.length,r=new t.Vector,o=0;i>o;o++){var s=n.elements[o],a=this.tokenStore.get(s)[e].tf,h=this.idf(s);r.insert(this.corpusTokens.indexOf(s),a*h)}return r},t.Index.prototype.toJSON=function(){return{version:t.version,fields:this._fields,ref:this._ref,tokenizer:this.tokenizerFn.label,documentStore:this.documentStore.toJSON(),tokenStore:this.tokenStore.toJSON(),corpusTokens:this.corpusTokens.toJSON(),pipeline:this.pipeline.toJSON()}},t.Index.prototype.use=function(t){var e=Array.prototype.slice.call(arguments,1);e.unshift(this),t.apply(this,e)},t.Store=function(){this.store={},this.length=0},t.Store.load=function(e){var n=new this;return n.length=e.length,n.store=Object.keys(e.store).reduce(function(n,i){return n[i]=t.SortedSet.load(e.store[i]),n},{}),n},t.Store.prototype.set=function(t,e){this.has(t)||this.length++,this.store[t]=e},t.Store.prototype.get=function(t){return this.store[t]},t.Store.prototype.has=function(t){return t in this.store},t.Store.prototype.remove=function(t){this.has(t)&&(delete this.store[t],this.length--)},t.Store.prototype.toJSON=function(){return{store:this.store,length:this.length}},t.stemmer=function(){var t={ational:"ate",tional:"tion",enci:"ence",anci:"ance",izer:"ize",bli:"ble",alli:"al",entli:"ent",eli:"e",ousli:"ous",ization:"ize",ation:"ate",ator:"ate",alism:"al",iveness:"ive",fulness:"ful",ousness:"ous",aliti:"al",iviti:"ive",biliti:"ble",logi:"log"},e={icate:"ic",ative:"",alize:"al",iciti:"ic",ical:"ic",ful:"",ness:""},n="[^aeiou]",i="[aeiouy]",r=n+"[^aeiouy]*",o=i+"[aeiou]*",s="^("+r+")?"+o+r,a="^("+r+")?"+o+r+"("+o+")?$",h="^("+r+")?"+o+r+o+r,u="^("+r+")?"+i,l=new RegExp(s),c=new RegExp(h),f=new RegExp(a),d=new RegExp(u),p=/^(.+?)(ss|i)es$/,v=/^(.+?)([^s])s$/,g=/^(.+?)eed$/,m=/^(.+?)(ed|ing)$/,y=/.$/,S=/(at|bl|iz)$/,w=new RegExp("([^aeiouylsz])\\1$"),k=new RegExp("^"+r+i+"[^aeiouwxy]$"),x=/^(.+?[^aeiou])y$/,b=/^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/,E=/^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/,F=/^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/,_=/^(.+?)(s|t)(ion)$/,z=/^(.+?)e$/,O=/ll$/,P=new RegExp("^"+r+i+"[^aeiouwxy]$"),T=function(n){var i,r,o,s,a,h,u;if(n.length<3)return n;if(o=n.substr(0,1),"y"==o&&(n=o.toUpperCase()+n.substr(1)),s=p,a=v,s.test(n)?n=n.replace(s,"$1$2"):a.test(n)&&(n=n.replace(a,"$1$2")),s=g,a=m,s.test(n)){var T=s.exec(n);s=l,s.test(T[1])&&(s=y,n=n.replace(s,""))}else if(a.test(n)){var T=a.exec(n);i=T[1],a=d,a.test(i)&&(n=i,a=S,h=w,u=k,a.test(n)?n+="e":h.test(n)?(s=y,n=n.replace(s,"")):u.test(n)&&(n+="e"))}if(s=x,s.test(n)){var T=s.exec(n);i=T[1],n=i+"i"}if(s=b,s.test(n)){var T=s.exec(n);i=T[1],r=T[2],s=l,s.test(i)&&(n=i+t[r])}if(s=E,s.test(n)){var T=s.exec(n);i=T[1],r=T[2],s=l,s.test(i)&&(n=i+e[r])}if(s=F,a=_,s.test(n)){var T=s.exec(n);i=T[1],s=c,s.test(i)&&(n=i)}else if(a.test(n)){var T=a.exec(n);i=T[1]+T[2],a=c,a.test(i)&&(n=i)}if(s=z,s.test(n)){var T=s.exec(n);i=T[1],s=c,a=f,h=P,(s.test(i)||a.test(i)&&!h.test(i))&&(n=i)}return s=O,a=c,s.test(n)&&a.test(n)&&(s=y,n=n.replace(s,"")),"y"==o&&(n=o.toLowerCase()+n.substr(1)),n};return T}(),t.Pipeline.registerFunction(t.stemmer,"stemmer"),t.generateStopWordFilter=function(t){var e=t.reduce(function(t,e){return t[e]=e,t},{});return function(t){return t&&e[t]!==t?t:void 0}},t.stopWordFilter=t.generateStopWordFilter(["a","able","about","across","after","all","almost","also","am","among","an","and","any","are","as","at","be","because","been","but","by","can","cannot","could","dear","did","do","does","either","else","ever","every","for","from","get","got","had","has","have","he","her","hers","him","his","how","however","i","if","in","into","is","it","its","just","least","let","like","likely","may","me","might","most","must","my","neither","no","nor","not","of","off","often","on","only","or","other","our","own","rather","said","say","says","she","should","since","so","some","than","that","the","their","them","then","there","these","they","this","tis","to","too","twas","us","wants","was","we","were","what","when","where","which","while","who","whom","why","will","with","would","yet","you","your"]),t.Pipeline.registerFunction(t.stopWordFilter,"stopWordFilter"),t.trimmer=function(t){return t.replace(/^\W+/,"").replace(/\W+$/,"")},t.Pipeline.registerFunction(t.trimmer,"trimmer"),t.TokenStore=function(){this.root={docs:{}},this.length=0},t.TokenStore.load=function(t){var e=new this;return e.root=t.root,e.length=t.length,e},t.TokenStore.prototype.add=function(t,e,n){var n=n||this.root,i=t.charAt(0),r=t.slice(1);return i in n||(n[i]={docs:{}}),0===r.length?(n[i].docs[e.ref]=e,void(this.length+=1)):this.add(r,e,n[i])},t.TokenStore.prototype.has=function(t){if(!t)return!1;for(var e=this.root,n=0;n<t.length;n++){if(!e[t.charAt(n)])return!1;e=e[t.charAt(n)]}return!0},t.TokenStore.prototype.getNode=function(t){if(!t)return{};for(var e=this.root,n=0;n<t.length;n++){if(!e[t.charAt(n)])return{};e=e[t.charAt(n)]}return e},t.TokenStore.prototype.get=function(t,e){return this.getNode(t,e).docs||{}},t.TokenStore.prototype.count=function(t,e){return Object.keys(this.get(t,e)).length},t.TokenStore.prototype.remove=function(t,e){if(t){for(var n=this.root,i=0;i<t.length;i++){if(!(t.charAt(i)in n))return;n=n[t.charAt(i)]}delete n.docs[e]}},t.TokenStore.prototype.expand=function(t,e){var n=this.getNode(t),i=n.docs||{},e=e||[];return Object.keys(i).length&&e.push(t),Object.keys(n).forEach(function(n){"docs"!==n&&e.concat(this.expand(t+n,e))},this),e},t.TokenStore.prototype.toJSON=function(){return{root:this.root,length:this.length}},function(t,e){"function"==typeof define&&define.amd?define(e):"object"==typeof exports?module.exports=e():t.lunr=e()}(this,function(){return t})}();


--------------------------------------------------------------------------------
/assets/js/main.js:
--------------------------------------------------------------------------------
 1 | ---
 2 | exclude_in_search: true
 3 | layout: null
 4 | ---
 5 | (function($) {
 6 |     'use strict';
 7 |     $(function() {
 8 |         $('[data-toggle="tooltip"]').tooltip();
 9 |         $('[data-toggle="popover"]').popover();
10 |         $('.popover-dismiss').popover({
11 |             trigger: 'focus'
12 |         })
13 |     });
14 | 
15 |     function bottomPos(element) {
16 |         return element.offset().top + element.outerHeight();
17 |     }
18 |     $(function() {
19 |         var promo = $(".js-td-cover");
20 |         if (!promo.length) {
21 |             return
22 |         }
23 |         var promoOffset = bottomPos(promo);
24 |         var navbarOffset = $('.js-navbar-scroll').offset().top;
25 |         var threshold = Math.ceil($('.js-navbar-scroll').outerHeight());
26 |         if ((promoOffset - navbarOffset) < threshold) {
27 |             $('.js-navbar-scroll').addClass('navbar-bg-onscroll');
28 |         }
29 |         $(window).on('scroll', function() {
30 |             var navtop = $('.js-navbar-scroll').offset().top - $(window).scrollTop();
31 |             var promoOffset = bottomPos($('.js-td-cover'));
32 |             var navbarOffset = $('.js-navbar-scroll').offset().top;
33 |             if ((promoOffset - navbarOffset) < threshold) {
34 |                 $('.js-navbar-scroll').addClass('navbar-bg-onscroll');
35 |             } else {
36 |                 $('.js-navbar-scroll').removeClass('navbar-bg-onscroll');
37 |                 $('.js-navbar-scroll').addClass('navbar-bg-onscroll--fade');
38 |             }
39 |         });
40 |     });
41 | }(jQuery));
42 | (function($) {
43 |     'use strict';
44 |     var Search = {
45 |         init: function() {
46 |             $(document).ready(function() {
47 |                 $(document).on('keypress', '.td-search-input', function(e) {
48 |                     if (e.keyCode !== 13) {
49 |                         return
50 |                     }
51 |                     var query = $(this).val();
52 |                     var searchPage = "{{ site.url }}{{ site.baseurl }}/search/?q=" + query;
53 |                     document.location = searchPage;
54 |                     return false;
55 |                 });
56 |             });
57 |         },
58 |     };
59 |     Search.init();
60 | }(jQuery));
61 | 


--------------------------------------------------------------------------------
/assets/js/search.js:
--------------------------------------------------------------------------------
  1 | ---
  2 | layout: null
  3 | excluded_in_search: true
  4 | ---
  5 | (function () {
  6 | 	function getQueryVariable(variable) {
  7 | 		var query = window.location.search.substring(1),
  8 | 			vars = query.split("&");
  9 | 
 10 | 		for (var i = 0; i < vars.length; i++) {
 11 | 			var pair = vars[i].split("=");
 12 | 
 13 | 			if (pair[0] === variable) {
 14 | 				return decodeURIComponent(pair[1].replace(/\+/g, '%20')).trim();
 15 | 			}
 16 | 		}
 17 | 	}
 18 | 
 19 | 	function getPreview(query, content, previewLength) {
 20 | 		previewLength = previewLength || (content.length * 2);
 21 | 
 22 | 		var parts = query.split(" "),
 23 | 			match = content.toLowerCase().indexOf(query.toLowerCase()),
 24 | 			matchLength = query.length,
 25 | 			preview;
 26 | 
 27 | 		// Find a relevant location in content
 28 | 		for (var i = 0; i < parts.length; i++) {
 29 | 			if (match >= 0) {
 30 | 				break;
 31 | 			}
 32 | 
 33 | 			match = content.toLowerCase().indexOf(parts[i].toLowerCase());
 34 | 			matchLength = parts[i].length;
 35 | 		}
 36 | 
 37 | 		// Create preview
 38 | 		if (match >= 0) {
 39 | 			var start = match - (previewLength / 2),
 40 | 				end = start > 0 ? match + matchLength + (previewLength / 2) : previewLength;
 41 | 
 42 | 			preview = content.substring(start, end).trim();
 43 | 
 44 | 			if (start > 0) {
 45 | 				preview = "..." + preview;
 46 | 			}
 47 | 
 48 | 			if (end < content.length) {
 49 | 				preview = preview + "...";
 50 | 			}
 51 | 
 52 | 			// Highlight query parts
 53 | 			preview = preview.replace(new RegExp("(" + parts.join("|") + ")", "gi"), "<strong>$1</strong>");
 54 | 		} else {
 55 | 			// Use start of content if no match found
 56 | 			preview = content.substring(0, previewLength).trim() + (content.length > previewLength ? "..." : "");
 57 | 		}
 58 | 
 59 | 		return preview;
 60 | 	}
 61 | 
 62 | 	function displaySearchResults(results, query) {
 63 | 		var searchResultsEl = document.getElementById("search-results"),
 64 | 			searchProcessEl = document.getElementById("search-process");
 65 | 
 66 | 		if (results.length) {
 67 | 			var resultsHTML = "";
 68 | 			var searchVersions = [{% for v in site.version_params.search_versions %}"{{ v }}",{% endfor %}"all"]
 69 | 			results.forEach(function (result) {
 70 | 			
 71 |   				var item = window.data[result.ref]
 72 | 
 73 | 				// Versioning is disabled
 74 | 				if (("{{ site.version_params.versioning }}" == "false") && (item.version != "all")) {
 75 | 				    return
 76 | 				}
 77 | 
 78 | 				// Skip result if showing versions disabled
 79 | 				if (("{{ site.version_params.allow_search }}" == "false") && (item.version != "all")) {
 80 | 				    return
 81 | 				}
 82 | 
 83 |                                // Skip result if version not in all or versions allowed for search
 84 | 				if (("{{ site.version_params.versioning }}" == "true") && ("{{ site.version_params.allow_search }}" == "true") && (!searchVersions.includes(item.version))) {
 85 | 				    return
 86 | 				}
 87 | 
 88 |                                 if (item.title) {
 89 | 					contentPreview = getPreview(query, item.content, 170),
 90 | 					titlePreview = getPreview(query, item.title);
 91 | 
 92 | 					// If we only allow one version (all) skip adding a badge
 93 | 					if (searchVersions.length == 1 ||  "{{ site.version_params.versioning }}" == "false"){
 94 | 						versionBadge = ""
 95 | 
 96 | 					// Any older version shows up in gray
 97 | 					} else if (item.version != "all") {
 98 | 						versionBadge = "<span class='badge badge-secondary'>" + item.version + "</span>"
 99 | 
100 | 					// Current is blue (primary)
101 | 					} else {
102 | 						versionBadge = "<span class='badge badge-{{ site.tag_color }}'>Current</span>"
103 |                                        }
104 | 					resultsHTML += "<li><h4><a href='{{ site.baseurl }}" + item.url.trim() + "'>" + titlePreview + "</a></h4><p>" + versionBadge +"<small>" + contentPreview + "</small></p></li>";
105 | 				}
106 | 			});
107 | 
108 | 			searchResultsEl.innerHTML = resultsHTML;
109 | 			searchProcessEl.innerText = "Showing";
110 | 		} else {
111 | 			searchResultsEl.style.display = "none";
112 | 			searchProcessEl.innerText = "No";
113 | 		}
114 | 	}
115 | 
116 | 	window.index = lunr(function () {
117 | 		this.field("id");
118 | 		this.field("title", {boost: 10});
119 | 		this.field("categories");
120 | 		this.field("url");
121 | 		this.field("content");
122 | 	});
123 | 
124 | 	var query = decodeURIComponent((getQueryVariable("q") || "").replace(/\+/g, "%20")),
125 | 		searchQueryContainerEl = document.getElementById("search-query-container"),
126 | 		searchQueryEl = document.getElementById("search-query");
127 | 
128 | 	searchQueryEl.innerText = query;
129 |         if (query != ""){
130 |    		searchQueryContainerEl.style.display = "inline";
131 |         }
132 | 
133 | 	for (var key in window.data) {
134 | 		window.index.add(window.data[key]);
135 | 	}
136 | 
137 | 	displaySearchResults(window.index.search(query), query); // Hand the results off to be displayed
138 | })();
139 | 


--------------------------------------------------------------------------------
/assets/webfonts/fa-brands-400.eot:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vsoch/docsy-jekyll/216c579a05ee9dc233da8d49ffd25858d5bca1b0/assets/webfonts/fa-brands-400.eot


--------------------------------------------------------------------------------
/assets/webfonts/fa-brands-400.ttf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vsoch/docsy-jekyll/216c579a05ee9dc233da8d49ffd25858d5bca1b0/assets/webfonts/fa-brands-400.ttf


--------------------------------------------------------------------------------
/assets/webfonts/fa-brands-400.woff:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vsoch/docsy-jekyll/216c579a05ee9dc233da8d49ffd25858d5bca1b0/assets/webfonts/fa-brands-400.woff


--------------------------------------------------------------------------------
/assets/webfonts/fa-brands-400.woff2:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vsoch/docsy-jekyll/216c579a05ee9dc233da8d49ffd25858d5bca1b0/assets/webfonts/fa-brands-400.woff2


--------------------------------------------------------------------------------
/assets/webfonts/fa-regular-400.eot:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vsoch/docsy-jekyll/216c579a05ee9dc233da8d49ffd25858d5bca1b0/assets/webfonts/fa-regular-400.eot


--------------------------------------------------------------------------------
/assets/webfonts/fa-regular-400.ttf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vsoch/docsy-jekyll/216c579a05ee9dc233da8d49ffd25858d5bca1b0/assets/webfonts/fa-regular-400.ttf


--------------------------------------------------------------------------------
/assets/webfonts/fa-regular-400.woff:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vsoch/docsy-jekyll/216c579a05ee9dc233da8d49ffd25858d5bca1b0/assets/webfonts/fa-regular-400.woff


--------------------------------------------------------------------------------
/assets/webfonts/fa-regular-400.woff2:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vsoch/docsy-jekyll/216c579a05ee9dc233da8d49ffd25858d5bca1b0/assets/webfonts/fa-regular-400.woff2


--------------------------------------------------------------------------------
/assets/webfonts/fa-solid-900.eot:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vsoch/docsy-jekyll/216c579a05ee9dc233da8d49ffd25858d5bca1b0/assets/webfonts/fa-solid-900.eot


--------------------------------------------------------------------------------
/assets/webfonts/fa-solid-900.ttf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vsoch/docsy-jekyll/216c579a05ee9dc233da8d49ffd25858d5bca1b0/assets/webfonts/fa-solid-900.ttf


--------------------------------------------------------------------------------
/assets/webfonts/fa-solid-900.woff:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vsoch/docsy-jekyll/216c579a05ee9dc233da8d49ffd25858d5bca1b0/assets/webfonts/fa-solid-900.woff


--------------------------------------------------------------------------------
/assets/webfonts/fa-solid-900.woff2:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vsoch/docsy-jekyll/216c579a05ee9dc233da8d49ffd25858d5bca1b0/assets/webfonts/fa-solid-900.woff2


--------------------------------------------------------------------------------
/docker-compose.yaml:
--------------------------------------------------------------------------------
 1 | version: '3.7'
 2 | services:
 3 |   site:
 4 |     container_name: docsy
 5 |     command: jekyll serve --watch --drafts
 6 |     image: jekyll/jekyll:3.8
 7 |     volumes: 
 8 |       - "./:/srv/jekyll"
 9 |       - "./vendor/bundle:/usr/local/bundle"
10 |       # remove "./vendor/bundle:/usr/local/bundle" volume when deploying in production
11 |     ports: 
12 |       - "4000:4000"
13 | 


--------------------------------------------------------------------------------
/pages/about.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | title: About
 3 | permalink: /about/
 4 | ---
 5 | 
 6 | # About
 7 | 
 8 | This is a [starter template](https://vsoch.github.io/docsy-jekyll/) for a Docsy jekyll theme, based
 9 | on the Beautiful [Docsy](https://github.com/google/docsy) that renders with Hugo. This version is intended for
10 | native deployment on GitHub pages. See the [repository]({{ site.repo }}) for more details.
11 | 
12 | ## Support
13 | 
14 | If you need help, please don't hesitate to [open an issue](https://www.github.com/{{ site.github_user }}/{{ site.github_repo }}).
15 | 
16 | 


--------------------------------------------------------------------------------
/pages/archive.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | layout: page
 3 | title: Articles
 4 | permalink: /archive/
 5 | ---
 6 | # News Archive
 7 | 
 8 | {% for post in site.posts  %}{% capture this_year %}{{ post.date | date: "%Y" }}{% endcapture %}{% capture next_year %}{{ post.previous.date | date: "%Y" }}{% endcapture %}
 9 | 
10 | {% if forloop.first %}<h2 class="c-archives__year" id="{{ this_year }}-ref">{{this_year}}</h2>
11 | <ul class="c-archives__list">{% endif %}
12 | <li class="c-archives__item">
13 |   {{ post.date | date: "%b %-d, %Y" }}: <a href="{{ post.url | prepend: site.baseurl }}">{{ post.title }}</a>
14 |   </li>{% if forloop.last %}</ul>{% else %}{% if this_year != next_year %}
15 | </ul>
16 | <h2 class="c-archives__year" id="{{ next_year }}-ref">{{next_year}}</h2>
17 | <ul class="c-archives__list">{% endif %}{% endif %}{% endfor %}
18 | 


--------------------------------------------------------------------------------
/pages/docs.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | layout: page
 3 | title: Documentation
 4 | permalink: /docs/
 5 | ---
 6 | 
 7 | # Documentation
 8 | 
 9 | Welcome to the {{ site.title }} Documentation pages! Here you can quickly jump to a 
10 | particular page.
11 | 
12 | <div class="section-index">
13 |     <hr class="panel-line">
14 |     {% for post in site.docs  %}        
15 |     <div class="entry">
16 |     <h5><a href="{{ post.url | prepend: site.baseurl }}">{{ post.title }}</a></h5>
17 |     <p>{{ post.description }}</p>
18 |     </div>{% endfor %}
19 | </div>
20 | 


--------------------------------------------------------------------------------
/pages/feed.xml:
--------------------------------------------------------------------------------
 1 | ---
 2 | layout: null
 3 | permalink: /feed.xml
 4 | ---
 5 | <?xml version="1.0" encoding="UTF-8"?>
 6 | <rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
 7 |   <channel>
 8 |     <title>{{ site.title | xml_escape }}</title>
 9 |     <description>{{ site.description | xml_escape }}</description>
10 |     <link>{{ site.url }}{{ site.baseurl }}/</link>
11 |     <atom:link href="{{ "/feed.xml" | prepend: site.baseurl | prepend: site.url }}" rel="self" type="application/rss+xml"/>
12 |     <pubDate>{{ site.time | date_to_rfc822 }}</pubDate>
13 |     <lastBuildDate>{{ site.time | date_to_rfc822 }}</lastBuildDate>
14 |     <generator>Jekyll v{{ jekyll.version }}</generator>
15 |     {% for post in site.posts limit:10 %}
16 |       <item>
17 |         <title>{{ post.title | xml_escape }}</title>
18 |         <description>{{ post.content | xml_escape }}</description>
19 |         <pubDate>{{ post.date | date_to_rfc822 }}</pubDate>
20 |         <link>{{ post.url | prepend: site.baseurl | prepend: site.url }}</link>
21 |         <guid isPermaLink="true">{{ post.url | prepend: site.baseurl | prepend: site.url }}</guid>
22 |         {% for tag in post.tags %}
23 |         <category>{{ tag | xml_escape }}</category>
24 |         {% endfor %}
25 |         {% for cat in post.categories %}
26 |         <category>{{ cat | xml_escape }}</category>
27 |         {% endfor %}
28 |       </item>
29 |     {% endfor %}
30 |   </channel>
31 | </rss>
32 | 


--------------------------------------------------------------------------------
/pages/index.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | layout: page
 3 | title: Docsy Jekyll Theme
 4 | permalink: /
 5 | ---
 6 | 
 7 | # Welcome to Docsy Jekyll
 8 | 
 9 | This is a starter template for a docsy jekyll theme.
10 | 
11 | ![assets/img/docsy-jekyll.png](assets/img/docsy-jekyll.png)
12 | 
13 | ## Purpose
14 | 
15 | GitHub pages uses Jekyll natively, so when I make documentation, I typically
16 | look for Jekyll templates. Why? Using Jekyll means that I can use markdown,
17 | and allow for users to easily contribute, and build automatically just by
18 | way of pushing to a master branch (or general GitHub pages).
19 | I found Docsy, a beautiful Hugo template, but it requires hugo with GoLang
20 | which doesn't render natively on GitHub pages. For this reason, I've spent
21 | some time creating a custom Jekyll template that is (almost) as beautiful,
22 | and includes all the features that I might want.
23 | 
24 | ## Features
25 | 
26 | What are these features? You should see the {% include doc.html name="Getting Started" path="getting-started" %}
27 | guide for a complete summary. Briefly:
28 | 
29 |  - *User interaction* including consistent permalinks, links to ask questions via GitHub issues, and edit the file on GitHub directly.
30 |  - *Search* across posts, documentation, and other site pages, with an ability to exclude from search.
31 |  - *External Search* meaning an ability to link any page tag to trigger an external search.
32 |  - *Documentation* A documentation collection that was easy to organize on the filesystem, render with nested headings for the user, and refer to in markdown.
33 |  - *Pages* A separate folder for more traditional pages (e.g, about).
34 |  - *Navigation*: Control over the main navigation on the left of the page, and automatic generation of table of contents for each page on the right.
35 |  - *News* A posts feed for news and updates, along with an archive (organized by year).
36 |  - *Templates* or specifically, "includes" that make it easy to create an alert, documentation link, or other content.
37 |  - *Continuous Integration* recipes to preview the site
38 | 
39 | 
40 | For features, getting started with development, see the {% include doc.html name="Getting Started" path="getting-started" %} page. Would you like to request a feature or contribute?
41 | [Open an issue]({{ site.repo }}/issues)
42 | 


--------------------------------------------------------------------------------
/pages/news.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | title: News
 3 | permalink: /news/
 4 | ---
 5 | 
 6 | # News
 7 | 
 8 | <p>Subscribe with <a href="{{ site.baseurl }}/feed.xml">RSS</a> to keep up with the latest news.
 9 | For site changes, see the <a href="https://github.com/{{ site.github_user }}/{{ site.github_repo }}/blob/master/CHANGELOG.md">changelog</a> kept with the code base.</p>
10 | 
11 | <br>
12 | 
13 | {% for post in site.posts limit:10 %}
14 |    <div class="post-preview">
15 |    <h2><a href="{{ site.baseurl }}{{ post.url }}">{{ post.title }}</a></h2>
16 |    <span class="post-date">{{ post.date | date: "%B %d, %Y" }}</span><br>
17 |    {% if post.badges %}{% for badge in post.badges %}<span class="badge badge-{{ badge.type }}">{{ badge.tag }}</span>{% endfor %}{% endif %}
18 |    {{ post.content | split:'<!--more-->' | first }}
19 |    {% if post.content contains '<!--more-->' %}
20 |       <a href="{{ site.baseurl }}{{ post.url }}">read more</a>
21 |    {% endif %}
22 |    </div>
23 |    <hr>
24 | {% endfor %}
25 | 
26 | Want to see more? See the <a href="{{ site.baseurl }}/archive/">News Archive</a>.
27 | 


--------------------------------------------------------------------------------
/pages/search.html:
--------------------------------------------------------------------------------
 1 | ---
 2 | title: Search
 3 | sitemap: false
 4 | permalink: /search/
 5 | not_editable: true
 6 | excluded_in_search: true
 7 | ---
 8 | 
 9 | <input class="form-control td-search-input" type="search" name="q" id="search-input" placeholder="&#xf002 Search this site…"  style="margin-top:5px" autofocus>
10 | <i style="color:white; margin-right:8px; margin-left:5px" class="fa fa-search"></i>
11 | 
12 | <p><span id="search-process">Loading</span> results <span id="search-query-container" style="display: none;">for "<strong id="search-query"></strong>"</span></p>
13 | 
14 | <ul id="search-results"></ul>
15 | 
16 | {% capture version_prefix %}/docs/{{ site.version_params.version_dir }}/{% endcapture %}
17 | <script>
18 | 	window.data = {
19 | 		{% for post in site.docs %}
20 | 				{% unless post.excluded_in_search %}
21 | 					{% if added %},{% endif %}
22 | 					{% assign added = false %}{% assign version_dir = post.url | split: version_prefix %}{% assign docs_version = version_dir[1] | split: "/" %}
23 | 					"{{ post.url | slugify }}": {
24 | 						"id": "{{ post.url | slugify }}",
25 | 						"title": "{{ post.title | xml_escape }}",
26 | 						"version": "{% if post.url contains site.version_params.version_dir %}{{ docs_version[0] }}{% else %}all{% endif %}",
27 | 						"categories": "{{ post.categories | join: ", " | xml_escape }}",
28 | 						"url": " {{ post.url | xml_escape }}",
29 | 						"content": {{ post.content | strip_html | replace_regex: "[\s/\n]+"," " | strip | jsonify }}
30 | 					}
31 | 					{% assign added = true %}
32 | 				{% endunless %}
33 | 		{% endfor %}
34 | 		{% for post in site.posts %}
35 | 				{% unless post.excluded_in_search %}
36 | 					{% if added %},{% endif %}
37 | 					{% assign added = false %}
38 | 					"{{ post.url | slugify }}": {
39 | 						"id": "{{ post.url | slugify }}",
40 | 						"title": "{{ post.title | xml_escape }}",
41 | 						"version": "all", 
42 | 						"categories": "{{ post.categories | join: ", " | xml_escape }}",
43 | 						"url": " {{ post.url | xml_escape }}",
44 | 						"content": {{ post.content | strip_html | replace_regex: "[\s/\n]+"," " | strip | jsonify }}
45 | 					}
46 | 					{% assign added = true %}
47 | 				{% endunless %}
48 | 		{% endfor %}
49 | 		{% for post in site.pages %}
50 | 				{% unless post.excluded_in_search %}
51 | 					{% if added %},{% endif %}
52 | 					{% assign added = false %}
53 | 					"{{ post.url | slugify }}": {
54 | 						"id": "{{ post.url | slugify }}",
55 | 						"title": "{{ post.title | xml_escape }}",
56 | 						"version": "all",
57 | 						"categories": "{{ post.categories | join: ", " | xml_escape }}",
58 | 						"url": " {{ post.url | xml_escape }}",
59 | 						"content": {{ post.content | strip_html | replace_regex: "[\s/\n]+"," " | strip | jsonify }}
60 | 					}
61 | 					{% assign added = true %}
62 | 				{% endunless %}
63 | 		{% endfor %}
64 | 	};
65 | </script>
66 | <script src="{{ site.baseurl }}/assets/js/lunr.min.js"></script>
67 | <script src="{{ site.baseurl }}/assets/js/search.js"></script>
68 | 


--------------------------------------------------------------------------------
/pages/sitemap.xml:
--------------------------------------------------------------------------------
 1 | ---
 2 | layout: null
 3 | permalink: /sitemap.xml
 4 | ---
 5 | 
 6 | <?xml version="1.0" encoding="UTF-8"?>
 7 | <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
 8 |     <url>
 9 |      <loc>/</loc>
10 |      <lastmod>{{ "now" | date: "%Y-%m-%d" }}</lastmod>
11 |      <changefreq>daily</changefreq>
12 |     </url>
13 | {% for section in site.data.toc %}<url>
14 |      <loc>{{ site.baseurl }}{{ section.url }}/</loc>
15 |      <lastmod>{{ "now" | date: "%Y-%m-%d" }}</lastmod>
16 |      <changefreq>daily</changefreq>
17 |     </url>
18 | {% endfor %}
19 | </urlset>
20 | 


--------------------------------------------------------------------------------
/pages/tags.html:
--------------------------------------------------------------------------------
 1 | ---
 2 | title: Tags Index
 3 | permalink: /tags/
 4 | ---
 5 | 
 6 | <h1 id="tags-index">Tags Index</h1>
 7 | {% capture site_tags %}{% for tag in site.tags %}{% if tag %}{{ tag | first }}{% unless forloop.last %},{% endunless %}{% endif %}{% endfor %}{% endcapture %}{% assign docs_tags = "" %}{% for doc in site.docs %}{% assign ttags = doc.tags | join:',' | append:',' %}{% assign docs_tags = docs_tags | append:ttags %}{% endfor %}
 8 | {% assign all_tags = docs_tags | append:site_tags %}{% assign tags_list = all_tags | split:',' | uniq | sort %}
 9 | 
10 | {% for tag in tags_list %}{% if tag %}<h3 id="{{ tag | replace: '/', '-' }}" class="linked-section">{{ tag }}</h3>
11 | <div class="post-list" style="margin-bottom:40px">
12 |     {% for post in site.tags[tag] %}<div class="tag-entry">
13 |     <a href="{{- site.url -}}{{- post.url -}}">{{- post.title -}}</a>
14 |     <time style="font-style:italic; float:right" datetime="{{- post.date | date_to_xmlschema -}}"> {{- post.date | date: "%B %d, %Y" -}}</time>
15 | </div>{%- endfor -%}
16 | {% for doc in site.docs %}{% if doc.tags contains tag %}
17 | <div class="tag-entry">
18 |     <a href="{{- site.baseurl -}}{{- doc.url -}}">{{ doc.title }}</a>
19 |         <time style="font-style:italic; float:right" datetime="{{- doc.date | date_to_xmlschema -}}"> {{- doc.date | date: "%B %d, %Y" -}}</time>
20 |     </div>{% endif %}{% endfor %}
21 | </div>{% endif %}{%- endfor -%}
22 | 


--------------------------------------------------------------------------------