├── VERSION ├── .gitignore ├── assets ├── img │ ├── favicon.png │ ├── docker-clear.png │ ├── mkdocs-jekyll.png │ ├── discourse-forum.png │ └── macbook-preview.png ├── js │ ├── modernizr.74668098.js │ └── application.a59e2a89.js └── css │ └── palette.css ├── pages ├── forum.md ├── sitemap.xml ├── about.md ├── archive.md ├── news.md ├── feed.xml └── index.md ├── _includes ├── doc.html ├── alert.html ├── tags.html ├── google-analytics.html ├── quiz.html ├── embed │ └── discourse.html ├── quiz │ └── multiple-choice.html ├── headers.html ├── social.html ├── toc.html ├── scrolltop.html ├── editable.html ├── head.html ├── footer.html ├── sidebar.html └── navigation.html ├── _docs ├── subfolder │ └── example-page.md ├── extras │ ├── index.md │ └── example-quiz.md ├── example-page.md └── getting-started.md ├── _layouts ├── page.html ├── post.html └── default.html ├── .circleci ├── circle_urls.sh └── config.yml ├── _data ├── toc.yml └── quizzes │ └── example-quiz.yml ├── _posts ├── 2019-06-28-hello-world.md └── 2019-06-29-welcome.md ├── Gemfile ├── CHANGELOG.md ├── search └── search_index.json ├── LICENSE ├── README.md └── _config.yml /VERSION: -------------------------------------------------------------------------------- 1 | 0.0.16 2 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | _site 2 | Gemfile.lock 3 | -------------------------------------------------------------------------------- /assets/img/favicon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/englercj/mkdocs-jekyll/master/assets/img/favicon.png -------------------------------------------------------------------------------- /assets/img/docker-clear.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/englercj/mkdocs-jekyll/master/assets/img/docker-clear.png -------------------------------------------------------------------------------- /assets/img/mkdocs-jekyll.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/englercj/mkdocs-jekyll/master/assets/img/mkdocs-jekyll.png -------------------------------------------------------------------------------- /assets/img/discourse-forum.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/englercj/mkdocs-jekyll/master/assets/img/discourse-forum.png -------------------------------------------------------------------------------- /assets/img/macbook-preview.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/englercj/mkdocs-jekyll/master/assets/img/macbook-preview.png -------------------------------------------------------------------------------- /pages/forum.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Discussion Forum 3 | permalink: /forum/ 4 | --- 5 | 6 | {% include embed/discourse.html %} 7 | -------------------------------------------------------------------------------- /_includes/doc.html: -------------------------------------------------------------------------------- 1 | {% if include.name %}{{ include.name }}{% else %}{{ include.path }}{% endif %} 2 | -------------------------------------------------------------------------------- /_includes/alert.html: -------------------------------------------------------------------------------- 1 |
2 |

{% if include.title %}{{ include.title }}{% else %}{{ include.type }}{% endif %}

3 |

{{ include.content }}

4 |
5 | 6 | -------------------------------------------------------------------------------- /_docs/subfolder/example-page.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: A Nested Page 3 | --- 4 | 5 | # A Nested Page 6 | 7 | This is an example of a page that doesn't have a permalink defined, and 8 | is not included in the table of contents (`_data/toc.yml`). 9 | -------------------------------------------------------------------------------- /_layouts/page.html: -------------------------------------------------------------------------------- 1 | --- 2 | layout: default 3 | --- 4 |
5 |
6 | {{ content }} 7 | {% include toc.html %} 8 | {% include editable.html %} 9 |
10 |
11 | -------------------------------------------------------------------------------- /.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 | -------------------------------------------------------------------------------- /_includes/tags.html: -------------------------------------------------------------------------------- 1 | {% if site.tag_search_endpoint %}{% if page.tags %}{% endif %}{% endif %} 3 | -------------------------------------------------------------------------------- /_layouts/post.html: -------------------------------------------------------------------------------- 1 | --- 2 | layout: page 3 | --- 4 | 5 |

{{ page.title }}

6 | {% if page.badges %}{% for badge in page.badges %}{{ badge.tag }}{% endfor %}{% endif %} 7 | {{ page.date | date: "%B %d, %Y" }} 8 | {{ content }} 9 | -------------------------------------------------------------------------------- /_includes/google-analytics.html: -------------------------------------------------------------------------------- 1 | {% if site.google-analytics %} 2 | {% endif %} 9 | -------------------------------------------------------------------------------- /_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 %}

{{ quiz.title }}

{% endif %}{% for item in questions %} 3 | {% if item.type == "multiple-choice" %}{% include quiz/multiple-choice.html item=item count=forloop.index %}{% endif %}
{% endfor %} 4 | -------------------------------------------------------------------------------- /_docs/extras/index.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Extras 3 | --- 4 | 5 | # Extras 6 | 7 | Extras include other integrations that aren't relevant to style or customization, 8 | but can further enhance your documentation pages. Currently, we have support 9 | for adding interactive quizzes. 10 | 11 | - [Quizzes](example-quiz) 12 | 13 | 14 | Would you like to see another question type, or another kind of extra? Please 15 | [open an issue])({{ site.repo }}/issues/new). 16 | -------------------------------------------------------------------------------- /pages/sitemap.xml: -------------------------------------------------------------------------------- 1 | --- 2 | layout: null 3 | permalink: /sitemap.xml 4 | --- 5 | 6 | 7 | 8 | 9 | / 10 | {{ "now" | date: "%Y-%m-%d" }} 11 | daily 12 | 13 | {% for section in site.data.toc %} 14 | {{ site.baseurl }}{{ section.url }}/ 15 | {{ "now" | date: "%Y-%m-%d" }} 16 | daily 17 | 18 | {% endfor %} 19 | 20 | -------------------------------------------------------------------------------- /_data/toc.yml: -------------------------------------------------------------------------------- 1 | - title: "Getting Started" 2 | url: "docs/getting-started" 3 | children: 4 | - title: Features 5 | url: "docs/getting-started#getting-started" 6 | - title: Development 7 | url: "docs/getting-started#development" 8 | - title: Customization 9 | url: "docs/getting-started#customization" 10 | - title: "Extras" 11 | url: "docs/extras" 12 | children: 13 | - title: Quizzes 14 | url: "docs/extras/example-quiz" 15 | - title: Discussion Forum 16 | url: "forum" 17 | - title: "About" 18 | url: "about" 19 | - title: "News" 20 | url: "news" 21 | -------------------------------------------------------------------------------- /_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 | -------------------------------------------------------------------------------- /pages/about.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: About 3 | permalink: /about/ 4 | --- 5 | 6 | # About 7 | 8 | This is a starter template for a mkdocs jekyll theme, based on these two 9 | previous beauties: 10 | 11 | - [alexcarpenter/material-jekyll-theme](http://alexcarpenter.github.io/material-jekyll-theme) 12 | - [squidfunk/mkdocs-material](https://github.com/squidfunk/mkdocs-material) 13 | 14 | Specifically, I wanted a completely jekyll-based template that would render 15 | markdown docs, deployed on GitHub pages, and set up with easy customization 16 | and preview. 17 | 18 | ## Support 19 | 20 | If you need help, please don't hesitate to [open an issue](https://www.github.com/{{ site.github_repo }}/{{ site.github_user }}). 21 | 22 | -------------------------------------------------------------------------------- /_includes/embed/discourse.html: -------------------------------------------------------------------------------- 1 | 6 | 7 | # Discussion Forum 8 | 9 | What questions are being asked on {{ site.discourse_site }}? The questions 10 | below are from the {{ site.discourse_category }} category. 11 | 12 |
13 | 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /_includes/quiz/multiple-choice.html: -------------------------------------------------------------------------------- 1 |
2 |

{% if include.item.question %}{{ include.item.question }}{% else %}Question {{ include.count }}{% endif %}

3 |

{% for choice in include.item.items %}{% if choice.correct == true %}{% endif %}{{ forloop.index }}. {{ choice.choice }}{% if choice.correct == true %}{% endif %}
{% endfor %}

4 |
5 | {% if include.item.followup %}{% endif %} 6 | -------------------------------------------------------------------------------- /_includes/headers.html: -------------------------------------------------------------------------------- 1 | 24 | -------------------------------------------------------------------------------- /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 %}

{{this_year}}

11 | {% else %}{% if this_year != next_year %} 15 | 16 |

{{next_year}}

17 |