mirror of
https://github.com/snachodog/just-the-docs.git
synced 2025-04-06 04:01:22 -06:00
Merge branch 'main' into JeffGuKang-patch-1
This commit is contained in:
Patrick Marsceill
GitHub
commit
aae3d0309f
2
.github/ISSUE_TEMPLATE/config.yml
vendored
2
.github/ISSUE_TEMPLATE/config.yml
vendored
@ -1,5 +1,5 @@
|
||||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: Ask a question
|
||||
url: https://github.com/pmarsceill/just-the-docs/discussions
|
||||
url: https://github.com/just-the-docs/just-the-docs/discussions
|
||||
about: Ask questions and discuss with other community members
|
||||
|
||||
36
.github/release-drafter.yml
vendored
36
.github/release-drafter.yml
vendored
@ -1,33 +1,33 @@
|
||||
references:
|
||||
- v+
|
||||
- master
|
||||
name-template: 'v$RESOLVED_VERSION 🌈'
|
||||
tag-template: 'v$RESOLVED_VERSION'
|
||||
- main
|
||||
name-template: "v$RESOLVED_VERSION 🌈"
|
||||
tag-template: "v$RESOLVED_VERSION"
|
||||
categories:
|
||||
- title: '🚀 Features'
|
||||
- title: "🚀 Features"
|
||||
labels:
|
||||
- 'feature'
|
||||
- 'enhancement'
|
||||
- title: '🐛 Bug Fixes'
|
||||
- "feature"
|
||||
- "enhancement"
|
||||
- title: "🐛 Bug Fixes"
|
||||
labels:
|
||||
- 'fix'
|
||||
- 'bugfix'
|
||||
- 'bug'
|
||||
- title: '🧰 Maintenance'
|
||||
label:
|
||||
- 'chore'
|
||||
- 'dependencies'
|
||||
change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
|
||||
- "fix"
|
||||
- "bugfix"
|
||||
- "bug"
|
||||
- title: "🧰 Maintenance"
|
||||
label:
|
||||
- "chore"
|
||||
- "dependencies"
|
||||
change-template: "- $TITLE @$AUTHOR (#$NUMBER)"
|
||||
version-resolver:
|
||||
major:
|
||||
labels:
|
||||
- 'next-major-release'
|
||||
- "next-major-release"
|
||||
minor:
|
||||
labels:
|
||||
- 'next-minor-release'
|
||||
- "next-minor-release"
|
||||
patch:
|
||||
labels:
|
||||
- 'patch'
|
||||
- "patch"
|
||||
default: minor
|
||||
template: |
|
||||
## Changes
|
||||
|
||||
47
.github/workflows/ci-master.yml
vendored
47
.github/workflows/ci-master.yml
vendored
@ -1,45 +1,42 @@
|
||||
on:
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- master
|
||||
- main
|
||||
|
||||
name: Master branch CI
|
||||
name: main branch CI
|
||||
|
||||
jobs:
|
||||
|
||||
jekyll-latest:
|
||||
name: Build Jekyll site (latest)
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@main
|
||||
|
||||
- uses: actions/checkout@master
|
||||
|
||||
- name: Build the site in the jekyll/builder container
|
||||
run: |
|
||||
docker run --rm \
|
||||
--volume="${{ github.workspace }}:/srv/jekyll" \
|
||||
jekyll/builder:latest /bin/bash -c "gem install bundler && chmod -R 777 /srv/jekyll && bundle install && bundle exec jekyll build && bundle exec rake search:init"
|
||||
- name: Build the site in the jekyll/builder container
|
||||
run: |
|
||||
docker run --rm \
|
||||
--volume="${{ github.workspace }}:/srv/jekyll" \
|
||||
jekyll/builder:latest /bin/bash -c "gem install bundler && chmod -R 777 /srv/jekyll && bundle install && bundle exec jekyll build && bundle exec rake search:init"
|
||||
jekyll-3-8-5:
|
||||
name: Build Jekyll site (v3.8.5)
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@main
|
||||
|
||||
- uses: actions/checkout@master
|
||||
|
||||
- name: Build the site in the jekyll/builder container
|
||||
run: |
|
||||
docker run --rm \
|
||||
--volume="${{ github.workspace }}:/srv/jekyll" \
|
||||
jekyll/builder:3.8.5 /bin/bash -c "gem install bundler && chmod -R 777 /srv/jekyll && bundle install && bundle exec jekyll build && bundle exec rake search:init"
|
||||
- name: Build the site in the jekyll/builder container
|
||||
run: |
|
||||
docker run --rm \
|
||||
--volume="${{ github.workspace }}:/srv/jekyll" \
|
||||
jekyll/builder:3.8.5 /bin/bash -c "gem install bundler && chmod -R 777 /srv/jekyll && bundle install && bundle exec jekyll build && bundle exec rake search:init"
|
||||
assets:
|
||||
name: Format and test CSS and JS
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- name: Use Node.js 12.x
|
||||
uses: actions/setup-node@v1
|
||||
with:
|
||||
node-version: '12.x'
|
||||
- run: npm install
|
||||
- run: npm test
|
||||
- uses: actions/checkout@v2
|
||||
- name: Use Node.js 12.x
|
||||
uses: actions/setup-node@v1
|
||||
with:
|
||||
node-version: "12.x"
|
||||
- run: npm install
|
||||
- run: npm test
|
||||
|
||||
@ -1,30 +1,31 @@
|
||||
name: Publish Gem
|
||||
name: Publish Ruby Gem
|
||||
|
||||
on: [release]
|
||||
on:
|
||||
workflow_dispatch
|
||||
|
||||
jobs:
|
||||
build:
|
||||
name: Build + Publish
|
||||
name: Publish
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@master
|
||||
- uses: actions/checkout@v2
|
||||
- name: Set up Ruby 2.6
|
||||
uses: actions/setup-ruby@v1
|
||||
with:
|
||||
version: 2.6.x
|
||||
ruby-version: 2.6.x
|
||||
|
||||
- name: Publish to GPR
|
||||
run: |
|
||||
mkdir -p $HOME/.gem
|
||||
touch $HOME/.gem/credentials
|
||||
chmod 0600 $HOME/.gem/credentials
|
||||
printf -- "---\n:github: Bearer ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
|
||||
gem build just-the-docs.gemspec
|
||||
printf -- "---\n:github: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
|
||||
gem build *.gemspec
|
||||
gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
|
||||
env:
|
||||
GEM_HOST_API_KEY: ${{secrets.GPR_AUTH_TOKEN}}
|
||||
OWNER: pmarsceill
|
||||
GEM_HOST_API_KEY: "Bearer ${{secrets.GITHUB_TOKEN}}"
|
||||
OWNER: ${{ github.repository_owner }}
|
||||
|
||||
- name: Publish to RubyGems
|
||||
run: |
|
||||
@ -32,8 +33,7 @@ jobs:
|
||||
touch $HOME/.gem/credentials
|
||||
chmod 0600 $HOME/.gem/credentials
|
||||
printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
|
||||
gem build just-the-docs.gemspec
|
||||
gem build *.gemspec
|
||||
gem push *.gem
|
||||
env:
|
||||
GEM_HOST_API_KEY: ${{secrets.RUBYGEMS_AUTH_TOKEN}}
|
||||
|
||||
GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"
|
||||
@ -7,3 +7,4 @@ assets/css/just-the-docs-dark.scss
|
||||
assets/js/vendor/lunr.min.js
|
||||
assets/js/search-data.json
|
||||
assets/js/just-the-docs.js
|
||||
*.md
|
||||
|
||||
@ -4,5 +4,4 @@
|
||||
"singleQuote": false,
|
||||
"tabWidth": 2,
|
||||
"trailingComma": "es5"
|
||||
}
|
||||
|
||||
}
|
||||
2
404.html
2
404.html
@ -1,6 +1,6 @@
|
||||
---
|
||||
layout: default
|
||||
title: Page not found
|
||||
title: 404
|
||||
permalink: /404
|
||||
nav_exclude: true
|
||||
search_exclude: true
|
||||
|
||||
13
Dockerfile
Normal file
13
Dockerfile
Normal file
@ -0,0 +1,13 @@
|
||||
FROM ruby:2.6
|
||||
|
||||
ENV LC_ALL C.UTF-8
|
||||
ENV LANG en_US.UTF-8
|
||||
ENV LANGUAGE en_US.UTF-8
|
||||
|
||||
WORKDIR /usr/src/app
|
||||
|
||||
COPY Gemfile just-the-docs.gemspec ./
|
||||
RUN gem install bundler && bundle install
|
||||
|
||||
EXPOSE 4000
|
||||
|
||||
25
README.md
25
README.md
@ -1,11 +1,11 @@
|
||||
<p align="right">
|
||||
<a href="https://badge.fury.io/rb/just-the-docs"><img src="https://badge.fury.io/rb/just-the-docs.svg" alt="Gem version"></a> <a href="https://github.com/pmarsceill/just-the-docs/actions?query=workflow%3A%22Master+branch+CI%22"><img src="https://github.com/pmarsceill/just-the-docs/workflows/Master%20branch%20CI/badge.svg" alt="Build status"></a>
|
||||
<a href="https://badge.fury.io/rb/just-the-docs"><img src="https://badge.fury.io/rb/just-the-docs.svg" alt="Gem version"></a> <a href="https://github.com/just-the-docs/just-the-docs/actions?query=workflow%3A%22main+branch+CI%22"><img src="https://github.com/just-the-docs/just-the-docs/workflows/main%20branch%20CI/badge.svg" alt="Build status"></a>
|
||||
</p>
|
||||
<br><br>
|
||||
<p align="center">
|
||||
<h1 align="center">Just the Docs</h1>
|
||||
<p align="center">A modern, highly customizable, and responsive Jekyll theme for documentation with built-in search.<br>Easily hosted on GitHub Pages with few dependencies.</p>
|
||||
<p align="center"><strong><a href="https://pmarsceill.github.io/just-the-docs/">See it in action!</a></strong></p>
|
||||
<p align="center"><strong><a href="https://just-the-docs.github.io/just-the-docs/">See it in action!</a></strong></p>
|
||||
<br><br><br>
|
||||
</p>
|
||||
|
||||
@ -13,6 +13,17 @@
|
||||
|
||||
## Installation
|
||||
|
||||
### via GitHub Pages remote theme
|
||||
|
||||
The quickiest way to use Just The Docs is to use GitHub pages [remote theme](https://blog.github.com/2017-11-29-use-any-theme-with-github-pages/) feature in your `config.yml` file:
|
||||
|
||||
```yaml
|
||||
remote_theme: just-the-docs/just-the-docs
|
||||
```
|
||||
### via RubyGems:
|
||||
|
||||
Alternatively you can install it as a Ruby Gem.
|
||||
|
||||
Add this line to your Jekyll site's Gemfile:
|
||||
|
||||
```ruby
|
||||
@ -33,17 +44,21 @@ Or install it yourself as:
|
||||
|
||||
$ gem install just-the-docs
|
||||
|
||||
Alternatively, you can run it inside Docker while developing your site
|
||||
|
||||
$ docker-compose up
|
||||
|
||||
## Usage
|
||||
|
||||
[View the documentation](https://pmarsceill.github.io/just-the-docs/) for usage information.
|
||||
[View the documentation](https://just-the-docs.github.io/just-the-docs/) for usage information.
|
||||
|
||||
## Contributing
|
||||
|
||||
Bug reports and pull requests are welcome on GitHub at https://github.com/pmarsceill/just-the-docs. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
|
||||
Bug reports and pull requests are welcome on GitHub at https://github.com/just-the-docs/just-the-docs. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
|
||||
|
||||
### Submitting code changes:
|
||||
|
||||
- Open a [Pull Request](https://github.com/pmarsceill/just-the-docs/pulls)
|
||||
- Open a [Pull Request](https://github.com/just-the-docs/just-the-docs/pulls)
|
||||
- Ensure all CI tests pass
|
||||
- Await code review
|
||||
- Bump the version number in `just-the-docs.gemspec` and `package.json` according to [semantic versioning](https://semver.org/).
|
||||
|
||||
38
_config.yml
38
_config.yml
@ -16,10 +16,18 @@
|
||||
title: Just the Docs
|
||||
description: A Jekyll theme for documentation
|
||||
baseurl: "/just-the-docs" # the subpath of your site, e.g. /blog
|
||||
url: "https://pmarsceill.github.io" # the base hostname & protocol for your site, e.g. http://example.com
|
||||
url: "https://just-the-docs.github.io" # the base hostname & protocol for your site, e.g. http://example.com
|
||||
|
||||
permalink: pretty
|
||||
exclude: ["node_modules/", "*.gemspec", "*.gem", "Gemfile", "Gemfile.lock", "package.json", "package-lock.json", "script/", "LICENSE.txt", "lib/", "bin/", "README.md", "Rakefile"]
|
||||
exclude: ["node_modules/", "*.gemspec", "*.gem", "Gemfile", "Gemfile.lock", "package.json", "package-lock.json", "script/", "LICENSE.txt", "lib/", "bin/", "README.md", "Rakefile"
|
||||
, "docs/tests/"
|
||||
]
|
||||
|
||||
# Regression tests
|
||||
# By default, the pages in /docs/tests are excluded when the ste is built.
|
||||
# To include them, comment-out the relevant line above.
|
||||
# Uncommenting the following line doesn't work - see https://github.com/jekyll/jekyll/issues/4791
|
||||
# include: ["docs/tests/"]
|
||||
|
||||
# Set a path/url to a logo that will be displayed instead of the title
|
||||
#logo: "/assets/images/just-the-docs.png"
|
||||
@ -33,13 +41,13 @@ search:
|
||||
heading_level: 2
|
||||
# Maximum amount of previews per search result
|
||||
# Default: 3
|
||||
previews: 3
|
||||
previews: 2
|
||||
# Maximum amount of words to display before a matched word in the preview
|
||||
# Default: 5
|
||||
preview_words_before: 5
|
||||
preview_words_before: 3
|
||||
# Maximum amount of words to display after a matched word in the preview
|
||||
# Default: 10
|
||||
preview_words_after: 10
|
||||
preview_words_after: 3
|
||||
# Set the search token separator
|
||||
# Default: /[\s\-/]+/
|
||||
# Example: enable support for hyphenated search words
|
||||
@ -57,14 +65,14 @@ heading_anchors: true
|
||||
# Aux links for the upper right navigation
|
||||
aux_links:
|
||||
"Just the Docs on GitHub":
|
||||
- "//github.com/pmarsceill/just-the-docs"
|
||||
- "//github.com/just-the-docs/just-the-docs"
|
||||
|
||||
# Makes Aux links open in a new tab. Default is false
|
||||
aux_links_new_tab: false
|
||||
|
||||
# Sort order for navigation links
|
||||
nav_sort: case_insensitive # default, equivalent to nil
|
||||
# nav_sort: case_sensitive # Capital letters sorted before lowercase
|
||||
# nav_sort: case_insensitive # default, equivalent to nil
|
||||
nav_sort: case_sensitive # Capital letters sorted before lowercase
|
||||
|
||||
# Footer content
|
||||
# appears at the bottom of every page's main content
|
||||
@ -73,7 +81,7 @@ nav_sort: case_insensitive # default, equivalent to nil
|
||||
back_to_top: true
|
||||
back_to_top_text: "Back to top"
|
||||
|
||||
footer_content: "Copyright © 2017-2020 Patrick Marsceill. Distributed by an <a href=\"https://github.com/pmarsceill/just-the-docs/tree/master/LICENSE.txt\">MIT license.</a>"
|
||||
footer_content: "Copyright © 2017-2020 Patrick Marsceill. Distributed by an <a href=\"https://github.com/just-the-docs/just-the-docs/tree/main/LICENSE.txt\">MIT license.</a>"
|
||||
|
||||
# Footer last edited timestamp
|
||||
last_edit_timestamp: true # show or hide edit time - page must have `last_modified_date` defined in the frontmatter
|
||||
@ -84,8 +92,9 @@ last_edit_time_format: "%b %e %Y at %I:%M %p" # uses ruby's time format: https:/
|
||||
# Footer "Edit this page on GitHub" link text
|
||||
gh_edit_link: true # show or hide edit this page link
|
||||
gh_edit_link_text: "Edit this page on GitHub"
|
||||
gh_edit_repository: "https://github.com/pmarsceill/just-the-docs" # the github URL for your repo
|
||||
gh_edit_branch: "master" # the branch that your docs is served from
|
||||
gh_edit_repository: "https://github.com/just-the-docs/just-the-docs" # the github URL for your repo
|
||||
gh_edit_branch: "main" # the branch that your docs is served from
|
||||
# gh_edit_source: docs # the source that your files originate from
|
||||
gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately
|
||||
|
||||
# Color scheme currently only supports "dark", "light"/nil (default), or a custom scheme that you define
|
||||
@ -99,6 +108,11 @@ ga_tracking_anonymize_ip: true # Use GDPR compliant Google Analytics settings (t
|
||||
plugins:
|
||||
- jekyll-seo-tag
|
||||
|
||||
kramdown:
|
||||
syntax_highlighter_opts:
|
||||
block:
|
||||
line_numbers: false
|
||||
|
||||
compress_html:
|
||||
clippings: all
|
||||
comments: all
|
||||
@ -106,3 +120,5 @@ compress_html:
|
||||
startings: []
|
||||
blanklines: false
|
||||
profile: false
|
||||
# ignore:
|
||||
# envs: all
|
||||
|
||||
65
_includes/fix_linenos.html
Normal file
65
_includes/fix_linenos.html
Normal file
@ -0,0 +1,65 @@
|
||||
{%- comment -%}
|
||||
This file can be used to fix the HTML produced by Jekyll for highlighted
|
||||
code with line numbers.
|
||||
|
||||
It works with `{% highlight some_language linenos %}...{% endhighlight %}`
|
||||
and with the Kramdown option to add line numbers to fenced code.
|
||||
|
||||
The implementation was derived from the workaround provided by
|
||||
Dmitry Hrabrov (DeXP) at
|
||||
https://github.com/penibelst/jekyll-compress-html/issues/71#issuecomment-188144901
|
||||
|
||||
EXPLANATION
|
||||
|
||||
The HTML produced by Rouge highlighting with lie numbers is of the form
|
||||
`code table`. Jekyll (<= 4.1.1) always wraps the highlighted HTML
|
||||
with `pre`. This wrapping is not only unnecessary, but also transforms
|
||||
the conforming HTML produced by Rouge to non-conforming HTML, which
|
||||
results in HTML validation error reports.
|
||||
|
||||
The fix removes the outer `pre` tags whenever they contain the pattern
|
||||
`<table class="rouge-table">`.
|
||||
|
||||
Apart from avoiding HTML validation errors, the fix allows the use of
|
||||
the [Jekyll layout for compressing HTML](http://jch.penibelst.de),
|
||||
which relies on `pre` tags not being nested, according to
|
||||
https://github.com/penibelst/jekyll-compress-html/issues/71#issuecomment-172069842
|
||||
|
||||
USAGE
|
||||
|
||||
(Any names can be used for `some_var` and `some_language`.)
|
||||
|
||||
{% capture some_var %}
|
||||
{% highlight some_language linenos %}
|
||||
Some code
|
||||
{% endhighlight %}
|
||||
{% endcapture %}
|
||||
{% include fix_linenos.html code=some_var %}
|
||||
|
||||
For code fences:
|
||||
|
||||
{% capture some_var %}
|
||||
```some_language
|
||||
Some code
|
||||
```
|
||||
{% endcapture %}
|
||||
{% assign some_var = some_var | markdownify %}
|
||||
{% include fix_linenos.html code=some_var %}
|
||||
|
||||
CAVEATS
|
||||
|
||||
The above does not work when `Some code` happens to contain the matched string
|
||||
`<table class="rouge-table">`.
|
||||
|
||||
The use of this file overwrites the variable `fix_linenos_code` with `nil`.
|
||||
|
||||
{%- endcomment -%}
|
||||
|
||||
{% assign fix_linenos_code = include.code %}
|
||||
{% if fix_linenos_code contains '<table class="rouge-table">' %}
|
||||
{% assign fix_linenos_code = fix_linenos_code | replace: '<pre class="highlight">', '<pre>' %}
|
||||
{% assign fix_linenos_code = fix_linenos_code | replace: "<pre><code", "<code" %}
|
||||
{% assign fix_linenos_code = fix_linenos_code | replace: "</code></pre>", "</code>" %}
|
||||
{% endif %}
|
||||
{{ fix_linenos_code }}
|
||||
{% assign fix_linenos_code = nil %}
|
||||
3
_includes/footer_custom.html
Normal file
3
_includes/footer_custom.html
Normal file
@ -0,0 +1,3 @@
|
||||
{%- if site.footer_content -%}
|
||||
<p class="text-small text-grey-dk-100 mb-0">{{ site.footer_content }}</p>
|
||||
{%- endif -%}
|
||||
@ -10,9 +10,9 @@
|
||||
{% endif %}
|
||||
{% endunless %}
|
||||
|
||||
<link rel="shortcut icon" href="{{ 'favicon.ico' | absolute_url }}" type="image/x-icon">
|
||||
<link rel="shortcut icon" href="{{ 'favicon.ico' | relative_url }}" type="image/x-icon">
|
||||
|
||||
<link rel="stylesheet" href="{{ '/assets/css/just-the-docs-default.css' | absolute_url }}">
|
||||
<link rel="stylesheet" href="{{ '/assets/css/just-the-docs-default.css' | relative_url }}">
|
||||
|
||||
{% if site.ga_tracking != nil %}
|
||||
<script async src="https://www.googletagmanager.com/gtag/js?id={{ site.ga_tracking }}"></script>
|
||||
@ -27,9 +27,9 @@
|
||||
{% endif %}
|
||||
|
||||
{% if site.search_enabled != false %}
|
||||
<script type="text/javascript" src="{{ '/assets/js/vendor/lunr.min.js' | absolute_url }}"></script>
|
||||
<script type="text/javascript" src="{{ '/assets/js/vendor/lunr.min.js' | relative_url }}"></script>
|
||||
{% endif %}
|
||||
<script type="text/javascript" src="{{ '/assets/js/just-the-docs.js' | absolute_url }}"></script>
|
||||
<script type="text/javascript" src="{{ '/assets/js/just-the-docs.js' | relative_url }}"></script>
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
|
||||
|
||||
0
_includes/header_custom.html
Normal file
0
_includes/header_custom.html
Normal file
@ -1,55 +1,99 @@
|
||||
<ul class="nav-list">
|
||||
{%- assign ordered_pages_list = site.html_pages | where_exp:"item", "item.nav_order != nil" -%}
|
||||
{%- assign unordered_pages_list = site.html_pages | where_exp:"item", "item.nav_order == nil" -%}
|
||||
{%- assign titled_pages = include.pages
|
||||
| where_exp:"item", "item.title != nil" -%}
|
||||
|
||||
{%- comment -%}
|
||||
The values of `title` and `nav_order` can be numbers or strings.
|
||||
Jekyll gives build failures when sorting on mixtures of different types,
|
||||
so numbers and strings need to be sorted separately.
|
||||
|
||||
Here, numbers are sorted by their values, and come before all strings.
|
||||
An omitted `nav_order` value is equivalent to the page's `title` value
|
||||
(except that a numerical `title` value is treated as a string).
|
||||
|
||||
The case-sensitivity of string sorting is determined by `site.nav_sort`.
|
||||
{%- endcomment -%}
|
||||
|
||||
{%- assign string_ordered_pages = titled_pages
|
||||
| where_exp:"item", "item.nav_order == nil" -%}
|
||||
{%- assign nav_ordered_pages = titled_pages
|
||||
| where_exp:"item", "item.nav_order != nil" -%}
|
||||
|
||||
{%- comment -%}
|
||||
The nav_ordered_pages have to be added to number_ordered_pages and
|
||||
string_ordered_pages, depending on the nav_order value.
|
||||
The first character of the jsonify result is `"` only for strings.
|
||||
{%- endcomment -%}
|
||||
{%- assign nav_ordered_groups = nav_ordered_pages
|
||||
| group_by_exp:"item", "item.nav_order | jsonify | slice: 0" -%}
|
||||
{%- assign number_ordered_pages = "" | split:"X" -%}
|
||||
{%- for group in nav_ordered_groups -%}
|
||||
{%- if group.name == '"' -%}
|
||||
{%- assign string_ordered_pages = string_ordered_pages | concat: group.items -%}
|
||||
{%- else -%}
|
||||
{%- assign number_ordered_pages = number_ordered_pages | concat: group.items -%}
|
||||
{%- endif -%}
|
||||
{%- endfor -%}
|
||||
|
||||
{%- assign sorted_number_ordered_pages = number_ordered_pages | sort:"nav_order" -%}
|
||||
|
||||
{%- comment -%}
|
||||
The string_ordered_pages have to be sorted by nav_order, and otherwise title
|
||||
(where appending the empty string to a numeric title converts it to a string).
|
||||
After grouping them by those values, the groups are sorted, then the items
|
||||
of each group are concatenated.
|
||||
{%- endcomment -%}
|
||||
{%- assign string_ordered_groups = string_ordered_pages
|
||||
| group_by_exp:"item", "item.nav_order | default: item.title | append:''" -%}
|
||||
{%- if site.nav_sort == 'case_insensitive' -%}
|
||||
{%- assign sorted_ordered_pages_list = ordered_pages_list | sort_natural:"nav_order" -%}
|
||||
{%- assign sorted_unordered_pages_list = unordered_pages_list | sort_natural:"title" -%}
|
||||
{%- assign sorted_string_ordered_groups = string_ordered_groups | sort_natural:"name" -%}
|
||||
{%- else -%}
|
||||
{%- assign sorted_ordered_pages_list = ordered_pages_list | sort:"nav_order" -%}
|
||||
{%- assign sorted_unordered_pages_list = unordered_pages_list | sort:"title" -%}
|
||||
{%- assign sorted_string_ordered_groups = string_ordered_groups | sort:"name" -%}
|
||||
{%- endif -%}
|
||||
{%- assign pages_list = sorted_ordered_pages_list | concat: sorted_unordered_pages_list -%}
|
||||
{%- assign sorted_string_ordered_pages = "" | split:"X" -%}
|
||||
{%- for group in sorted_string_ordered_groups -%}
|
||||
{%- assign sorted_string_ordered_pages = sorted_string_ordered_pages | concat: group.items -%}
|
||||
{%- endfor -%}
|
||||
|
||||
{%- assign pages_list = sorted_number_ordered_pages | concat: sorted_string_ordered_pages -%}
|
||||
|
||||
{%- for node in pages_list -%}
|
||||
{%- unless node.nav_exclude -%}
|
||||
{%- if node.parent == nil and node.title -%}
|
||||
<li class="nav-list-item{% if page.url == node.url or page.parent == node.title or page.grand_parent == node.title %} active{% endif %}">
|
||||
{%- if page.parent == node.title or page.grand_parent == node.title -%}
|
||||
{%- assign first_level_url = node.url | absolute_url -%}
|
||||
{%- endif -%}
|
||||
{%- if node.has_children -%}
|
||||
<a href="#" class="nav-list-expander"><svg viewBox="0 0 24 24"><use xlink:href="#svg-arrow-right"></use></svg></a>
|
||||
{%- endif -%}
|
||||
<a href="{{ node.url | absolute_url }}" class="nav-list-link{% if page.url == node.url %} active{% endif %}">{{ node.title }}</a>
|
||||
{%- if node.has_children -%}
|
||||
{%- assign children_list = pages_list | where: "parent", node.title -%}
|
||||
<ul class="nav-list ">
|
||||
{%- for child in children_list -%}
|
||||
{%- unless child.nav_exclude -%}
|
||||
<li class="nav-list-item {% if page.url == child.url or page.parent == child.title %} active{% endif %}">
|
||||
{%- if page.url == child.url or page.parent == child.title -%}
|
||||
{%- assign second_level_url = child.url | absolute_url -%}
|
||||
{%- endif -%}
|
||||
{%- if child.has_children -%}
|
||||
<a href="#" class="nav-list-expander"><svg viewBox="0 0 24 24"><use xlink:href="#svg-arrow-right"></use></svg></a>
|
||||
{%- endif -%}
|
||||
<a href="{{ child.url | absolute_url }}" class="nav-list-link{% if page.url == child.url %} active{% endif %}">{{ child.title }}</a>
|
||||
{%- if child.has_children -%}
|
||||
{%- assign grand_children_list = pages_list | where: "parent", child.title | where: "grand_parent", node.title -%}
|
||||
<ul class="nav-list">
|
||||
{%- for grand_child in grand_children_list -%}
|
||||
<li class="nav-list-item {% if page.url == grand_child.url %} active{% endif %}">
|
||||
<a href="{{ grand_child.url | absolute_url }}" class="nav-list-link{% if page.url == grand_child.url %} active{% endif %}">{{ grand_child.title }}</a>
|
||||
</li>
|
||||
{%- endfor -%}
|
||||
</ul>
|
||||
{%- endif -%}
|
||||
</li>
|
||||
{%- endunless -%}
|
||||
{%- endfor -%}
|
||||
</ul>
|
||||
{%- endif -%}
|
||||
</li>
|
||||
{%- endif -%}
|
||||
{%- endunless -%}
|
||||
{%- if node.parent == nil -%}
|
||||
{%- unless node.nav_exclude -%}
|
||||
<li class="nav-list-item{% if page.url == node.url or page.parent == node.title or page.grand_parent == node.title %} active{% endif %}">
|
||||
{%- if node.has_children -%}
|
||||
<a href="#" class="nav-list-expander"><svg viewBox="0 0 24 24"><use xlink:href="#svg-arrow-right"></use></svg></a>
|
||||
{%- endif -%}
|
||||
<a href="{{ node.url | absolute_url }}" class="nav-list-link{% if page.url == node.url %} active{% endif %}">{{ node.title }}</a>
|
||||
{%- if node.has_children -%}
|
||||
{%- assign children_list = pages_list | where: "parent", node.title -%}
|
||||
<ul class="nav-list ">
|
||||
{%- for child in children_list -%}
|
||||
{%- unless child.nav_exclude -%}
|
||||
<li class="nav-list-item {% if page.url == child.url or page.parent == child.title %} active{% endif %}">
|
||||
{%- if child.has_children -%}
|
||||
<a href="#" class="nav-list-expander"><svg viewBox="0 0 24 24"><use xlink:href="#svg-arrow-right"></use></svg></a>
|
||||
{%- endif -%}
|
||||
<a href="{{ child.url | absolute_url }}" class="nav-list-link{% if page.url == child.url %} active{% endif %}">{{ child.title }}</a>
|
||||
{%- if child.has_children -%}
|
||||
{%- assign grand_children_list = pages_list | where: "parent", child.title | where: "grand_parent", node.title -%}
|
||||
<ul class="nav-list">
|
||||
{%- for grand_child in grand_children_list -%}
|
||||
{%- unless grand_child.nav_exclude -%}
|
||||
<li class="nav-list-item {% if page.url == grand_child.url %} active{% endif %}">
|
||||
<a href="{{ grand_child.url | absolute_url }}" class="nav-list-link{% if page.url == grand_child.url %} active{% endif %}">{{ grand_child.title }}</a>
|
||||
</li>
|
||||
{%- endunless -%}
|
||||
{%- endfor -%}
|
||||
</ul>
|
||||
{%- endif -%}
|
||||
</li>
|
||||
{%- endunless -%}
|
||||
{%- endfor -%}
|
||||
</ul>
|
||||
{%- endif -%}
|
||||
</li>
|
||||
{%- endunless -%}
|
||||
{%- endif -%}
|
||||
{%- endfor -%}
|
||||
</ul>
|
||||
|
||||
60
_includes/vendor/anchor_headings.html
vendored
60
_includes/vendor/anchor_headings.html
vendored
@ -1,18 +1,44 @@
|
||||
{% capture headingsWorkspace %}
|
||||
{% comment %}
|
||||
Version 1.0.3
|
||||
Copyright (c) 2018 Vladimir "allejo" Jimenez
|
||||
|
||||
Permission is hereby granted, free of charge, to any person
|
||||
obtaining a copy of this software and associated documentation
|
||||
files (the "Software"), to deal in the Software without
|
||||
restriction, including without limitation the rights to use,
|
||||
copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the
|
||||
Software is furnished to do so, subject to the following
|
||||
conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be
|
||||
included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
|
||||
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
||||
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
|
||||
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
||||
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
||||
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
||||
OTHER DEALINGS IN THE SOFTWARE.
|
||||
{% endcomment %}
|
||||
{% comment %}
|
||||
Version 1.0.7
|
||||
https://github.com/allejo/jekyll-anchor-headings
|
||||
|
||||
"Be the pull request you wish to see in the world." ~Ben Balter
|
||||
|
||||
Usage:
|
||||
{% include anchor_headings.html html=content %}
|
||||
{% include anchor_headings.html html=content anchorBody="#" %}
|
||||
|
||||
Parameters:
|
||||
* html (string) - the HTML of compiled markdown generated by kramdown in Jekyll
|
||||
|
||||
Optional Parameters:
|
||||
* beforeHeading (bool) : false - Set to true if the anchor should be placed _before_ the heading's content
|
||||
* anchorAttrs (string) : '' - Any custom HTML attributes that will be added to the `<a>` tag; you may NOT use `href`, `class` or `title`;
|
||||
the `%heading%` and `%html_id%` placeholders are available
|
||||
* anchorBody (string) : '' - The content that will be placed inside the anchor; the `%heading%` placeholder is available
|
||||
* anchorClass (string) : '' - The class(es) that will be used for each anchor. Separate multiple classes with a space
|
||||
* anchorTitle (string) : '' - The `title` attribute that will be used for anchors
|
||||
@ -42,17 +68,22 @@
|
||||
{% assign nextChar = node | replace: '"', '' | strip | slice: 0, 1 %}
|
||||
{% assign headerLevel = nextChar | times: 1 %}
|
||||
|
||||
<!-- If the level is cast to 0, it means it's not a h1-h6 tag, so let's try to fix it -->
|
||||
<!-- If the level is cast to 0, it means it's not a h1-h6 tag, so let's see if we need to fix it -->
|
||||
{% if headerLevel == 0 %}
|
||||
{% if nextChar != '<' and nextChar != '' %}
|
||||
<!-- Split up the node based on closing angle brackets and get the first one. -->
|
||||
{% assign firstChunk = node | split: '>' | first %}
|
||||
|
||||
<!-- If the first chunk does NOT contain a '<', that means we've broken another HTML tag that starts with 'h' -->
|
||||
{% unless firstChunk contains '<' %}
|
||||
{% capture node %}<h{{ node }}{% endcapture %}
|
||||
{% endif %}
|
||||
{% endunless %}
|
||||
|
||||
{% capture edited_headings %}{{ edited_headings }}{{ node }}{% endcapture %}
|
||||
{% continue %}
|
||||
{% endif %}
|
||||
|
||||
{% assign _workspace = node | split: '</h' %}
|
||||
{% capture _closingTag %}</h{{ headerLevel }}>{% endcapture %}
|
||||
{% assign _workspace = node | split: _closingTag %}
|
||||
{% assign _idWorkspace = _workspace[0] | split: 'id="' %}
|
||||
{% assign _idWorkspace = _idWorkspace[1] | split: '"' %}
|
||||
{% assign html_id = _idWorkspace[0] %}
|
||||
@ -64,7 +95,7 @@
|
||||
{% capture anchor %}{% endcapture %}
|
||||
|
||||
{% if html_id and headerLevel >= minHeader and headerLevel <= maxHeader %}
|
||||
{% capture anchor %}href="#{{ html_id}}" aria-labelledby="{{ html_id}}"{% endcapture %}
|
||||
{% capture anchor %}href="#{{ html_id }}"{% endcapture %}
|
||||
|
||||
{% if include.anchorClass %}
|
||||
{% capture anchor %}{{ anchor }} class="{{ include.anchorClass }}"{% endcapture %}
|
||||
@ -74,6 +105,10 @@
|
||||
{% capture anchor %}{{ anchor }} title="{{ include.anchorTitle | replace: '%heading%', header }}"{% endcapture %}
|
||||
{% endif %}
|
||||
|
||||
{% if include.anchorAttrs %}
|
||||
{% capture anchor %}{{ anchor }} {{ include.anchorAttrs | replace: '%heading%', header | replace: '%html_id%', html_id }}{% endcapture %}
|
||||
{% endif %}
|
||||
|
||||
{% capture anchor %}<a {{ anchor }}>{{ include.anchorBody | replace: '%heading%', header | default: '' }}</a>{% endcapture %}
|
||||
|
||||
<!-- In order to prevent adding extra space after a heading, we'll let the 'anchor' value contain it -->
|
||||
@ -93,8 +128,17 @@
|
||||
{{ header }}{{ anchor }}
|
||||
{% endif %}
|
||||
{{ include.bodySuffix }}
|
||||
</h{{ _workspace | last }}
|
||||
</h{{ headerLevel }}>
|
||||
{% endcapture %}
|
||||
|
||||
<!--
|
||||
If we have content after the `</hX>` tag, then we'll want to append that here so we don't lost any content.
|
||||
-->
|
||||
{% assign chunkCount = _workspace | size %}
|
||||
{% if chunkCount > 1 %}
|
||||
{% capture new_heading %}{{ new_heading }}{{ _workspace | last }}{% endcapture %}
|
||||
{% endif %}
|
||||
|
||||
{% capture edited_headings %}{{ edited_headings }}{{ new_heading }}{% endcapture %}
|
||||
{% endfor %}
|
||||
{% endcapture %}{% assign headingsWorkspace = '' %}{{ edited_headings | strip }}
|
||||
|
||||
@ -48,10 +48,25 @@ layout: table_wrappers
|
||||
</a>
|
||||
</div>
|
||||
<nav role="navigation" aria-label="Main" id="site-nav" class="site-nav">
|
||||
{% include nav.html %}
|
||||
{% if site.just_the_docs.collections %}
|
||||
{% assign collections_size = site.just_the_docs.collections | size %}
|
||||
{% for collection_entry in site.just_the_docs.collections %}
|
||||
{% assign collection_key = collection_entry[0] %}
|
||||
{% assign collection_value = collection_entry[1] %}
|
||||
{% assign collection = site[collection_key] %}
|
||||
{% if collection_value.nav_exclude != true %}
|
||||
{% if collections_size > 1 %}
|
||||
<div class="nav-category">{{ collection_value.name }}</div>
|
||||
{% endif %}
|
||||
{% include nav.html pages=collection %}
|
||||
{% endif %}
|
||||
{% endfor %}
|
||||
{% else %}
|
||||
{% include nav.html pages=site.html_pages %}
|
||||
{% endif %}
|
||||
</nav>
|
||||
<footer class="site-footer">
|
||||
This site uses <a href="https://github.com/pmarsceill/just-the-docs">Just the Docs</a>, a documentation theme for Jekyll.
|
||||
This site uses <a href="https://github.com/just-the-docs/just-the-docs">Just the Docs</a>, a documentation theme for Jekyll.
|
||||
</footer>
|
||||
</div>
|
||||
<div class="main" id="top">
|
||||
@ -65,6 +80,7 @@ layout: table_wrappers
|
||||
<div id="search-results" class="search-results"></div>
|
||||
</div>
|
||||
{% endif %}
|
||||
{% include header_custom.html %}
|
||||
{% if site.aux_links %}
|
||||
<nav aria-label="Auxiliary" class="aux-nav">
|
||||
<ul class="aux-nav-list">
|
||||
@ -86,6 +102,21 @@ layout: table_wrappers
|
||||
<div id="main-content-wrap" class="main-content-wrap">
|
||||
{% unless page.url == "/" %}
|
||||
{% if page.parent %}
|
||||
{%- for node in pages_list -%}
|
||||
{%- if node.parent == nil -%}
|
||||
{%- if page.parent == node.title or page.grand_parent == node.title -%}
|
||||
{%- assign first_level_url = node.url | absolute_url -%}
|
||||
{%- endif -%}
|
||||
{%- if node.has_children -%}
|
||||
{%- assign children_list = pages_list | where: "parent", node.title -%}
|
||||
{%- for child in children_list -%}
|
||||
{%- if page.url == child.url or page.parent == child.title -%}
|
||||
{%- assign second_level_url = child.url | absolute_url -%}
|
||||
{%- endif -%}
|
||||
{%- endfor -%}
|
||||
{%- endif -%}
|
||||
{%- endif -%}
|
||||
{%- endfor -%}
|
||||
<nav aria-label="Breadcrumb" class="breadcrumb-nav">
|
||||
<ol class="breadcrumb-nav-list">
|
||||
{% if page.grand_parent %}
|
||||
@ -101,7 +132,7 @@ layout: table_wrappers
|
||||
{% endunless %}
|
||||
<div id="main-content" class="main-content" role="main">
|
||||
{% if site.heading_anchors != false %}
|
||||
{% include vendor/anchor_headings.html html=content beforeHeading="true" anchorBody="<svg viewBox=\"0 0 16 16\" aria-hidden=\"true\"><use xlink:href=\"#svg-link\"></use></svg>" anchorClass="anchor-heading" %}
|
||||
{% include vendor/anchor_headings.html html=content beforeHeading="true" anchorBody="<svg viewBox=\"0 0 16 16\" aria-hidden=\"true\"><use xlink:href=\"#svg-link\"></use></svg>" anchorClass="anchor-heading" anchorAttrs="aria-labelledby=\"%html_id%\"" %}
|
||||
{% else %}
|
||||
{{ content }}
|
||||
{% endif %}
|
||||
@ -119,15 +150,17 @@ layout: table_wrappers
|
||||
</ul>
|
||||
{% endif %}
|
||||
|
||||
{% if site.footer_content != nil or site.last_edit_timestamp or site.gh_edit_link %}
|
||||
{% capture footer_custom %}
|
||||
{%- include footer_custom.html -%}
|
||||
{% endcapture %}
|
||||
{% if footer_custom != "" or site.last_edit_timestamp or site.gh_edit_link %}
|
||||
<hr>
|
||||
<footer>
|
||||
{% if site.back_to_top %}
|
||||
<p><a href="#top" id="back-to-top">{{ site.back_to_top_text }}</a></p>
|
||||
{% endif %}
|
||||
{% if site.footer_content != nil %}
|
||||
<p class="text-small text-grey-dk-000 mb-0">{{ site.footer_content }}</p>
|
||||
{% endif %}
|
||||
|
||||
{{ footer_custom }}
|
||||
|
||||
{% if site.last_edit_timestamp or site.gh_edit_link %}
|
||||
<div class="d-flex mt-2">
|
||||
@ -144,7 +177,7 @@ layout: table_wrappers
|
||||
site.gh_edit_view_mode
|
||||
%}
|
||||
<p class="text-small text-grey-dk-000 mb-0">
|
||||
<a href="{{ site.gh_edit_repository }}/{{ site.gh_edit_view_mode }}/{{ site.gh_edit_branch }}/{{ page.path }}" id="edit-this-page">{{ site.gh_edit_link_text }}</a>
|
||||
<a href="{{ site.gh_edit_repository }}/{{ site.gh_edit_view_mode }}/{{ site.gh_edit_branch }}{% if site.gh_edit_source %}/{{ site.gh_edit_source }}{% endif %}/{{ page.path }}" id="edit-this-page">{{ site.gh_edit_link_text }}</a>
|
||||
</p>
|
||||
{% endif %}
|
||||
</div>
|
||||
|
||||
@ -11,23 +11,102 @@ code {
|
||||
border-radius: $border-radius;
|
||||
}
|
||||
|
||||
pre.highlight,
|
||||
figure.highlight {
|
||||
// Avoid appearance of dark border around visited code links in Safari
|
||||
a:visited code {
|
||||
border-color: $border-color;
|
||||
}
|
||||
|
||||
// Content structure for highlighted code blocks using fences or Liquid
|
||||
//
|
||||
// ```[LANG]...```, no kramdown line_numbers:
|
||||
// div.[language-LANG.]highlighter-rouge > div.highlight > pre.highlight > code
|
||||
//
|
||||
// ```[LANG]...```, kramdown line_numbers = true:
|
||||
// div.[language-LANG.]highlighter-rouge > div.highlight > pre.highlight > code
|
||||
// > div.table-wrapper > table.rouge-table > tbody > tr
|
||||
// > td.rouge-gutter.gl > pre.lineno
|
||||
// | td.rouge-code > pre
|
||||
//
|
||||
// {% highlight LANG %}...{% endhighlight %}:
|
||||
// figure.highlight > pre > code.language-LANG
|
||||
//
|
||||
// {% highlight LANG linenos %}...{% endhighlight %}:
|
||||
// figure.highlight > pre > code.language-LANG
|
||||
// > div.table-wrapper > table.rouge-table > tbody > tr
|
||||
// > td.gutter.gl > pre.lineno
|
||||
// | td.code > pre
|
||||
//
|
||||
// fix_linenos removes the outermost pre when it encloses table.rouge-table
|
||||
//
|
||||
// See docs/index-test.md for some tests.
|
||||
//
|
||||
// No kramdown line_numbers: fences and Liquid highlighting look the same.
|
||||
// Kramdown line_numbers = true: fences have a wider gutter than with Liquid?
|
||||
|
||||
// ```[LANG]...```
|
||||
div.highlighter-rouge {
|
||||
padding: $sp-3;
|
||||
margin-top: 0;
|
||||
margin-bottom: 0;
|
||||
margin-bottom: $sp-3;
|
||||
overflow-x: auto;
|
||||
background-color: $code-background-color;
|
||||
border-radius: $border-radius;
|
||||
box-shadow: none;
|
||||
-webkit-overflow-scrolling: touch;
|
||||
|
||||
div.highlight,
|
||||
pre.highlight,
|
||||
code {
|
||||
padding: 0;
|
||||
margin: 0;
|
||||
border: 0;
|
||||
}
|
||||
}
|
||||
|
||||
.highlighter-rouge {
|
||||
// {% highlight LANG %}...{% endhighlight %},
|
||||
// {% highlight LANG linenos %}...{% endhighlight %}:
|
||||
figure.highlight {
|
||||
padding: $sp-3;
|
||||
margin-top: 0;
|
||||
margin-bottom: $sp-3;
|
||||
background-color: $code-background-color;
|
||||
border-radius: $border-radius;
|
||||
box-shadow: none;
|
||||
-webkit-overflow-scrolling: touch;
|
||||
|
||||
pre,
|
||||
code {
|
||||
padding: 0;
|
||||
margin: 0;
|
||||
border: 0;
|
||||
}
|
||||
}
|
||||
|
||||
// ```[LANG]...```, kramdown line_numbers = true,
|
||||
// {% highlight LANG linenos %}...{% endhighlight %}:
|
||||
.highlight .table-wrapper {
|
||||
padding: 0;
|
||||
margin: 0;
|
||||
border: 0;
|
||||
box-shadow: none;
|
||||
|
||||
td,
|
||||
pre {
|
||||
@include fs-2;
|
||||
min-width: 0;
|
||||
padding: 0;
|
||||
background-color: $code-background-color;
|
||||
border: 0;
|
||||
}
|
||||
|
||||
td.gl {
|
||||
padding-right: $sp-3;
|
||||
}
|
||||
|
||||
pre {
|
||||
margin: 0;
|
||||
line-height: 2;
|
||||
}
|
||||
}
|
||||
|
||||
.highlight .c {
|
||||
|
||||
@ -109,7 +109,7 @@
|
||||
|
||||
dl {
|
||||
display: grid;
|
||||
grid-template-columns: max-content 1fr;
|
||||
grid-template: auto / 10em 1fr;
|
||||
}
|
||||
|
||||
dt,
|
||||
@ -118,16 +118,50 @@
|
||||
}
|
||||
|
||||
dt {
|
||||
grid-column: 1;
|
||||
font-weight: 500;
|
||||
text-align: right;
|
||||
|
||||
&::after {
|
||||
content: ":";
|
||||
}
|
||||
}
|
||||
|
||||
dd {
|
||||
grid-column: 2;
|
||||
margin-bottom: 0;
|
||||
margin-left: 1em;
|
||||
font-weight: 500;
|
||||
blockquote,
|
||||
div,
|
||||
dl,
|
||||
dt,
|
||||
h1,
|
||||
h2,
|
||||
h3,
|
||||
h4,
|
||||
h5,
|
||||
h6,
|
||||
li,
|
||||
ol,
|
||||
p,
|
||||
pre,
|
||||
table,
|
||||
ul,
|
||||
.table-wrapper {
|
||||
&:first-child {
|
||||
margin-top: 0;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
dd,
|
||||
ol,
|
||||
ul {
|
||||
dl:first-child {
|
||||
dt:first-child,
|
||||
dd:nth-child(2) {
|
||||
margin-top: 0;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
.anchor-heading {
|
||||
|
||||
@ -131,6 +131,29 @@
|
||||
}
|
||||
}
|
||||
|
||||
.nav-category {
|
||||
padding-top: $sp-2;
|
||||
padding-right: $gutter-spacing-sm;
|
||||
padding-bottom: $sp-2;
|
||||
padding-left: $gutter-spacing-sm;
|
||||
font-weight: 600;
|
||||
text-align: end;
|
||||
text-transform: uppercase;
|
||||
border-bottom: $border $border-color;
|
||||
@include fs-2;
|
||||
|
||||
@include mq(md) {
|
||||
padding-right: $gutter-spacing;
|
||||
padding-left: $gutter-spacing;
|
||||
margin-top: $gutter-spacing-sm;
|
||||
text-align: start;
|
||||
|
||||
&:first-child {
|
||||
margin-top: 0;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Aux nav
|
||||
|
||||
.aux-nav {
|
||||
|
||||
@ -284,13 +284,13 @@
|
||||
background-color: $search-background-color;
|
||||
|
||||
@include mq(md) {
|
||||
padding-left: #{$sp-4 * 1.25 + $sp-5};
|
||||
padding-left: 2.3rem;
|
||||
}
|
||||
}
|
||||
|
||||
.search-label {
|
||||
@include mq(md) {
|
||||
padding-left: #{$sp-4 * 1.25};
|
||||
padding-left: 0.6rem;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@ -2,14 +2,32 @@
|
||||
// Typography
|
||||
//
|
||||
|
||||
$body-font-family: -apple-system, BlinkMacSystemFont, "helvetica neue",
|
||||
helvetica, roboto, noto, "segoe ui", arial, sans-serif !default;
|
||||
$body-font-family: system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI",
|
||||
Roboto, "Helvetica Neue", Arial, sans-serif !default;
|
||||
$mono-font-family: "SFMono-Regular", Menlo, Consolas, Monospace !default;
|
||||
$root-font-size: 16px !default; // Base font-size for rems
|
||||
$body-line-height: 1.4 !default;
|
||||
$content-line-height: 1.6 !default;
|
||||
$body-heading-line-height: 1.25 !default;
|
||||
|
||||
//
|
||||
// Font size
|
||||
// `-sm` suffix is the size at the small (and above) media query
|
||||
//
|
||||
|
||||
$font-size-1: 9px !default;
|
||||
$font-size-1-sm: 10px !default;
|
||||
$font-size-2: 11px !default; //h4 - uppercased!, h6 not uppercased, text-small
|
||||
$font-size-3: 12px !default; //h5
|
||||
$font-size-4: 14px !default;
|
||||
$font-size-5: 16px !default; //h3
|
||||
$font-size-6: 18px !default; //h2
|
||||
$font-size-7: 24px !default;
|
||||
$font-size-8: 32px !default; //h1
|
||||
$font-size-9: 36px !default;
|
||||
$font-size-10: 42px !default;
|
||||
$font-size-10-sm: 48px !default;
|
||||
|
||||
//
|
||||
// Colors
|
||||
//
|
||||
|
||||
@ -1,86 +1,84 @@
|
||||
// Font size
|
||||
|
||||
@mixin fs-1 {
|
||||
font-size: 9px !important;
|
||||
font-size: $font-size-1 !important;
|
||||
|
||||
@include mq(sm) {
|
||||
font-size: 10px !important;
|
||||
font-size: $font-size-1-sm !important;
|
||||
}
|
||||
}
|
||||
|
||||
@mixin fs-2 {
|
||||
font-size: 11px !important;
|
||||
font-size: $font-size-2 !important;
|
||||
|
||||
@include mq(sm) {
|
||||
font-size: 12px !important;
|
||||
font-size: $font-size-3 !important;
|
||||
}
|
||||
}
|
||||
|
||||
@mixin fs-3 {
|
||||
font-size: 12px !important;
|
||||
font-size: $font-size-3 !important;
|
||||
|
||||
@include mq(sm) {
|
||||
font-size: 14px !important;
|
||||
font-size: $font-size-4 !important;
|
||||
}
|
||||
}
|
||||
|
||||
@mixin fs-4 {
|
||||
font-size: 15px !important;
|
||||
font-size: $font-size-4 !important;
|
||||
|
||||
@include mq(sm) {
|
||||
font-size: 16px !important;
|
||||
font-size: $font-size-5 !important;
|
||||
}
|
||||
}
|
||||
|
||||
@mixin fs-5 {
|
||||
font-size: 16px !important;
|
||||
font-size: $font-size-5 !important;
|
||||
|
||||
@include mq(sm) {
|
||||
font-size: 18px !important;
|
||||
font-size: $font-size-6 !important;
|
||||
}
|
||||
}
|
||||
|
||||
@mixin fs-6 {
|
||||
font-size: 18px !important;
|
||||
font-size: $font-size-6 !important;
|
||||
|
||||
@include mq(sm) {
|
||||
font-size: 24px !important;
|
||||
font-size: $font-size-7 !important;
|
||||
line-height: $body-heading-line-height;
|
||||
}
|
||||
}
|
||||
|
||||
@mixin fs-7 {
|
||||
font-size: 24px !important;
|
||||
font-size: $font-size-7 !important;
|
||||
line-height: $body-heading-line-height;
|
||||
|
||||
@include mq(sm) {
|
||||
font-size: 32px !important;
|
||||
font-size: $font-size-8 !important;
|
||||
}
|
||||
}
|
||||
|
||||
@mixin fs-8 {
|
||||
font-size: 32px !important;
|
||||
font-size: $font-size-8 !important;
|
||||
line-height: $body-heading-line-height;
|
||||
|
||||
@include mq(sm) {
|
||||
font-size: 36px !important;
|
||||
font-size: $font-size-9 !important;
|
||||
}
|
||||
}
|
||||
|
||||
@mixin fs-9 {
|
||||
font-size: 36px !important;
|
||||
font-size: $font-size-9 !important;
|
||||
line-height: $body-heading-line-height;
|
||||
|
||||
@include mq(sm) {
|
||||
font-size: 42px !important;
|
||||
font-size: $font-size-10 !important;
|
||||
}
|
||||
}
|
||||
|
||||
@mixin fs-10 {
|
||||
font-size: 42px !important;
|
||||
font-size: $font-size-10 !important;
|
||||
line-height: $body-heading-line-height;
|
||||
|
||||
@include mq(sm) {
|
||||
font-size: 48px !important;
|
||||
font-size: $font-size-10-sm !important;
|
||||
}
|
||||
}
|
||||
|
||||
@ -27,6 +27,10 @@ h4,
|
||||
letter-spacing: 0.1em;
|
||||
}
|
||||
|
||||
h4 code {
|
||||
text-transform: none;
|
||||
}
|
||||
|
||||
h5,
|
||||
.text-epsilon {
|
||||
@include fs-3;
|
||||
|
||||
79
_sass/vendor/normalize.scss/README.md
vendored
79
_sass/vendor/normalize.scss/README.md
vendored
@ -1,78 +1,7 @@
|
||||
# normalize.scss v0.1.0
|
||||
# normalize.scss
|
||||
|
||||
Normalize.scss is the SCSS version of [normalize.css](http://necolas.github.io/normalize.css), a customisable CSS file that makes browsers render all elements more consistently and in line with modern standards.
|
||||
Normalize.scss is an SCSS copy of [normalize.css](http://necolas.github.io/normalize.css), a customisable CSS file that makes browsers render all elements more consistently and in line with modern standards.
|
||||
|
||||
The [normalize.scss fork](https://github.com/guerrero/normalize.scss) of [normalize.css](http://necolas.github.io/normalize.css) was archived in 2014, and has not been updated since v0.1.0.
|
||||
|
||||
[View the normalize.css test file](http://necolas.github.io/normalize.css/latest/test.html)
|
||||
|
||||
## Install
|
||||
|
||||
* [npm](http://npmjs.org/): `npm install --save normalize.scss`
|
||||
* [Component(1)](https://github.com/component/component/): `component install guerrero/normalize.scss`
|
||||
* [Bower](http://bower.io/): `bower install --save normalize.scss`
|
||||
* Download: Go to [this link](https://raw.githubusercontent.com/guerrero/normalize.scss/master/normalize.scss), press right-click on the page and choose "Save as..."
|
||||
|
||||
No other styles should come before Normalize.scss.
|
||||
|
||||
It's recommendable to modify `normalize.scss` to suit it to your project
|
||||
|
||||
## What does it do?
|
||||
|
||||
* Preserves useful defaults, unlike many CSS resets.
|
||||
* Normalizes styles for a wide range of elements.
|
||||
* Corrects bugs and common browser inconsistencies.
|
||||
* Improves usability with subtle improvements.
|
||||
* Explains what code does using detailed comments.
|
||||
|
||||
## Browser support
|
||||
|
||||
* Google Chrome (latest)
|
||||
* Mozilla Firefox (latest)
|
||||
* Mozilla Firefox 4
|
||||
* Opera (latest)
|
||||
* Apple Safari 6+
|
||||
* Internet Explorer 8+
|
||||
|
||||
[Normalize.css v1 provides legacy browser
|
||||
support](https://github.com/necolas/normalize.css/tree/v1) (IE 6+, Safari 4+),
|
||||
but is no longer actively developed.
|
||||
|
||||
## Extended details
|
||||
|
||||
Additional detail and explanation of the esoteric parts of normalize.css.
|
||||
|
||||
#### `pre, code, kbd, samp`
|
||||
|
||||
The `font-family: monospace, monospace` hack fixes the inheritance and scaling
|
||||
of font-size for preformated text. The duplication of `monospace` is
|
||||
intentional. [Source](http://en.wikipedia.org/wiki/User:Davidgothberg/Test59).
|
||||
|
||||
#### `sub, sup`
|
||||
|
||||
Normally, using `sub` or `sup` affects the line-box height of text in all
|
||||
browsers. [Source](http://gist.github.com/413930).
|
||||
|
||||
#### `svg:not(:root)`
|
||||
|
||||
Adding `overflow: hidden` fixes IE9's SVG rendering. Earlier versions of IE
|
||||
don't support SVG, so we can safely use the `:not()` and `:root` selectors that
|
||||
modern browsers use in the default UA stylesheets to apply this style. [SVG
|
||||
Mailing List discussion](http://lists.w3.org/Archives/Public/public-svg-wg/2008JulSep/0339.html)
|
||||
|
||||
#### `input[type="search"]`
|
||||
|
||||
The search input is not fully stylable by default. In Chrome and Safari on
|
||||
OSX/iOS you can't control `font`, `padding`, `border`, or `background`. In
|
||||
Chrome and Safari on Windows you can't control `border` properly. It will apply
|
||||
`border-width` but will only show a border color (which cannot be controlled)
|
||||
for the outer 1px of that border. Applying `-webkit-appearance: textfield`
|
||||
addresses these issues without removing the benefits of search inputs (e.g.
|
||||
showing past searches).
|
||||
|
||||
#### `legend`
|
||||
|
||||
Adding `border: 0` corrects an IE 8–11 bug where `color` (yes, `color`) is not
|
||||
inherited by `legend`.
|
||||
|
||||
## Acknowledgements
|
||||
|
||||
Normalize.scss is a project by [Alex Guerrero](https://github.com/guerrero) based on [normalize.css](http://necolas.github.io/normalize.css) from [Nicolas Gallagher](https://github.com/necolas), co-created with [Jonathan Neal](https://github.com/jonathantneal).
|
||||
|
||||
494
_sass/vendor/normalize.scss/normalize.scss
vendored
494
_sass/vendor/normalize.scss/normalize.scss
vendored
@ -1,135 +1,40 @@
|
||||
/*! normalize.scss v0.1.0 | MIT License | based on git.io/normalize */
|
||||
/*! normalize.css v8.0.1 | MIT License | github.com/necolas/normalize.css */
|
||||
|
||||
/* Document
|
||||
========================================================================== */
|
||||
|
||||
/**
|
||||
* 1. Set default font family to sans-serif.
|
||||
* 2. Prevent iOS text size adjust after orientation change, without disabling
|
||||
* user zoom.
|
||||
* 1. Correct the line height in all browsers.
|
||||
* 2. Prevent adjustments of font size after orientation changes in iOS.
|
||||
*/
|
||||
|
||||
html {
|
||||
font-family: sans-serif; /* 1 */
|
||||
-ms-text-size-adjust: 100%; /* 2 */
|
||||
line-height: 1.15; /* 1 */
|
||||
-webkit-text-size-adjust: 100%; /* 2 */
|
||||
}
|
||||
|
||||
/* Sections
|
||||
========================================================================== */
|
||||
|
||||
/**
|
||||
* Remove default margin.
|
||||
* Remove the margin in all browsers.
|
||||
*/
|
||||
|
||||
body {
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
/* HTML5 display definitions
|
||||
========================================================================== */
|
||||
|
||||
/**
|
||||
* Correct `block` display not defined for any HTML5 element in IE 8/9.
|
||||
* Correct `block` display not defined for `details` or `summary` in IE 10/11
|
||||
* and Firefox.
|
||||
* Correct `block` display not defined for `main` in IE 11.
|
||||
* Render the `main` element consistently in IE.
|
||||
*/
|
||||
|
||||
article,
|
||||
aside,
|
||||
details,
|
||||
figcaption,
|
||||
figure,
|
||||
footer,
|
||||
header,
|
||||
hgroup,
|
||||
main,
|
||||
menu,
|
||||
nav,
|
||||
section,
|
||||
summary {
|
||||
main {
|
||||
display: block;
|
||||
}
|
||||
|
||||
/**
|
||||
* 1. Correct `inline-block` display not defined in IE 8/9.
|
||||
* 2. Normalize vertical alignment of `progress` in Chrome, Firefox, and Opera.
|
||||
*/
|
||||
|
||||
audio,
|
||||
canvas,
|
||||
progress,
|
||||
video {
|
||||
display: inline-block; /* 1 */
|
||||
vertical-align: baseline; /* 2 */
|
||||
}
|
||||
|
||||
/**
|
||||
* Prevent modern browsers from displaying `audio` without controls.
|
||||
* Remove excess height in iOS 5 devices.
|
||||
*/
|
||||
|
||||
audio:not([controls]) {
|
||||
display: none;
|
||||
height: 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* Address `[hidden]` styling not present in IE 8/9/10.
|
||||
* Hide the `template` element in IE 8/9/11, Safari, and Firefox < 22.
|
||||
*/
|
||||
|
||||
[hidden],
|
||||
template {
|
||||
display: none;
|
||||
}
|
||||
|
||||
/* Links
|
||||
========================================================================== */
|
||||
|
||||
/**
|
||||
* Remove the gray background color from active links in IE 10.
|
||||
*/
|
||||
|
||||
a {
|
||||
background-color: transparent;
|
||||
}
|
||||
|
||||
/**
|
||||
* Improve readability when focused and also mouse hovered in all browsers.
|
||||
*/
|
||||
|
||||
a:active,
|
||||
a:hover {
|
||||
outline: 0;
|
||||
}
|
||||
|
||||
/* Text-level semantics
|
||||
========================================================================== */
|
||||
|
||||
/**
|
||||
* Address styling not present in IE 8/9/10/11, Safari, and Chrome.
|
||||
*/
|
||||
|
||||
abbr[title] {
|
||||
border-bottom: 1px dotted;
|
||||
}
|
||||
|
||||
/**
|
||||
* Address style set to `bolder` in Firefox 4+, Safari, and Chrome.
|
||||
*/
|
||||
|
||||
b,
|
||||
strong {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
/**
|
||||
* Address styling not present in Safari and Chrome.
|
||||
*/
|
||||
|
||||
dfn {
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
/**
|
||||
* Address variable `h1` font-size and margin within `section` and `article`
|
||||
* contexts in Firefox 4+, Safari, and Chrome.
|
||||
* Correct the font size and margin on `h1` elements within `section` and
|
||||
* `article` contexts in Chrome, Firefox, and Safari.
|
||||
*/
|
||||
|
||||
h1 {
|
||||
@ -137,17 +42,75 @@ h1 {
|
||||
margin: 0.67em 0;
|
||||
}
|
||||
|
||||
/* Grouping content
|
||||
========================================================================== */
|
||||
|
||||
/**
|
||||
* Address styling not present in IE 8/9.
|
||||
* 1. Add the correct box sizing in Firefox.
|
||||
* 2. Show the overflow in Edge and IE.
|
||||
*/
|
||||
|
||||
mark {
|
||||
background: #ff0;
|
||||
color: #000;
|
||||
hr {
|
||||
box-sizing: content-box; /* 1 */
|
||||
height: 0; /* 1 */
|
||||
overflow: visible; /* 2 */
|
||||
}
|
||||
|
||||
/**
|
||||
* Address inconsistent and variable font size in all browsers.
|
||||
* 1. Correct the inheritance and scaling of font size in all browsers.
|
||||
* 2. Correct the odd `em` font sizing in all browsers.
|
||||
*/
|
||||
|
||||
pre {
|
||||
font-family: monospace, monospace; /* 1 */
|
||||
font-size: 1em; /* 2 */
|
||||
}
|
||||
|
||||
/* Text-level semantics
|
||||
========================================================================== */
|
||||
|
||||
/**
|
||||
* Remove the gray background on active links in IE 10.
|
||||
*/
|
||||
|
||||
a {
|
||||
background-color: transparent;
|
||||
}
|
||||
|
||||
/**
|
||||
* 1. Remove the bottom border in Chrome 57-
|
||||
* 2. Add the correct text decoration in Chrome, Edge, IE, Opera, and Safari.
|
||||
*/
|
||||
|
||||
abbr[title] {
|
||||
border-bottom: none; /* 1 */
|
||||
text-decoration: underline; /* 2 */
|
||||
text-decoration: underline dotted; /* 2 */
|
||||
}
|
||||
|
||||
/**
|
||||
* Add the correct font weight in Chrome, Edge, and Safari.
|
||||
*/
|
||||
|
||||
b,
|
||||
strong {
|
||||
font-weight: bolder;
|
||||
}
|
||||
|
||||
/**
|
||||
* 1. Correct the inheritance and scaling of font size in all browsers.
|
||||
* 2. Correct the odd `em` font sizing in all browsers.
|
||||
*/
|
||||
|
||||
code,
|
||||
kbd,
|
||||
samp {
|
||||
font-family: monospace, monospace; /* 1 */
|
||||
font-size: 1em; /* 2 */
|
||||
}
|
||||
|
||||
/**
|
||||
* Add the correct font size in all browsers.
|
||||
*/
|
||||
|
||||
small {
|
||||
@ -155,7 +118,8 @@ small {
|
||||
}
|
||||
|
||||
/**
|
||||
* Prevent `sub` and `sup` affecting `line-height` in all browsers.
|
||||
* Prevent `sub` and `sup` elements from affecting the line height in
|
||||
* all browsers.
|
||||
*/
|
||||
|
||||
sub,
|
||||
@ -166,87 +130,31 @@ sup {
|
||||
vertical-align: baseline;
|
||||
}
|
||||
|
||||
sup {
|
||||
top: -0.5em;
|
||||
}
|
||||
|
||||
sub {
|
||||
bottom: -0.25em;
|
||||
}
|
||||
|
||||
sup {
|
||||
top: -0.5em;
|
||||
}
|
||||
|
||||
/* Embedded content
|
||||
========================================================================== */
|
||||
|
||||
/**
|
||||
* Remove border when inside `a` element in IE 8/9/10.
|
||||
* Remove the border on images inside links in IE 10.
|
||||
*/
|
||||
|
||||
img {
|
||||
border: 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* Correct overflow not hidden in IE 9/10/11.
|
||||
*/
|
||||
|
||||
svg:not(:root) {
|
||||
overflow: hidden;
|
||||
}
|
||||
|
||||
/* Grouping content
|
||||
========================================================================== */
|
||||
|
||||
/**
|
||||
* Address margin not present in IE 8/9 and Safari.
|
||||
*/
|
||||
|
||||
figure {
|
||||
margin: 1em 40px;
|
||||
}
|
||||
|
||||
/**
|
||||
* Address differences between Firefox and other browsers.
|
||||
*/
|
||||
|
||||
hr {
|
||||
-moz-box-sizing: content-box;
|
||||
box-sizing: content-box;
|
||||
height: 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* Contain overflow in all browsers.
|
||||
*/
|
||||
|
||||
pre {
|
||||
overflow: auto;
|
||||
}
|
||||
|
||||
/**
|
||||
* Address odd `em`-unit font size rendering in all browsers.
|
||||
*/
|
||||
|
||||
code,
|
||||
kbd,
|
||||
pre,
|
||||
samp {
|
||||
font-family: monospace, monospace;
|
||||
font-size: 1em;
|
||||
border-style: none;
|
||||
}
|
||||
|
||||
/* Forms
|
||||
========================================================================== */
|
||||
|
||||
/**
|
||||
* Known limitation: by default, Chrome and Safari on OS X allow very limited
|
||||
* styling of `select`, unless a `border` property is set.
|
||||
*/
|
||||
|
||||
/**
|
||||
* 1. Correct color not being inherited.
|
||||
* Known issue: affects color of disabled elements.
|
||||
* 2. Correct font properties not being inherited.
|
||||
* 3. Address margins set differently in Firefox 4+, Safari, and Chrome.
|
||||
* 1. Change the font styles in all browsers.
|
||||
* 2. Remove the margin in Firefox and Safari.
|
||||
*/
|
||||
|
||||
button,
|
||||
@ -254,146 +162,100 @@ input,
|
||||
optgroup,
|
||||
select,
|
||||
textarea {
|
||||
color: inherit; /* 1 */
|
||||
font: inherit; /* 2 */
|
||||
margin: 0; /* 3 */
|
||||
font-family: inherit; /* 1 */
|
||||
font-size: 100%; /* 1 */
|
||||
line-height: 1.15; /* 1 */
|
||||
margin: 0; /* 2 */
|
||||
}
|
||||
|
||||
/**
|
||||
* Address `overflow` set to `hidden` in IE 8/9/10/11.
|
||||
* Show the overflow in IE.
|
||||
* 1. Show the overflow in Edge.
|
||||
*/
|
||||
|
||||
button {
|
||||
button,
|
||||
input { /* 1 */
|
||||
overflow: visible;
|
||||
}
|
||||
|
||||
/**
|
||||
* Address inconsistent `text-transform` inheritance for `button` and `select`.
|
||||
* All other form control elements do not inherit `text-transform` values.
|
||||
* Correct `button` style inheritance in Firefox, IE 8/9/10/11, and Opera.
|
||||
* Correct `select` style inheritance in Firefox.
|
||||
* Remove the inheritance of text transform in Edge, Firefox, and IE.
|
||||
* 1. Remove the inheritance of text transform in Firefox.
|
||||
*/
|
||||
|
||||
button,
|
||||
select {
|
||||
select { /* 1 */
|
||||
text-transform: none;
|
||||
}
|
||||
|
||||
/**
|
||||
* 1. Avoid the WebKit bug in Android 4.0.* where (2) destroys native `audio`
|
||||
* and `video` controls.
|
||||
* 2. Correct inability to style clickable `input` types in iOS.
|
||||
* 3. Improve usability and consistency of cursor style between image-type
|
||||
* `input` and others.
|
||||
* Correct the inability to style clickable types in iOS and Safari.
|
||||
*/
|
||||
|
||||
button,
|
||||
html input[type="button"], /* 1 */
|
||||
input[type="reset"],
|
||||
input[type="submit"] {
|
||||
-webkit-appearance: button; /* 2 */
|
||||
cursor: pointer; /* 3 */
|
||||
[type="button"],
|
||||
[type="reset"],
|
||||
[type="submit"] {
|
||||
-webkit-appearance: button;
|
||||
}
|
||||
|
||||
/**
|
||||
* Re-set default cursor for disabled elements.
|
||||
*/
|
||||
|
||||
button[disabled],
|
||||
html input[disabled] {
|
||||
cursor: default;
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove inner padding and border in Firefox 4+.
|
||||
* Remove the inner border and padding in Firefox.
|
||||
*/
|
||||
|
||||
button::-moz-focus-inner,
|
||||
input::-moz-focus-inner {
|
||||
border: 0;
|
||||
[type="button"]::-moz-focus-inner,
|
||||
[type="reset"]::-moz-focus-inner,
|
||||
[type="submit"]::-moz-focus-inner {
|
||||
border-style: none;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* Address Firefox 4+ setting `line-height` on `input` using `!important` in
|
||||
* the UA stylesheet.
|
||||
* Restore the focus styles unset by the previous rule.
|
||||
*/
|
||||
|
||||
input {
|
||||
line-height: normal;
|
||||
button:-moz-focusring,
|
||||
[type="button"]:-moz-focusring,
|
||||
[type="reset"]:-moz-focusring,
|
||||
[type="submit"]:-moz-focusring {
|
||||
outline: 1px dotted ButtonText;
|
||||
}
|
||||
|
||||
/**
|
||||
* It's recommended that you don't attempt to style these elements.
|
||||
* Firefox's implementation doesn't respect box-sizing, padding, or width.
|
||||
*
|
||||
* 1. Address box sizing set to `content-box` in IE 8/9/10.
|
||||
* 2. Remove excess padding in IE 8/9/10.
|
||||
*/
|
||||
|
||||
input[type="checkbox"],
|
||||
input[type="radio"] {
|
||||
box-sizing: border-box; /* 1 */
|
||||
padding: 0; /* 2 */
|
||||
}
|
||||
|
||||
/**
|
||||
* Fix the cursor style for Chrome's increment/decrement buttons. For certain
|
||||
* `font-size` values of the `input`, it causes the cursor style of the
|
||||
* decrement button to change from `default` to `text`.
|
||||
*/
|
||||
|
||||
input[type="number"]::-webkit-inner-spin-button,
|
||||
input[type="number"]::-webkit-outer-spin-button {
|
||||
height: auto;
|
||||
}
|
||||
|
||||
/**
|
||||
* 1. Address `appearance` set to `searchfield` in Safari and Chrome.
|
||||
* 2. Address `box-sizing` set to `border-box` in Safari and Chrome
|
||||
* (include `-moz` to future-proof).
|
||||
*/
|
||||
|
||||
input[type="search"] {
|
||||
-webkit-appearance: textfield; /* 1 */
|
||||
-moz-box-sizing: content-box;
|
||||
-webkit-box-sizing: content-box; /* 2 */
|
||||
box-sizing: content-box;
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove inner padding and search cancel button in Safari and Chrome on OS X.
|
||||
* Safari (but not Chrome) clips the cancel button when the search input has
|
||||
* padding (and `textfield` appearance).
|
||||
*/
|
||||
|
||||
input[type="search"]::-webkit-search-cancel-button,
|
||||
input[type="search"]::-webkit-search-decoration {
|
||||
-webkit-appearance: none;
|
||||
}
|
||||
|
||||
/**
|
||||
* Define consistent border, margin, and padding.
|
||||
* Correct the padding in Firefox.
|
||||
*/
|
||||
|
||||
fieldset {
|
||||
border: 1px solid #c0c0c0;
|
||||
margin: 0 2px;
|
||||
padding: 0.35em 0.625em 0.75em;
|
||||
padding: 0.35em 0.75em 0.625em;
|
||||
}
|
||||
|
||||
/**
|
||||
* 1. Correct `color` not being inherited in IE 8/9/10/11.
|
||||
* 2. Remove padding so people aren't caught out if they zero out fieldsets.
|
||||
* 1. Correct the text wrapping in Edge and IE.
|
||||
* 2. Correct the color inheritance from `fieldset` elements in IE.
|
||||
* 3. Remove the padding so developers are not caught out when they zero out
|
||||
* `fieldset` elements in all browsers.
|
||||
*/
|
||||
|
||||
legend {
|
||||
border: 0; /* 1 */
|
||||
padding: 0; /* 2 */
|
||||
box-sizing: border-box; /* 1 */
|
||||
color: inherit; /* 2 */
|
||||
display: table; /* 1 */
|
||||
max-width: 100%; /* 1 */
|
||||
padding: 0; /* 3 */
|
||||
white-space: normal; /* 1 */
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove default vertical scrollbar in IE 8/9/10/11.
|
||||
* Add the correct vertical alignment in Chrome, Firefox, and Opera.
|
||||
*/
|
||||
|
||||
progress {
|
||||
vertical-align: baseline;
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove the default vertical scrollbar in IE 10+.
|
||||
*/
|
||||
|
||||
textarea {
|
||||
@ -401,27 +263,87 @@ textarea {
|
||||
}
|
||||
|
||||
/**
|
||||
* Don't inherit the `font-weight` (applied by a rule above).
|
||||
* NOTE: the default cannot safely be changed in Chrome and Safari on OS X.
|
||||
* 1. Add the correct box sizing in IE 10.
|
||||
* 2. Remove the padding in IE 10.
|
||||
*/
|
||||
|
||||
optgroup {
|
||||
font-weight: bold;
|
||||
[type="checkbox"],
|
||||
[type="radio"] {
|
||||
box-sizing: border-box; /* 1 */
|
||||
padding: 0; /* 2 */
|
||||
}
|
||||
|
||||
/* Tables
|
||||
/**
|
||||
* Correct the cursor style of increment and decrement buttons in Chrome.
|
||||
*/
|
||||
|
||||
[type="number"]::-webkit-inner-spin-button,
|
||||
[type="number"]::-webkit-outer-spin-button {
|
||||
height: auto;
|
||||
}
|
||||
|
||||
/**
|
||||
* 1. Correct the odd appearance in Chrome and Safari.
|
||||
* 2. Correct the outline style in Safari.
|
||||
*/
|
||||
|
||||
[type="search"] {
|
||||
-webkit-appearance: textfield; /* 1 */
|
||||
outline-offset: -2px; /* 2 */
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove the inner padding in Chrome and Safari on macOS.
|
||||
*/
|
||||
|
||||
[type="search"]::-webkit-search-decoration {
|
||||
-webkit-appearance: none;
|
||||
}
|
||||
|
||||
/**
|
||||
* 1. Correct the inability to style clickable types in iOS and Safari.
|
||||
* 2. Change font properties to `inherit` in Safari.
|
||||
*/
|
||||
|
||||
::-webkit-file-upload-button {
|
||||
-webkit-appearance: button; /* 1 */
|
||||
font: inherit; /* 2 */
|
||||
}
|
||||
|
||||
/* Interactive
|
||||
========================================================================== */
|
||||
|
||||
/*
|
||||
* Add the correct display in Edge, IE 10+, and Firefox.
|
||||
*/
|
||||
|
||||
details {
|
||||
display: block;
|
||||
}
|
||||
|
||||
/*
|
||||
* Add the correct display in all browsers.
|
||||
*/
|
||||
|
||||
summary {
|
||||
display: list-item;
|
||||
}
|
||||
|
||||
/* Misc
|
||||
========================================================================== */
|
||||
|
||||
/**
|
||||
* Remove most spacing between table cells.
|
||||
* Add the correct display in IE 10+.
|
||||
*/
|
||||
|
||||
table {
|
||||
border-collapse: collapse;
|
||||
border-spacing: 0;
|
||||
template {
|
||||
display: none;
|
||||
}
|
||||
|
||||
td,
|
||||
th {
|
||||
padding: 0;
|
||||
/**
|
||||
* Add the correct display in IE 10.
|
||||
*/
|
||||
|
||||
[hidden] {
|
||||
display: none;
|
||||
}
|
||||
|
||||
70
_sass/vendor/normalize.scss/package.json
vendored
70
_sass/vendor/normalize.scss/package.json
vendored
@ -1,70 +0,0 @@
|
||||
{
|
||||
"_args": [
|
||||
[
|
||||
"normalize.scss",
|
||||
"/Users/pmarsceill/_projects/just-the-docs"
|
||||
]
|
||||
],
|
||||
"_from": "normalize.scss@*",
|
||||
"_id": "normalize.scss@0.1.0",
|
||||
"_inCache": true,
|
||||
"_installable": true,
|
||||
"_location": "/normalize.scss",
|
||||
"_nodeVersion": "0.10.32",
|
||||
"_npmUser": {
|
||||
"email": "alexguerrero1092@gmail.com",
|
||||
"name": "alexguerrero"
|
||||
},
|
||||
"_npmVersion": "2.0.2",
|
||||
"_phantomChildren": {},
|
||||
"_requested": {
|
||||
"name": "normalize.scss",
|
||||
"raw": "normalize.scss",
|
||||
"rawSpec": "",
|
||||
"scope": null,
|
||||
"spec": "*",
|
||||
"type": "range"
|
||||
},
|
||||
"_requiredBy": [
|
||||
"#DEV:/"
|
||||
],
|
||||
"_resolved": "https://registry.npmjs.org/normalize.scss/-/normalize.scss-0.1.0.tgz",
|
||||
"_shasum": "4a21dc25bd4c019c857785f829b658aba2a8f9ab",
|
||||
"_shrinkwrap": null,
|
||||
"_spec": "normalize.scss",
|
||||
"_where": "/Users/pmarsceill/_projects/just-the-docs",
|
||||
"author": "",
|
||||
"bugs": {
|
||||
"url": "https://github.com/guerrero/normalize.scss/issues"
|
||||
},
|
||||
"dependencies": {},
|
||||
"description": "Normalize.scss as a node packaged module",
|
||||
"devDependencies": {},
|
||||
"directories": {},
|
||||
"dist": {
|
||||
"shasum": "4a21dc25bd4c019c857785f829b658aba2a8f9ab",
|
||||
"tarball": "https://registry.npmjs.org/normalize.scss/-/normalize.scss-0.1.0.tgz"
|
||||
},
|
||||
"files": [
|
||||
"normalize.scss"
|
||||
],
|
||||
"gitHead": "d67d517e28615a873066438af1d4845c157c9baf",
|
||||
"homepage": "https://github.com/guerrero/normalize.scss",
|
||||
"license": "MIT",
|
||||
"maintainers": [
|
||||
{
|
||||
"name": "alexguerrero",
|
||||
"email": "alexguerrero1092@gmail.com"
|
||||
}
|
||||
],
|
||||
"name": "normalize.scss",
|
||||
"optionalDependencies": {},
|
||||
"readme": "ERROR: No README data found!",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git://github.com/guerrero/normalize.scss.git"
|
||||
},
|
||||
"scripts": {},
|
||||
"style": "normalize.scss",
|
||||
"version": "0.1.0"
|
||||
}
|
||||
@ -2,8 +2,21 @@
|
||||
permalink: /assets/js/search-data.json
|
||||
---
|
||||
{
|
||||
{%- assign i = 0 -%}
|
||||
{% for page in site.html_pages %}
|
||||
{%- assign i = 0 -%}
|
||||
{%- assign pages_array = '' | split: '' -%}
|
||||
{%- assign pages_array = pages_array | push: site.html_pages -%}
|
||||
{%- if site.just_the_docs.collections -%}
|
||||
{%- for collection_entry in site.just_the_docs.collections -%}
|
||||
{%- assign collection_key = collection_entry[0] -%}
|
||||
{%- assign collection_value = collection_entry[1] -%}
|
||||
{%- assign collection = site[collection_key] -%}
|
||||
{%- if collection_value.search_exclude != true -%}
|
||||
{%- assign pages_array = pages_array | push: collection -%}
|
||||
{%- endif -%}
|
||||
{%- endfor -%}
|
||||
{%- endif -%}
|
||||
{%- for pages in pages_array -%}
|
||||
{%- for page in pages -%}
|
||||
{%- if page.title and page.search_exclude != true -%}
|
||||
{%- assign page_content = page.content -%}
|
||||
{%- assign heading_level = site.search.heading_level | default: 2 -%}
|
||||
@ -14,7 +27,7 @@ permalink: /assets/js/search-data.json
|
||||
{%- endfor -%}
|
||||
{%- assign parts = page_content | split: '<h1' -%}
|
||||
{%- assign title_found = false -%}
|
||||
{% for part in parts offset: 1 %}
|
||||
{%- for part in parts offset: 1 -%}
|
||||
{%- assign titleAndContent = part | split: '</h1>' -%}
|
||||
{%- assign title = titleAndContent[0] | replace_first: '>', '<h1>' | split: '<h1>' -%}
|
||||
{%- assign title = title[1] | strip_html -%}
|
||||
@ -54,5 +67,6 @@ permalink: /assets/js/search-data.json
|
||||
{%- assign i = i | plus: 1 -%}
|
||||
{%- endunless -%}
|
||||
{%- endif -%}
|
||||
{% endfor %}
|
||||
{%- endfor -%}
|
||||
{%- endfor %}
|
||||
}
|
||||
|
||||
14
docker-compose.yml
Normal file
14
docker-compose.yml
Normal file
@ -0,0 +1,14 @@
|
||||
version: "3.5"
|
||||
|
||||
services:
|
||||
jekyll:
|
||||
build:
|
||||
context: ./
|
||||
ports:
|
||||
- 4000:4000
|
||||
volumes:
|
||||
- .:/usr/src/app
|
||||
stdin_open: true
|
||||
tty: true
|
||||
command: bundle exec jekyll serve -H 0.0.0.0 -t
|
||||
|
||||
@ -7,8 +7,7 @@ nav_order: 2
|
||||
# Configuration
|
||||
{: .no_toc }
|
||||
|
||||
|
||||
Just the Docs has some specific configuration parameters that can be defined in your Jekyll site's _config.yml file.
|
||||
Just the Docs has some specific configuration parameters that can be defined in your Jekyll site's \_config.yml file.
|
||||
{: .fs-6 .fw-300 }
|
||||
|
||||
## Table of contents
|
||||
@ -19,8 +18,7 @@ Just the Docs has some specific configuration parameters that can be defined in
|
||||
|
||||
---
|
||||
|
||||
|
||||
View this site's [_config.yml](https://github.com/pmarsceill/just-the-docs/tree/master/_config.yml) file as an example.
|
||||
View this site's [\_config.yml](https://github.com/just-the-docs/just-the-docs/tree/main/_config.yml) file as an example.
|
||||
|
||||
## Site logo
|
||||
|
||||
@ -67,7 +65,7 @@ search:
|
||||
# Aux links for the upper right navigation
|
||||
aux_links:
|
||||
"Just the Docs on GitHub":
|
||||
- "//github.com/pmarsceill/just-the-docs"
|
||||
- "//github.com/just-the-docs/just-the-docs"
|
||||
|
||||
# Makes Aux links open in a new tab. Default is false
|
||||
aux_links_new_tab: false
|
||||
@ -86,9 +84,11 @@ heading_anchors: true
|
||||
## Footer content
|
||||
|
||||
```yaml
|
||||
# Footer content
|
||||
# Footer content
|
||||
# appears at the bottom of every page's main content
|
||||
footer_content: "Copyright © 2017-2019 Patrick Marsceill. Distributed by an <a href=\"https://github.com/pmarsceill/just-the-docs/tree/master/LICENSE.txt\">MIT license.</a>"
|
||||
# Note: The footer_content option is deprecated and will be removed in a future major release. Please use `_includes/footer_custom.html` for more robust
|
||||
markup / liquid-based content.
|
||||
footer_content: "Copyright © 2017-2020 Patrick Marsceill. Distributed by an <a href=\"https://github.com/just-the-docs/just-the-docs/tree/main/LICENSE.txt\">MIT license.</a>"
|
||||
|
||||
# Footer last edited timestamp
|
||||
last_edit_timestamp: true # show or hide edit time - page must have `last_modified_date` defined in the frontmatter
|
||||
@ -97,15 +97,19 @@ last_edit_time_format: "%b %e %Y at %I:%M %p" # uses ruby's time format: https:/
|
||||
# Footer "Edit this page on GitHub" link text
|
||||
gh_edit_link: true # show or hide edit this page link
|
||||
gh_edit_link_text: "Edit this page on GitHub."
|
||||
gh_edit_repository: "https://github.com/pmarsceill/just-the-docs" # the github URL for your repo
|
||||
gh_edit_branch: "master" # the branch that your docs is served from
|
||||
gh_edit_repository: "https://github.com/just-the-docs/just-the-docs" # the github URL for your repo
|
||||
gh_edit_branch: "main" # the branch that your docs is served from
|
||||
# gh_edit_source: docs # the source that your files originate from
|
||||
gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately
|
||||
```
|
||||
|
||||
_note: `footer_content` is deprecated, but still supported. For a better experience we have moved this into an include called `_includes/footer_custom.html` which will allow for robust markup / liquid-based content._
|
||||
|
||||
- the "page last modified" data will only display if a page has a key called `last_modified_date`, formatted in some readable date format
|
||||
- `last_edit_time_format` uses Ruby's DateTime formatter; see examples and more information [at this link.](https://apidock.com/ruby/DateTime/strftime)
|
||||
- `gh_edit_repository` is the URL of the project's GitHub repository
|
||||
- `gh_edit_branch` is the branch that the docs site is served from; defaults to `master`
|
||||
- `gh_edit_branch` is the branch that the docs site is served from; defaults to `main`
|
||||
- `gh_edit_source` is the source directory that your project files are stored in (should be the same as [site.source](https://jekyllrb.com/docs/configuration/options/))
|
||||
- `gh_edit_view_mode` is `"tree"` by default, which brings the user to the github page; switch to `"edit"` to bring the user directly into editing mode
|
||||
|
||||
## Color scheme
|
||||
@ -114,6 +118,7 @@ gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into t
|
||||
# Color scheme supports "light" (default) and "dark"
|
||||
color_scheme: dark
|
||||
```
|
||||
|
||||
<button class="btn js-toggle-dark-mode">Preview dark color scheme</button>
|
||||
|
||||
<script>
|
||||
@ -140,3 +145,53 @@ See [Customization]({{ site.baseurl }}{% link docs/customization.md %}) for more
|
||||
ga_tracking: UA-5555555-55
|
||||
ga_tracking_anonymize_ip: true # Use GDPR compliant Google Analytics settings (true by default)
|
||||
```
|
||||
|
||||
## Document collections
|
||||
|
||||
By default, the navigation and search include normal [pages](https://jekyllrb.com/docs/pages/).
|
||||
Instead, you can also use [Jekyll collections](https://jekyllrb.com/docs/collections/) which group documents semantically together.
|
||||
|
||||
For example, put all your documentation files in the `_docs` folder and create the `docs` collection:
|
||||
|
||||
```yaml
|
||||
# Define Jekyll collections
|
||||
collections:
|
||||
# Define a collection named "docs", its documents reside in the "_docs" directory
|
||||
docs:
|
||||
permalink: "/:collection/:path/"
|
||||
output: true
|
||||
|
||||
just_the_docs:
|
||||
# Define which collections are used in just-the-docs
|
||||
collections:
|
||||
# Reference the "docs" collection
|
||||
docs:
|
||||
# Give the collection a name
|
||||
name: Documentation
|
||||
# Exclude the collection from the navigation
|
||||
# Supports true or false (default)
|
||||
nav_exclude: false
|
||||
# Exclude the collection from the search
|
||||
# Supports true or false (default)
|
||||
search_exclude: false
|
||||
```
|
||||
|
||||
You can reference multiple collections.
|
||||
This creates categories in the navigation with the configured names.
|
||||
|
||||
```yaml
|
||||
collections:
|
||||
docs:
|
||||
permalink: "/:collection/:path/"
|
||||
output: true
|
||||
tutorials:
|
||||
permalink: "/:collection/:path/"
|
||||
output: true
|
||||
|
||||
just_the_docs:
|
||||
collections:
|
||||
docs:
|
||||
name: Documentation
|
||||
tutorials:
|
||||
name: Tutorials
|
||||
```
|
||||
|
||||
@ -16,6 +16,7 @@ nav_order: 6
|
||||
---
|
||||
|
||||
## Color schemes
|
||||
|
||||
{: .d-inline-block }
|
||||
|
||||
New
|
||||
@ -32,6 +33,7 @@ To enable a color scheme, set the `color_scheme` parameter in your site's `_conf
|
||||
# Color scheme supports "light" (default) and "dark"
|
||||
color_scheme: dark
|
||||
```
|
||||
|
||||
<button class="btn js-toggle-dark-mode">Preview dark color scheme</button>
|
||||
|
||||
<script>
|
||||
@ -53,10 +55,10 @@ jtd.addEvent(toggleDarkMode, 'click', function(){
|
||||
### Define a custom scheme
|
||||
|
||||
You can add custom schemes.
|
||||
If you want to add a scheme named `foo` (can be any name) just add a file `_sass/color_schemes/foo.scss` (replace `foo` by your scheme name)
|
||||
If you want to add a scheme named `foo` (can be any name) just add a file `_sass/color_schemes/foo.scss` (replace `foo` by your scheme name)
|
||||
where you override theme variables to change colors, fonts, spacing, etc.
|
||||
|
||||
Available variables are listed in the [_variables.scss](https://github.com/pmarsceill/just-the-docs/tree/master/_sass/support/_variables.scss) file.
|
||||
Available variables are listed in the [\_variables.scss](https://github.com/just-the-docs/just-the-docs/tree/main/_sass/support/_variables.scss) file.
|
||||
|
||||
For example, to change the link color from the purple default to blue, include the following inside your scheme file:
|
||||
|
||||
@ -73,6 +75,7 @@ Please use scheme files.
|
||||
### Use a custom scheme
|
||||
|
||||
To use the custom color scheme, only set the `color_scheme` parameter in your site's `_config.yml` file:
|
||||
|
||||
```yaml
|
||||
color_scheme: foo
|
||||
```
|
||||
@ -80,7 +83,7 @@ color_scheme: foo
|
||||
### Switchable custom scheme
|
||||
|
||||
If you want to be able to change the scheme dynamically, for example via javascript, just add a file `assets/css/just-the-docs-foo.scss` (replace `foo` by your scheme name)
|
||||
with the following content:`
|
||||
with the following content:
|
||||
|
||||
{% raw %}
|
||||
---
|
||||
@ -91,7 +94,7 @@ with the following content:`
|
||||
This allows you to switch the scheme via the following javascript.
|
||||
|
||||
```js
|
||||
jtd.setTheme('foo');
|
||||
jtd.setTheme("foo")
|
||||
```
|
||||
|
||||
## Override and completely custom styles
|
||||
@ -109,7 +112,13 @@ For example, if you'd like to add your own styles for printing a page, you could
|
||||
```scss
|
||||
// Print-only styles.
|
||||
@media print {
|
||||
.side-bar, .page-header { display: none; }
|
||||
.main-content { max-width: auto; margin: 1em;}
|
||||
.side-bar,
|
||||
.page-header {
|
||||
display: none;
|
||||
}
|
||||
.main-content {
|
||||
max-width: auto;
|
||||
margin: 1em;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
@ -39,7 +39,7 @@ GitHubPages::Dependencies.gems.each do |gem, version|
|
||||
end
|
||||
```
|
||||
|
||||
#### [](#header-4)Header 4
|
||||
#### [](#header-4)Header 4 `with code not transformed`
|
||||
|
||||
* This is an unordered list following a header.
|
||||
* This is an unordered list following a header.
|
||||
@ -140,6 +140,37 @@ end
|
||||
<dd>Green</dd>
|
||||
</dl>
|
||||
|
||||
#### Multiple description terms and values
|
||||
|
||||
Term
|
||||
: Brief description of Term
|
||||
|
||||
Longer Term
|
||||
: Longer description of Term,
|
||||
possibly more than one line
|
||||
|
||||
Term
|
||||
: First description of Term,
|
||||
possibly more than one line
|
||||
|
||||
: Second description of Term,
|
||||
possibly more than one line
|
||||
|
||||
Term1
|
||||
Term2
|
||||
: Single description of Term1 and Term2,
|
||||
possibly more than one line
|
||||
|
||||
Term1
|
||||
Term2
|
||||
: First description of Term1 and Term2,
|
||||
possibly more than one line
|
||||
|
||||
: Second description of Term1 and Term2,
|
||||
possibly more than one line
|
||||
|
||||
### More code
|
||||
|
||||
```
|
||||
Long, single-line code blocks should not wrap. They should horizontally scroll if they are too long. This line should be long enough to demonstrate this.
|
||||
```
|
||||
|
||||
@ -5,13 +5,17 @@ nav_order: 5
|
||||
---
|
||||
|
||||
# Navigation Structure
|
||||
|
||||
{: .no_toc }
|
||||
|
||||
## Table of contents
|
||||
{: .no_toc .text-delta }
|
||||
|
||||
<details open markdown="block">
|
||||
<summary>
|
||||
Table of contents
|
||||
</summary>
|
||||
{: .text-delta }
|
||||
1. TOC
|
||||
{:toc}
|
||||
</details>
|
||||
|
||||
---
|
||||
|
||||
@ -25,9 +29,10 @@ By default, all pages will appear as top level pages in the main nav unless a pa
|
||||
|
||||
## Ordering pages
|
||||
|
||||
To specify a page order, use the `nav_order` parameter in your pages' YAML front matter.
|
||||
To specify a page order, you can use the `nav_order` parameter in your pages' YAML front matter.
|
||||
|
||||
#### Example
|
||||
|
||||
{: .no_toc }
|
||||
|
||||
```yaml
|
||||
@ -36,14 +41,16 @@ layout: default
|
||||
title: Customization
|
||||
nav_order: 4
|
||||
---
|
||||
|
||||
```
|
||||
|
||||
The specified `nav_order` parameters on a site should be all integers or all strings.
|
||||
Pages without a `nav_order` parameter are ordered alphabetically by their `title`,
|
||||
and appear after the explicitly-ordered pages at each level.
|
||||
By default, all Capital letters are sorted before all lowercase letters;
|
||||
adding `nav_sort: case_insensitive` in the configuration file ignores case
|
||||
when sorting strings (but also sorts numbers lexicographically: `10` comes before `1`).
|
||||
The parameter values determine the order of the top-level pages, and of child pages with the same parent. You can reuse the same parameter values (e.g., integers starting from 1) for the child pages of different parents.
|
||||
|
||||
The parameter values can be numbers (integers, floats) and/or strings. When you omit `nav_order` parameters, they default to the titles of the pages, which are ordered alphabetically. Pages with numerical `nav_order` parameters always come before those with strings or default `nav_order` parameters. If you want to make the page order independent of the page titles, you can set explicit `nav_order` parameters on all pages.
|
||||
|
||||
By default, all Capital letters come before all lowercase letters; you can add `nav_sort: case_insensitive` in the configuration file to ignore the case. Enclosing strings in quotation marks is optional.
|
||||
|
||||
> _Note for users of previous versions:_ `nav_sort: case_insensitive` previously affected the ordering of numerical `nav_order` parameters: e.g., `10` came before `2`. Also, all pages with explicit `nav_order` parameters previously came before all pages with default parameters. Both were potentially confusing, and they have now been eliminated.
|
||||
|
||||
---
|
||||
|
||||
@ -52,6 +59,7 @@ when sorting strings (but also sorts numbers lexicographically: `10` comes befor
|
||||
For specific pages that you do not wish to include in the main navigation, e.g. a 404 page or a landing page, use the `nav_exclude: true` parameter in the YAML front matter for that page.
|
||||
|
||||
#### Example
|
||||
|
||||
{: .no_toc }
|
||||
|
||||
```yaml
|
||||
@ -60,8 +68,13 @@ layout: default
|
||||
title: 404
|
||||
nav_exclude: true
|
||||
---
|
||||
|
||||
```
|
||||
|
||||
The `nav_exclude` parameter does not affect the [auto-generating list of child pages](#auto-generating-table-of-contents), which you can use to access pages excluded from the main navigation.
|
||||
|
||||
Pages with no `title` are automatically excluded from the navigation.
|
||||
|
||||
---
|
||||
|
||||
## Pages with children
|
||||
@ -96,9 +109,11 @@ Sometimes you will want to create a page with many children (a section). First,
|
||||
```
|
||||
|
||||
On the parent pages, add this YAML front matter parameter:
|
||||
- `has_children: true` (tells us that this is a parent page)
|
||||
|
||||
- `has_children: true` (tells us that this is a parent page)
|
||||
|
||||
#### Example
|
||||
|
||||
{: .no_toc }
|
||||
|
||||
```yaml
|
||||
@ -108,16 +123,19 @@ title: UI Components
|
||||
nav_order: 2
|
||||
has_children: true
|
||||
---
|
||||
|
||||
```
|
||||
|
||||
Here we're setting up the UI Components landing page that is available at `/docs/ui-components`, which has children and is ordered second in the main nav.
|
||||
|
||||
### Child pages
|
||||
|
||||
{: .text-gamma }
|
||||
|
||||
On child pages, simply set the `parent:` YAML front matter to whatever the parent's page title is and set a nav order (this number is now scoped within the section).
|
||||
|
||||
#### Example
|
||||
|
||||
{: .no_toc }
|
||||
|
||||
```yaml
|
||||
@ -127,6 +145,7 @@ title: Buttons
|
||||
parent: UI Components
|
||||
nav_order: 2
|
||||
---
|
||||
|
||||
```
|
||||
|
||||
The Buttons page appears as a child of UI Components and appears second in the UI Components section.
|
||||
@ -136,6 +155,7 @@ The Buttons page appears as a child of UI Components and appears second in the U
|
||||
By default, all pages with children will automatically append a Table of Contents which lists the child pages after the parent page's content. To disable this auto Table of Contents, set `has_toc: false` in the parent page's YAML front matter.
|
||||
|
||||
#### Example
|
||||
|
||||
{: .no_toc }
|
||||
|
||||
```yaml
|
||||
@ -146,9 +166,11 @@ nav_order: 2
|
||||
has_children: true
|
||||
has_toc: false
|
||||
---
|
||||
|
||||
```
|
||||
|
||||
### Children with children
|
||||
|
||||
{: .text-gamma }
|
||||
|
||||
Child pages can also have children (grandchildren). This is achieved by using a similar pattern on the child and grandchild pages.
|
||||
@ -157,6 +179,7 @@ Child pages can also have children (grandchildren). This is achieved by using a
|
||||
1. Add the `parent` and `grand_parent` attribute to the grandchild
|
||||
|
||||
#### Example
|
||||
|
||||
{: .no_toc }
|
||||
|
||||
```yaml
|
||||
@ -167,6 +190,7 @@ parent: UI Components
|
||||
nav_order: 2
|
||||
has_children: true
|
||||
---
|
||||
|
||||
```
|
||||
|
||||
```yaml
|
||||
@ -177,6 +201,7 @@ parent: Buttons
|
||||
grand_parent: UI Components
|
||||
nav_order: 1
|
||||
---
|
||||
|
||||
```
|
||||
|
||||
This would create the following navigation structure:
|
||||
@ -202,13 +227,14 @@ This would create the following navigation structure:
|
||||
To add auxiliary links to your site (in the upper right on all pages), add it to the `aux_links` [configuration option]({{ site.baseurl }}{% link docs/configuration.md %}#aux-links) in your site's `_config.yml` file.
|
||||
|
||||
#### Example
|
||||
|
||||
{: .no_toc }
|
||||
|
||||
```yaml
|
||||
# Aux links for the upper right navigation
|
||||
aux_links:
|
||||
"Just the Docs on GitHub":
|
||||
- "//github.com/pmarsceill/just-the-docs"
|
||||
- "//github.com/just-the-docs/just-the-docs"
|
||||
```
|
||||
|
||||
---
|
||||
@ -218,20 +244,23 @@ aux_links:
|
||||
To generate a Table of Contents on your docs pages, you can use the `{:toc}` method from Kramdown, immediately after an `<ol>` in Markdown. This will automatically generate an ordered list of anchor links to various sections of the page based on headings and heading levels. There may be occasions where you're using a heading and you don't want it to show up in the TOC, so to skip a particular heading use the `{: .no_toc }` CSS class.
|
||||
|
||||
#### Example
|
||||
|
||||
{: .no_toc }
|
||||
|
||||
```markdown
|
||||
# Navigation Structure
|
||||
|
||||
{: .no_toc }
|
||||
|
||||
## Table of contents
|
||||
|
||||
{: .no_toc .text-delta }
|
||||
|
||||
1. TOC
|
||||
{:toc}
|
||||
{:toc}
|
||||
```
|
||||
|
||||
This example skips the page name heading (`#`) from the TOC, as well as the heading for the Table of Contents itself (`##`) because it is redundant, followed by the table of contents itself. To get an unordered list, replace `1. TOC` above by `- TOC`.
|
||||
This example skips the page name heading (`#`) from the TOC, as well as the heading for the Table of Contents itself (`##`) because it is redundant, followed by the table of contents itself. To get an unordered list, replace `1. TOC` above by `- TOC`.
|
||||
|
||||
### Collapsible Table of Contents
|
||||
|
||||
|
||||
@ -5,13 +5,15 @@ nav_order: 7
|
||||
---
|
||||
|
||||
# Search
|
||||
|
||||
{: .no_toc }
|
||||
|
||||
## Table of contents
|
||||
|
||||
{: .no_toc .text-delta }
|
||||
|
||||
1. TOC
|
||||
{:toc}
|
||||
{:toc}
|
||||
|
||||
---
|
||||
|
||||
@ -76,7 +78,7 @@ To allow search for hyphenated words:
|
||||
search.tokenizer_separator: /[\s/]+/
|
||||
```
|
||||
|
||||
### Display URL in search results
|
||||
### Display URL in search results
|
||||
|
||||
```yaml
|
||||
# Display the relative url in search results
|
||||
@ -94,13 +96,13 @@ The search button displays in the bottom right corner of the screen and triggers
|
||||
search.button: true
|
||||
```
|
||||
|
||||
|
||||
## Hiding pages from search
|
||||
|
||||
Sometimes you might have a page that you don't want to be indexed for the search nor to show up in search results, e.g, a 404 page.
|
||||
To exclude a page from search, add the `search_exclude: true` parameter to the page's YAML front matter:
|
||||
|
||||
#### Example
|
||||
|
||||
{: .no_toc }
|
||||
|
||||
```yaml
|
||||
@ -110,8 +112,8 @@ title: Page not found
|
||||
nav_exclude: true
|
||||
search_exclude: true
|
||||
---
|
||||
```
|
||||
|
||||
```
|
||||
|
||||
## Generate search index when used as a gem
|
||||
|
||||
@ -124,4 +126,4 @@ $ bundle exec just-the-docs rake search:init
|
||||
```
|
||||
|
||||
This command creates the `assets/js/zzzz-search-data.json` file that Jekyll uses to create your search index.
|
||||
Alternatively, you can create the file manually with [this content]({{ site.github.repository_url }}/blob/master/assets/js/zzzz-search-data.json).
|
||||
Alternatively, you can create the file manually with [this content]({{ site.github.repository_url }}/blob/main/assets/js/zzzz-search-data.json).
|
||||
|
||||
22
docs/tests/index.md
Normal file
22
docs/tests/index.md
Normal file
@ -0,0 +1,22 @@
|
||||
---
|
||||
layout: default
|
||||
title: Tests
|
||||
has_children: true
|
||||
nav_order: 100
|
||||
---
|
||||
|
||||
# Tests
|
||||
|
||||
The main documentation pages of this theme illustrate the use of many of its features, which to some extent tests their implementation. The pages linked below provide further test cases for particular features, and may be useful for regression testing when developing new features.
|
||||
|
||||
The default configuration does not include the test pages. To include them, *commment-out* the following line in `_config.yml`:
|
||||
|
||||
```yaml
|
||||
, "docs/tests/"
|
||||
```
|
||||
so that it is:
|
||||
```yaml
|
||||
# , "docs/tests/"
|
||||
```
|
||||
|
||||
(Apparently Jekyll's `include` does *not* override `exclude` for the same folder...)
|
||||
14
docs/tests/navigation/disambiguation/a.md
Normal file
14
docs/tests/navigation/disambiguation/a.md
Normal file
@ -0,0 +1,14 @@
|
||||
---
|
||||
layout: default
|
||||
title: Tests for disambiguation A
|
||||
has_children: true
|
||||
---
|
||||
|
||||
# A
|
||||
|
||||
A top-level page
|
||||
|
||||
```yaml
|
||||
title: Tests for disambiguation A
|
||||
has_children: true
|
||||
```
|
||||
14
docs/tests/navigation/disambiguation/b.md
Normal file
14
docs/tests/navigation/disambiguation/b.md
Normal file
@ -0,0 +1,14 @@
|
||||
---
|
||||
layout: default
|
||||
title: Tests for disambiguation B
|
||||
has_children: true
|
||||
---
|
||||
|
||||
# B
|
||||
|
||||
A top-level page
|
||||
|
||||
```yaml
|
||||
title: Tests for disambiguation B
|
||||
has_children: true
|
||||
```
|
||||
16
docs/tests/navigation/disambiguation/ca.md
Normal file
16
docs/tests/navigation/disambiguation/ca.md
Normal file
@ -0,0 +1,16 @@
|
||||
---
|
||||
layout: default
|
||||
title: Tests for disambiguation C
|
||||
parent: Tests for disambiguation A
|
||||
has_children: true
|
||||
---
|
||||
|
||||
# C
|
||||
|
||||
A child of page A, and parent of page D
|
||||
|
||||
```yaml
|
||||
title: Tests for disambiguation C
|
||||
parent: Tests for disambiguation A
|
||||
has_children: true
|
||||
```
|
||||
16
docs/tests/navigation/disambiguation/cb.md
Normal file
16
docs/tests/navigation/disambiguation/cb.md
Normal file
@ -0,0 +1,16 @@
|
||||
---
|
||||
layout: default
|
||||
title: Tests for disambiguation C
|
||||
parent: Tests for disambiguation B
|
||||
has_children: true
|
||||
---
|
||||
|
||||
# C
|
||||
|
||||
A child of page B, and parent of page D
|
||||
|
||||
```yaml
|
||||
title: Tests for disambiguation C
|
||||
parent: Tests for disambiguation B
|
||||
has_children: true
|
||||
```
|
||||
16
docs/tests/navigation/disambiguation/dca.md
Normal file
16
docs/tests/navigation/disambiguation/dca.md
Normal file
@ -0,0 +1,16 @@
|
||||
---
|
||||
layout: default
|
||||
title: Tests for disambiguation D
|
||||
parent: Tests for disambiguation C
|
||||
grand_parent: Tests for disambiguation A
|
||||
---
|
||||
|
||||
# D
|
||||
|
||||
A grandchild of page A
|
||||
|
||||
```yaml
|
||||
title: Tests for disambiguation D
|
||||
parent: Tests for disambiguation C
|
||||
grand_parent: Tests for disambiguation A
|
||||
```
|
||||
16
docs/tests/navigation/disambiguation/dcb.md
Normal file
16
docs/tests/navigation/disambiguation/dcb.md
Normal file
@ -0,0 +1,16 @@
|
||||
---
|
||||
layout: default
|
||||
title: Tests for disambiguation D
|
||||
parent: Tests for disambiguation C
|
||||
grand_parent: Tests for disambiguation B
|
||||
---
|
||||
|
||||
# D
|
||||
|
||||
A grandchild of page B
|
||||
|
||||
```yaml
|
||||
title: Tests for disambiguation D
|
||||
parent: Tests for disambiguation C
|
||||
grand_parent: Tests for disambiguation B
|
||||
```
|
||||
14
docs/tests/navigation/disambiguation/index.md
Normal file
14
docs/tests/navigation/disambiguation/index.md
Normal file
@ -0,0 +1,14 @@
|
||||
---
|
||||
layout: default
|
||||
title: Disambiguation
|
||||
parent: Navigation
|
||||
grand_parent: Tests
|
||||
---
|
||||
|
||||
# Disambiguation
|
||||
|
||||
When different pages with children have the same title, referencing the relevant grandparent in the children disambiguates which page is intended.
|
||||
|
||||
- [Page A](a/) has a child [page with title C](ca/), and a grandchild [page with title D](dca/).
|
||||
- [Page B](b/) has a child [page with title C](cb/), and a grandchild [page with title D](dcb/).
|
||||
- The grandchild pages specify their parent and grandparent pages, so there is no ambiguity.
|
||||
13
docs/tests/navigation/exclusion/0.md
Normal file
13
docs/tests/navigation/exclusion/0.md
Normal file
@ -0,0 +1,13 @@
|
||||
---
|
||||
layout: default
|
||||
title: Tests for exclusion 0
|
||||
has_children: true
|
||||
nav_exclude: true
|
||||
---
|
||||
# Tests for exclusion 0
|
||||
|
||||
```yaml
|
||||
title: Tests for exclusion 0
|
||||
has_children: true
|
||||
nav_exclude: true
|
||||
```
|
||||
15
docs/tests/navigation/exclusion/00.md
Normal file
15
docs/tests/navigation/exclusion/00.md
Normal file
@ -0,0 +1,15 @@
|
||||
---
|
||||
layout: default
|
||||
title: Tests for exclusion 00
|
||||
parent: Tests for exclusion 0
|
||||
has_children: true
|
||||
nav_exclude: true
|
||||
---
|
||||
# Tests for exclusion 00
|
||||
|
||||
```yaml
|
||||
title: Tests for exclusion 00
|
||||
parent: Tests for exclusion 0
|
||||
has_children: true
|
||||
nav_exclude: true
|
||||
```
|
||||
17
docs/tests/navigation/exclusion/000.md
Normal file
17
docs/tests/navigation/exclusion/000.md
Normal file
@ -0,0 +1,17 @@
|
||||
---
|
||||
layout: default
|
||||
title: Tests for exclusion 000
|
||||
parent: Tests for exclusion 00
|
||||
grand_parent: Tests for exclusion 0
|
||||
has_children: false
|
||||
nav_exclude: true
|
||||
---
|
||||
# Tests for exclusion 000
|
||||
|
||||
```yaml
|
||||
title: Tests for exclusion 000
|
||||
parent: Tests for exclusion 00
|
||||
grand_parent: Tests for exclusion 0
|
||||
has_children: false
|
||||
nav_exclude: true
|
||||
```
|
||||
17
docs/tests/navigation/exclusion/001.md
Normal file
17
docs/tests/navigation/exclusion/001.md
Normal file
@ -0,0 +1,17 @@
|
||||
---
|
||||
layout: default
|
||||
title: Tests for exclusion 001
|
||||
parent: Tests for exclusion 00
|
||||
grand_parent: Tests for exclusion 0
|
||||
has_children: false
|
||||
nav_exclude: false
|
||||
---
|
||||
# Tests for exclusion 001
|
||||
|
||||
```yaml
|
||||
title: Tests for exclusion 001
|
||||
parent: Tests for exclusion 00
|
||||
grand_parent: Tests for exclusion 0
|
||||
has_children: false
|
||||
nav_exclude: false
|
||||
```
|
||||
15
docs/tests/navigation/exclusion/01.md
Normal file
15
docs/tests/navigation/exclusion/01.md
Normal file
@ -0,0 +1,15 @@
|
||||
---
|
||||
layout: default
|
||||
title: Tests for exclusion 01
|
||||
parent: Tests for exclusion 0
|
||||
has_children: true
|
||||
nav_exclude: false
|
||||
---
|
||||
# Tests for exclusion 01
|
||||
|
||||
```yaml
|
||||
title: Tests for exclusion 01
|
||||
parent: Tests for exclusion 0
|
||||
has_children: true
|
||||
nav_exclude: false
|
||||
```
|
||||
17
docs/tests/navigation/exclusion/010.md
Normal file
17
docs/tests/navigation/exclusion/010.md
Normal file
@ -0,0 +1,17 @@
|
||||
---
|
||||
layout: default
|
||||
title: Tests for exclusion 010
|
||||
parent: Tests for exclusion 01
|
||||
grand_parent: Tests for exclusion 0
|
||||
has_children: false
|
||||
nav_exclude: true
|
||||
---
|
||||
# Tests for exclusion 010
|
||||
|
||||
```yaml
|
||||
title: Tests for exclusion 010
|
||||
parent: Tests for exclusion 01
|
||||
grand_parent: Tests for exclusion 0
|
||||
has_children: false
|
||||
nav_exclude: true
|
||||
```
|
||||
17
docs/tests/navigation/exclusion/011.md
Normal file
17
docs/tests/navigation/exclusion/011.md
Normal file
@ -0,0 +1,17 @@
|
||||
---
|
||||
layout: default
|
||||
title: Tests for exclusion 011
|
||||
parent: Tests for exclusion 01
|
||||
grand_parent: Tests for exclusion 0
|
||||
has_children: false
|
||||
nav_exclude: false
|
||||
---
|
||||
# Tests for exclusion 011
|
||||
|
||||
```yaml
|
||||
title: Tests for exclusion 011
|
||||
parent: Tests for exclusion 01
|
||||
grand_parent: Tests for exclusion 0
|
||||
has_children: false
|
||||
nav_exclude: false
|
||||
```
|
||||
13
docs/tests/navigation/exclusion/1.md
Normal file
13
docs/tests/navigation/exclusion/1.md
Normal file
@ -0,0 +1,13 @@
|
||||
---
|
||||
layout: default
|
||||
title: Tests for exclusion 1
|
||||
has_children: true
|
||||
nav_exclude: false
|
||||
---
|
||||
# Tests for exclusion 1
|
||||
|
||||
```yaml
|
||||
title: Tests for exclusion 1
|
||||
has_children: true
|
||||
nav_exclude: false
|
||||
```
|
||||
15
docs/tests/navigation/exclusion/10.md
Normal file
15
docs/tests/navigation/exclusion/10.md
Normal file
@ -0,0 +1,15 @@
|
||||
---
|
||||
layout: default
|
||||
title: Tests for exclusion 10
|
||||
parent: Tests for exclusion 1
|
||||
has_children: true
|
||||
nav_exclude: true
|
||||
---
|
||||
# Tests for exclusion 10
|
||||
|
||||
```yaml
|
||||
title: Tests for exclusion 10
|
||||
parent: Tests for exclusion 1
|
||||
has_children: true
|
||||
nav_exclude: true
|
||||
```
|
||||
17
docs/tests/navigation/exclusion/100.md
Normal file
17
docs/tests/navigation/exclusion/100.md
Normal file
@ -0,0 +1,17 @@
|
||||
---
|
||||
layout: default
|
||||
title: Tests for exclusion 100
|
||||
parent: Tests for exclusion 10
|
||||
grand_parent: Tests for exclusion 1
|
||||
has_children: false
|
||||
nav_exclude: true
|
||||
---
|
||||
# Tests for exclusion 100
|
||||
|
||||
```yaml
|
||||
title: Tests for exclusion 100
|
||||
parent: Tests for exclusion 10
|
||||
grand_parent: Tests for exclusion 1
|
||||
has_children: false
|
||||
nav_exclude: true
|
||||
```
|
||||
17
docs/tests/navigation/exclusion/101.md
Normal file
17
docs/tests/navigation/exclusion/101.md
Normal file
@ -0,0 +1,17 @@
|
||||
---
|
||||
layout: default
|
||||
title: Tests for exclusion 101
|
||||
parent: Tests for exclusion 10
|
||||
grand_parent: Tests for exclusion 1
|
||||
has_children: false
|
||||
nav_exclude: false
|
||||
---
|
||||
# Tests for exclusion 101
|
||||
|
||||
```yaml
|
||||
title: Tests for exclusion 101
|
||||
parent: Tests for exclusion 10
|
||||
grand_parent: Tests for exclusion 1
|
||||
has_children: false
|
||||
nav_exclude: false
|
||||
```
|
||||
15
docs/tests/navigation/exclusion/11.md
Normal file
15
docs/tests/navigation/exclusion/11.md
Normal file
@ -0,0 +1,15 @@
|
||||
---
|
||||
layout: default
|
||||
title: Tests for exclusion 11
|
||||
parent: Tests for exclusion 1
|
||||
has_children: true
|
||||
nav_exclude: false
|
||||
---
|
||||
# Tests for exclusion 11
|
||||
|
||||
```yaml
|
||||
title: Tests for exclusion 11
|
||||
parent: Tests for exclusion 1
|
||||
has_children: true
|
||||
nav_exclude: false
|
||||
```
|
||||
17
docs/tests/navigation/exclusion/110.md
Normal file
17
docs/tests/navigation/exclusion/110.md
Normal file
@ -0,0 +1,17 @@
|
||||
---
|
||||
layout: default
|
||||
title: Tests for exclusion 110
|
||||
parent: Tests for exclusion 11
|
||||
grand_parent: Tests for exclusion 1
|
||||
has_children: false
|
||||
nav_exclude: true
|
||||
---
|
||||
# Tests for exclusion 110
|
||||
|
||||
```yaml
|
||||
title: Tests for exclusion 110
|
||||
parent: Tests for exclusion 11
|
||||
grand_parent: Tests for exclusion 1
|
||||
has_children: false
|
||||
nav_exclude: true
|
||||
```
|
||||
17
docs/tests/navigation/exclusion/111.md
Normal file
17
docs/tests/navigation/exclusion/111.md
Normal file
@ -0,0 +1,17 @@
|
||||
---
|
||||
layout: default
|
||||
title: Tests for exclusion 111
|
||||
parent: Tests for exclusion 11
|
||||
grand_parent: Tests for exclusion 1
|
||||
has_children: false
|
||||
nav_exclude: false
|
||||
---
|
||||
# Tests for exclusion 111
|
||||
|
||||
```yaml
|
||||
title: Tests for exclusion 111
|
||||
parent: Tests for exclusion 11
|
||||
grand_parent: Tests for exclusion 1
|
||||
has_children: false
|
||||
nav_exclude: false
|
||||
```
|
||||
11
docs/tests/navigation/exclusion/excluded.md
Normal file
11
docs/tests/navigation/exclusion/excluded.md
Normal file
@ -0,0 +1,11 @@
|
||||
---
|
||||
layout: default
|
||||
nav_exclude: true
|
||||
---
|
||||
# Tests for exclusion untitled and excluded
|
||||
|
||||
This page does not have a `title`, and it is explicitly excluded from the navigation
|
||||
|
||||
```yaml
|
||||
nav_exclude: true
|
||||
```
|
||||
36
docs/tests/navigation/exclusion/index.md
Normal file
36
docs/tests/navigation/exclusion/index.md
Normal file
@ -0,0 +1,36 @@
|
||||
---
|
||||
layout: default
|
||||
title: Exclusion
|
||||
parent: Navigation
|
||||
grand_parent: Tests
|
||||
---
|
||||
|
||||
# Exclusion
|
||||
|
||||
Pages excluded from the main navigation can have parents and children. Navigation to and between excluded pages can be supported by the auto-generating list of child pages inserted at the bottom of each page, and by links to parents in the breadcrumbs at the top of each page.
|
||||
|
||||
The following tests cover all combinations of excluded and included pages for the top level, child pages, and grandchild pages. The last binary digit in a page title indicates whether the page is included (1) or excluded (0); preceding digits refer to its parent and grandparent.
|
||||
|
||||
## Included in main navigation
|
||||
|
||||
- [Tests for exclusion 1](1/)
|
||||
- [Tests for exclusion 11](11/)
|
||||
- [Tests for exclusion 111](111/)
|
||||
|
||||
## Included only in child navigation
|
||||
|
||||
- [Tests for exclusion 110](110/)
|
||||
- [Tests for exclusion 10](10/)
|
||||
- [Tests for exclusion 101](101/)
|
||||
- [Tests for exclusion 100](100/)
|
||||
- [Tests for exclusion 01](01/)
|
||||
- [Tests for exclusion 011](011/)
|
||||
- [Tests for exclusion 010](010/)
|
||||
- [Tests for exclusion 00](00/)
|
||||
- [Tests for exclusion 001](001/)
|
||||
- [Tests for exclusion 000](000/)
|
||||
|
||||
## Not included in main or child navigation
|
||||
|
||||
- [Tests for exclusion 0](0/)
|
||||
- ["Untitled"](untitled/)
|
||||
6
docs/tests/navigation/exclusion/untitled.md
Normal file
6
docs/tests/navigation/exclusion/untitled.md
Normal file
@ -0,0 +1,6 @@
|
||||
---
|
||||
layout: default
|
||||
---
|
||||
# Tests for exclusion untitled
|
||||
|
||||
This page does not have a `title`, and it is excluded from the navigation -- unless it is located in a Jekyll collection (which provides default titles). To exclude a title-less page from the navigation, regardless of whether it is located in a collection, set `nav_exclude: true`.
|
||||
8
docs/tests/navigation/index.md
Normal file
8
docs/tests/navigation/index.md
Normal file
@ -0,0 +1,8 @@
|
||||
---
|
||||
layout: default
|
||||
title: Navigation
|
||||
parent: Tests
|
||||
has_children: true
|
||||
---
|
||||
|
||||
# Navigation
|
||||
14
docs/tests/navigation/order/default/10.md
Normal file
14
docs/tests/navigation/order/default/10.md
Normal file
@ -0,0 +1,14 @@
|
||||
---
|
||||
layout: default
|
||||
title: "10"
|
||||
parent: Default
|
||||
grand_parent: Tests for order
|
||||
---
|
||||
|
||||
# 10
|
||||
|
||||
```yaml
|
||||
title: "10"
|
||||
parent: Default
|
||||
grand_parent: Tests for order
|
||||
```
|
||||
14
docs/tests/navigation/order/default/2.md
Normal file
14
docs/tests/navigation/order/default/2.md
Normal file
@ -0,0 +1,14 @@
|
||||
---
|
||||
layout: default
|
||||
title: "2"
|
||||
parent: Default
|
||||
grand_parent: Tests for order
|
||||
---
|
||||
|
||||
# 2
|
||||
|
||||
```yaml
|
||||
title: "2"
|
||||
parent: Default
|
||||
grand_parent: Tests for order
|
||||
```
|
||||
14
docs/tests/navigation/order/default/a.md
Normal file
14
docs/tests/navigation/order/default/a.md
Normal file
@ -0,0 +1,14 @@
|
||||
---
|
||||
layout: default
|
||||
title: A
|
||||
parent: Default
|
||||
grand_parent: Tests for order
|
||||
---
|
||||
|
||||
# A
|
||||
|
||||
```yaml
|
||||
title: A
|
||||
parent: Default
|
||||
grand_parent: Tests for order
|
||||
```
|
||||
14
docs/tests/navigation/order/default/aa-lower.md
Normal file
14
docs/tests/navigation/order/default/aa-lower.md
Normal file
@ -0,0 +1,14 @@
|
||||
---
|
||||
layout: default
|
||||
title: aa
|
||||
parent: Default
|
||||
grand_parent: Tests for order
|
||||
---
|
||||
|
||||
# aa
|
||||
|
||||
```yaml
|
||||
title: aa
|
||||
parent: Default
|
||||
grand_parent: Tests for order
|
||||
```
|
||||
14
docs/tests/navigation/order/default/aa.md
Normal file
14
docs/tests/navigation/order/default/aa.md
Normal file
@ -0,0 +1,14 @@
|
||||
---
|
||||
layout: default
|
||||
title: Aa
|
||||
parent: Default
|
||||
grand_parent: Tests for order
|
||||
---
|
||||
|
||||
# Aa
|
||||
|
||||
```yaml
|
||||
title: Aa
|
||||
parent: Default
|
||||
grand_parent: Tests for order
|
||||
```
|
||||
15
docs/tests/navigation/order/default/index.md
Normal file
15
docs/tests/navigation/order/default/index.md
Normal file
@ -0,0 +1,15 @@
|
||||
---
|
||||
layout: default
|
||||
title: Default
|
||||
parent: Tests for order
|
||||
nav_order: 1
|
||||
has_children: true
|
||||
---
|
||||
|
||||
# Default Order
|
||||
|
||||
When `nav_order` fields are omitted, the pages are ordered alphabetically by their titles.
|
||||
|
||||
By default, all Capital letters come before all lowercase letters; you can add `nav_sort: case_insensitive` in the configuration file to ignore the case).
|
||||
|
||||
Digits precede letters, and numeric titles are ordered lexicographically: `10` precedes `2` (in contrast to explicit numeric `nav_order` values).
|
||||
16
docs/tests/navigation/order/floats/-1.1.md
Normal file
16
docs/tests/navigation/order/floats/-1.1.md
Normal file
@ -0,0 +1,16 @@
|
||||
---
|
||||
layout: default
|
||||
title: "-1.1"
|
||||
nav_order: -1.1
|
||||
parent: Floats
|
||||
grand_parent: Tests for order
|
||||
---
|
||||
|
||||
# -1.1
|
||||
|
||||
```yaml
|
||||
title: "-1.1"
|
||||
nav_order: -1.1
|
||||
parent: Floats
|
||||
grand_parent: Tests for order
|
||||
```
|
||||
16
docs/tests/navigation/order/floats/0.0.md
Normal file
16
docs/tests/navigation/order/floats/0.0.md
Normal file
@ -0,0 +1,16 @@
|
||||
---
|
||||
layout: default
|
||||
title: "0.0"
|
||||
nav_order: 0.0
|
||||
parent: Floats
|
||||
grand_parent: Tests for order
|
||||
---
|
||||
|
||||
# 0.0
|
||||
|
||||
```yaml
|
||||
title: "0.0"
|
||||
nav_order: 0.0
|
||||
parent: Floats
|
||||
grand_parent: Tests for order
|
||||
```
|
||||
16
docs/tests/navigation/order/floats/10.0.md
Normal file
16
docs/tests/navigation/order/floats/10.0.md
Normal file
@ -0,0 +1,16 @@
|
||||
---
|
||||
layout: default
|
||||
title: "10.0"
|
||||
nav_order: 10.0
|
||||
parent: Floats
|
||||
grand_parent: Tests for order
|
||||
---
|
||||
|
||||
# 10.0
|
||||
|
||||
```yaml
|
||||
title: "10.0"
|
||||
nav_order: 10.0
|
||||
parent: Floats
|
||||
grand_parent: Tests for order
|
||||
```
|
||||
16
docs/tests/navigation/order/floats/2.2222.md
Normal file
16
docs/tests/navigation/order/floats/2.2222.md
Normal file
@ -0,0 +1,16 @@
|
||||
---
|
||||
layout: default
|
||||
title: "2.2222"
|
||||
nav_order: 2.2222
|
||||
parent: Floats
|
||||
grand_parent: Tests for order
|
||||
---
|
||||
|
||||
# 2.2222
|
||||
|
||||
```yaml
|
||||
title: "2.2222"
|
||||
nav_order: 2.2222
|
||||
parent: Floats
|
||||
grand_parent: Tests for order
|
||||
```
|
||||
13
docs/tests/navigation/order/floats/index.md
Normal file
13
docs/tests/navigation/order/floats/index.md
Normal file
@ -0,0 +1,13 @@
|
||||
---
|
||||
layout: default
|
||||
title: Floats
|
||||
parent: Tests for order
|
||||
nav_order: 4
|
||||
has_children: true
|
||||
---
|
||||
|
||||
# Floating-Point Order
|
||||
|
||||
When `nav_order` fields are floating-point numbers, the pages are ordered in increasing order of the numerical values.
|
||||
|
||||
Floats include `0.0` and negative values.
|
||||
16
docs/tests/navigation/order/index.md
Normal file
16
docs/tests/navigation/order/index.md
Normal file
@ -0,0 +1,16 @@
|
||||
---
|
||||
layout: default
|
||||
title: Order
|
||||
parent: Navigation
|
||||
grand_parent: Tests
|
||||
---
|
||||
|
||||
# Order
|
||||
|
||||
The value of `nav_order` can be numbers (integers, floats) and/or strings. The following tests illustrate their effects.
|
||||
|
||||
- [Default](default/), using `title` instead of `nav_order` fields.
|
||||
- [Strings](strings/), lexicographically ordered, possibly case-insensitively.
|
||||
- [Integers](integers/), numerically ordered.
|
||||
- [Floats](floats/), numerically ordered.
|
||||
- [Mixture](mixture/), with numbers before strings.
|
||||
16
docs/tests/navigation/order/integers/-1.md
Normal file
16
docs/tests/navigation/order/integers/-1.md
Normal file
@ -0,0 +1,16 @@
|
||||
---
|
||||
layout: default
|
||||
title: "-1"
|
||||
nav_order: -1
|
||||
parent: Integers
|
||||
grand_parent: Tests for order
|
||||
---
|
||||
|
||||
# -1
|
||||
|
||||
```yaml
|
||||
title: "-1"
|
||||
nav_order: -1
|
||||
parent: Integers
|
||||
grand_parent: Tests for order
|
||||
```
|
||||
16
docs/tests/navigation/order/integers/0.md
Normal file
16
docs/tests/navigation/order/integers/0.md
Normal file
@ -0,0 +1,16 @@
|
||||
---
|
||||
layout: default
|
||||
title: "0"
|
||||
nav_order: 0
|
||||
parent: Integers
|
||||
grand_parent: Tests for order
|
||||
---
|
||||
|
||||
# 0
|
||||
|
||||
```yaml
|
||||
title: "0"
|
||||
nav_order: 0
|
||||
parent: Integers
|
||||
grand_parent: Tests for order
|
||||
```
|
||||
16
docs/tests/navigation/order/integers/10.md
Normal file
16
docs/tests/navigation/order/integers/10.md
Normal file
@ -0,0 +1,16 @@
|
||||
---
|
||||
layout: default
|
||||
title: "10"
|
||||
nav_order: 10
|
||||
parent: Integers
|
||||
grand_parent: Tests for order
|
||||
---
|
||||
|
||||
# 10
|
||||
|
||||
```yaml
|
||||
title: "10"
|
||||
nav_order: 10
|
||||
parent: Integers
|
||||
grand_parent: Tests for order
|
||||
```
|
||||
16
docs/tests/navigation/order/integers/2.md
Normal file
16
docs/tests/navigation/order/integers/2.md
Normal file
@ -0,0 +1,16 @@
|
||||
---
|
||||
layout: default
|
||||
title: "2"
|
||||
nav_order: 2
|
||||
parent: Integers
|
||||
grand_parent: Tests for order
|
||||
---
|
||||
|
||||
# 2
|
||||
|
||||
```yaml
|
||||
title: "2"
|
||||
nav_order: 2
|
||||
parent: Integers
|
||||
grand_parent: Tests for order
|
||||
```
|
||||
13
docs/tests/navigation/order/integers/index.md
Normal file
13
docs/tests/navigation/order/integers/index.md
Normal file
@ -0,0 +1,13 @@
|
||||
---
|
||||
layout: default
|
||||
title: Integers
|
||||
parent: Tests for order
|
||||
nav_order: 3
|
||||
has_children: true
|
||||
---
|
||||
|
||||
# Integer Order
|
||||
|
||||
When `nav_order` fields are integers, the pages are ordered in increasing order of the numerical values.
|
||||
|
||||
Integers include `0` and negative values. Integers can be reused for top-level pages and for different sets of child pages.
|
||||
16
docs/tests/navigation/order/mixture/-1.1.md
Normal file
16
docs/tests/navigation/order/mixture/-1.1.md
Normal file
@ -0,0 +1,16 @@
|
||||
---
|
||||
layout: default
|
||||
title: "-1.1"
|
||||
nav_order: -1.1
|
||||
parent: Mixture
|
||||
grand_parent: Tests for order
|
||||
---
|
||||
|
||||
# -1.1
|
||||
|
||||
```yaml
|
||||
title: "-1.1"
|
||||
nav_order: -1.1
|
||||
parent: Mixture
|
||||
grand_parent: Tests for order
|
||||
```
|
||||
16
docs/tests/navigation/order/mixture/-1.md
Normal file
16
docs/tests/navigation/order/mixture/-1.md
Normal file
@ -0,0 +1,16 @@
|
||||
---
|
||||
layout: default
|
||||
title: "-1"
|
||||
nav_order: -1
|
||||
parent: Mixture
|
||||
grand_parent: Tests for order
|
||||
---
|
||||
|
||||
# -1
|
||||
|
||||
```yaml
|
||||
title: "-1"
|
||||
nav_order: -1
|
||||
parent: Mixture
|
||||
grand_parent: Tests for order
|
||||
```
|
||||
16
docs/tests/navigation/order/mixture/0.0.md
Normal file
16
docs/tests/navigation/order/mixture/0.0.md
Normal file
@ -0,0 +1,16 @@
|
||||
---
|
||||
layout: default
|
||||
title: "0.0"
|
||||
nav_order: 0.0
|
||||
parent: Mixture
|
||||
grand_parent: Tests for order
|
||||
---
|
||||
|
||||
# 0.0
|
||||
|
||||
```yaml
|
||||
title: "0.0"
|
||||
nav_order: 0.0
|
||||
parent: Mixture
|
||||
grand_parent: Tests for order
|
||||
```
|
||||
16
docs/tests/navigation/order/mixture/0.md
Normal file
16
docs/tests/navigation/order/mixture/0.md
Normal file
@ -0,0 +1,16 @@
|
||||
---
|
||||
layout: default
|
||||
title: "0"
|
||||
nav_order: 0
|
||||
parent: Mixture
|
||||
grand_parent: Tests for order
|
||||
---
|
||||
|
||||
# 0
|
||||
|
||||
```yaml
|
||||
title: "0"
|
||||
nav_order: 0
|
||||
parent: Mixture
|
||||
grand_parent: Tests for order
|
||||
```
|
||||
16
docs/tests/navigation/order/mixture/10.0.md
Normal file
16
docs/tests/navigation/order/mixture/10.0.md
Normal file
@ -0,0 +1,16 @@
|
||||
---
|
||||
layout: default
|
||||
title: "10.0"
|
||||
nav_order: 10.0
|
||||
parent: Mixture
|
||||
grand_parent: Tests for order
|
||||
---
|
||||
|
||||
# 10.0
|
||||
|
||||
```yaml
|
||||
title: "10.0"
|
||||
nav_order: 10.0
|
||||
parent: Mixture
|
||||
grand_parent: Tests for order
|
||||
```
|
||||
14
docs/tests/navigation/order/mixture/10.md
Normal file
14
docs/tests/navigation/order/mixture/10.md
Normal file
@ -0,0 +1,14 @@
|
||||
---
|
||||
layout: default
|
||||
title: "10"
|
||||
parent: Mixture
|
||||
grand_parent: Tests for order
|
||||
---
|
||||
|
||||
# 10
|
||||
|
||||
```yaml
|
||||
title: "10"
|
||||
parent: Mixture
|
||||
grand_parent: Tests for order
|
||||
```
|
||||
16
docs/tests/navigation/order/mixture/2.2222.md
Normal file
16
docs/tests/navigation/order/mixture/2.2222.md
Normal file
@ -0,0 +1,16 @@
|
||||
---
|
||||
layout: default
|
||||
title: "2.2222"
|
||||
nav_order: 2.2222
|
||||
parent: Mixture
|
||||
grand_parent: Tests for order
|
||||
---
|
||||
|
||||
# 2.2222
|
||||
|
||||
```yaml
|
||||
title: "2.2222"
|
||||
nav_order: 2.2222
|
||||
parent: Mixture
|
||||
grand_parent: Tests for order
|
||||
```
|
||||
14
docs/tests/navigation/order/mixture/2.md
Normal file
14
docs/tests/navigation/order/mixture/2.md
Normal file
@ -0,0 +1,14 @@
|
||||
---
|
||||
layout: default
|
||||
title: "2"
|
||||
parent: Mixture
|
||||
grand_parent: Tests for order
|
||||
---
|
||||
|
||||
# 2
|
||||
|
||||
```yaml
|
||||
title: "2"
|
||||
parent: Mixture
|
||||
grand_parent: Tests for order
|
||||
```
|
||||
14
docs/tests/navigation/order/mixture/a.md
Normal file
14
docs/tests/navigation/order/mixture/a.md
Normal file
@ -0,0 +1,14 @@
|
||||
---
|
||||
layout: default
|
||||
title: A
|
||||
parent: Mixture
|
||||
grand_parent: Tests for order
|
||||
---
|
||||
|
||||
# A
|
||||
|
||||
```yaml
|
||||
title: A
|
||||
parent: Mixture
|
||||
grand_parent: Tests for order
|
||||
```
|
||||
16
docs/tests/navigation/order/mixture/aa-lower.md
Normal file
16
docs/tests/navigation/order/mixture/aa-lower.md
Normal file
@ -0,0 +1,16 @@
|
||||
---
|
||||
layout: default
|
||||
title: aa
|
||||
nav_order: "aa"
|
||||
parent: Mixture
|
||||
grand_parent: Tests for order
|
||||
---
|
||||
|
||||
# aa
|
||||
|
||||
```yaml
|
||||
title: aa
|
||||
nav_order: "aa"
|
||||
parent: Mixture
|
||||
grand_parent: Tests for order
|
||||
```
|
||||
16
docs/tests/navigation/order/mixture/aa.md
Normal file
16
docs/tests/navigation/order/mixture/aa.md
Normal file
@ -0,0 +1,16 @@
|
||||
---
|
||||
layout: default
|
||||
title: Aa
|
||||
nav_order: "Aa"
|
||||
parent: Mixture
|
||||
grand_parent: Tests for order
|
||||
---
|
||||
|
||||
# Aa
|
||||
|
||||
```yaml
|
||||
title: Aa
|
||||
nav_order: "Aa"
|
||||
parent: Mixture
|
||||
grand_parent: Tests for order
|
||||
```
|
||||
11
docs/tests/navigation/order/mixture/index.md
Normal file
11
docs/tests/navigation/order/mixture/index.md
Normal file
@ -0,0 +1,11 @@
|
||||
---
|
||||
layout: default
|
||||
title: Mixture
|
||||
parent: Tests for order
|
||||
nav_order: 5
|
||||
has_children: true
|
||||
---
|
||||
|
||||
# Mixed Order
|
||||
|
||||
It seems unlikely that different types of `nav_order` values are needed for the children of the same parent.
|
||||
7
docs/tests/navigation/order/order.md
Normal file
7
docs/tests/navigation/order/order.md
Normal file
@ -0,0 +1,7 @@
|
||||
---
|
||||
layout: default
|
||||
title: Tests for order
|
||||
has_children: true
|
||||
---
|
||||
|
||||
# Order
|
||||
16
docs/tests/navigation/order/strings/10.md
Normal file
16
docs/tests/navigation/order/strings/10.md
Normal file
@ -0,0 +1,16 @@
|
||||
---
|
||||
layout: default
|
||||
title: "10"
|
||||
nav_order: "10"
|
||||
parent: Strings
|
||||
grand_parent: Tests for order
|
||||
---
|
||||
|
||||
# 10
|
||||
|
||||
```yaml
|
||||
title: "10"
|
||||
nav_order: "10"
|
||||
parent: Strings
|
||||
grand_parent: Tests for order
|
||||
```
|
||||
16
docs/tests/navigation/order/strings/2.md
Normal file
16
docs/tests/navigation/order/strings/2.md
Normal file
@ -0,0 +1,16 @@
|
||||
---
|
||||
layout: default
|
||||
title: "2"
|
||||
nav_order: "2"
|
||||
parent: Strings
|
||||
grand_parent: Tests for order
|
||||
---
|
||||
|
||||
# 2
|
||||
|
||||
```yaml
|
||||
title: "2"
|
||||
nav_order: "2"
|
||||
parent: Strings
|
||||
grand_parent: Tests for order
|
||||
```
|
||||
16
docs/tests/navigation/order/strings/a.md
Normal file
16
docs/tests/navigation/order/strings/a.md
Normal file
@ -0,0 +1,16 @@
|
||||
---
|
||||
layout: default
|
||||
title: A
|
||||
nav_order: A
|
||||
parent: Strings
|
||||
grand_parent: Tests for order
|
||||
---
|
||||
|
||||
# A
|
||||
|
||||
```yaml
|
||||
title: A
|
||||
nav_order: A
|
||||
parent: Strings
|
||||
grand_parent: Tests for order
|
||||
```
|
||||
16
docs/tests/navigation/order/strings/aa-lower.md
Normal file
16
docs/tests/navigation/order/strings/aa-lower.md
Normal file
@ -0,0 +1,16 @@
|
||||
---
|
||||
layout: default
|
||||
title: aa
|
||||
nav_order: "aa"
|
||||
parent: Strings
|
||||
grand_parent: Tests for order
|
||||
---
|
||||
|
||||
# aa
|
||||
|
||||
```yaml
|
||||
title: aa
|
||||
nav_order: "aa"
|
||||
parent: Strings
|
||||
grand_parent: Tests for order
|
||||
```
|
||||
16
docs/tests/navigation/order/strings/aa.md
Normal file
16
docs/tests/navigation/order/strings/aa.md
Normal file
@ -0,0 +1,16 @@
|
||||
---
|
||||
layout: default
|
||||
title: Aa
|
||||
nav_order: "Aa"
|
||||
parent: Strings
|
||||
grand_parent: Tests for order
|
||||
---
|
||||
|
||||
# Aa
|
||||
|
||||
```yaml
|
||||
title: Aa
|
||||
nav_order: "Aa"
|
||||
parent: Strings
|
||||
grand_parent: Tests for order
|
||||
```
|
||||
13
docs/tests/navigation/order/strings/index.md
Normal file
13
docs/tests/navigation/order/strings/index.md
Normal file
@ -0,0 +1,13 @@
|
||||
---
|
||||
layout: default
|
||||
title: Strings
|
||||
parent: Tests for order
|
||||
nav_order: 2
|
||||
has_children: true
|
||||
---
|
||||
|
||||
# String Order
|
||||
|
||||
By default, all Capital letters come before all lowercase letters; you can add `nav_sort: case_insensitive` in the configuration file to ignore the case).
|
||||
|
||||
Digits precede letters, and numeric titles are ordered lexicographically: `"10"` precedes `"2"` (in contrast to explicit numeric `nav_order` values).
|
||||
83
docs/tests/styling/dl.md
Normal file
83
docs/tests/styling/dl.md
Normal file
@ -0,0 +1,83 @@
|
||||
---
|
||||
layout: default
|
||||
title: Description lists
|
||||
parent: Styling
|
||||
grand_parent: Tests
|
||||
---
|
||||
|
||||
# Description lists
|
||||
|
||||
The first child element of each `dd` element in a `dl` list should be aligned with the preceding `dt` element in the following examples.
|
||||
|
||||
term
|
||||
|
||||
: paragraph text
|
||||
|
||||
paragraph text
|
||||
|
||||
term
|
||||
|
||||
: ### Header
|
||||
|
||||
paragraph text
|
||||
|
||||
term
|
||||
|
||||
: > block quote
|
||||
|
||||
paragraph text
|
||||
|
||||
term
|
||||
|
||||
: ```sh
|
||||
fenced code block
|
||||
```
|
||||
|
||||
paragraph text
|
||||
|
||||
term
|
||||
|
||||
: + unordered list item
|
||||
+ unordered list item
|
||||
|
||||
paragraph text
|
||||
|
||||
term
|
||||
|
||||
: 1. ordered list item
|
||||
2. ordered list item
|
||||
|
||||
paragraph text
|
||||
|
||||
term
|
||||
|
||||
: sub-term
|
||||
: sub-description
|
||||
|
||||
sub-term
|
||||
: sub-description
|
||||
|
||||
paragraph text
|
||||
|
||||
term
|
||||
|
||||
: |-----------------+------------+-----------------+----------------|
|
||||
| Default aligned |Left aligned| Center aligned | Right aligned |
|
||||
|-----------------|:-----------|:---------------:|---------------:|
|
||||
| First body part |Second cell | Third cell | fourth cell |
|
||||
| Second line |foo | **strong** | baz |
|
||||
| Third line |quux | baz | bar |
|
||||
|-----------------+------------+-----------------+----------------|
|
||||
| Second body | | | |
|
||||
| 2 line | | | |
|
||||
|=================+============+=================+================|
|
||||
| Footer row | | | |
|
||||
|-----------------+------------+-----------------+----------------|
|
||||
|
||||
paragraph text
|
||||
|
||||
term
|
||||
|
||||
: ***
|
||||
|
||||
paragraph text
|
||||
8
docs/tests/styling/index.md
Normal file
8
docs/tests/styling/index.md
Normal file
@ -0,0 +1,8 @@
|
||||
---
|
||||
layout: default
|
||||
title: Styling
|
||||
parent: Tests
|
||||
has_children: true
|
||||
---
|
||||
|
||||
# Styling
|
||||
65
docs/tests/styling/ol.md
Normal file
65
docs/tests/styling/ol.md
Normal file
@ -0,0 +1,65 @@
|
||||
---
|
||||
layout: default
|
||||
title: Ordered lists
|
||||
parent: Styling
|
||||
grand_parent: Tests
|
||||
---
|
||||
|
||||
# Ordered lists
|
||||
|
||||
The first child element of each `li` element in an `ol` list should be aligned with the preceding label in the following examples.
|
||||
|
||||
1. paragraph text
|
||||
|
||||
paragraph text
|
||||
|
||||
1. ### Header
|
||||
|
||||
paragraph text
|
||||
|
||||
1. > block quote
|
||||
|
||||
paragraph text
|
||||
|
||||
1. ```sh
|
||||
fenced code block
|
||||
```
|
||||
|
||||
paragraph text
|
||||
|
||||
1. + unordered list item
|
||||
+ unordered list item
|
||||
|
||||
paragraph text
|
||||
|
||||
1. 1. ordered list item
|
||||
2. ordered list item
|
||||
|
||||
paragraph text
|
||||
|
||||
1. term
|
||||
: description
|
||||
|
||||
term
|
||||
: description
|
||||
|
||||
paragraph text
|
||||
|
||||
1. |-----------------+------------+-----------------+----------------|
|
||||
| Default aligned |Left aligned| Center aligned | Right aligned |
|
||||
|-----------------|:-----------|:---------------:|---------------:|
|
||||
| First body part |Second cell | Third cell | fourth cell |
|
||||
| Second line |foo | **strong** | baz |
|
||||
| Third line |quux | baz | bar |
|
||||
|-----------------+------------+-----------------+----------------|
|
||||
| Second body | | | |
|
||||
| 2 line | | | |
|
||||
|=================+============+=================+================|
|
||||
| Footer row | | | |
|
||||
|-----------------+------------+-----------------+----------------|
|
||||
|
||||
paragraph text
|
||||
|
||||
1. ***
|
||||
|
||||
paragraph text
|
||||
65
docs/tests/styling/ul.md
Normal file
65
docs/tests/styling/ul.md
Normal file
@ -0,0 +1,65 @@
|
||||
---
|
||||
layout: default
|
||||
title: Unordered lists
|
||||
parent: Styling
|
||||
grand_parent: Tests
|
||||
---
|
||||
|
||||
# Unordered lists
|
||||
|
||||
The first child element of each `li` element in a `ul` list should be aligned with the preceding bullet in the following examples.
|
||||
|
||||
- paragraph text
|
||||
|
||||
paragraph text
|
||||
|
||||
- ### Header
|
||||
|
||||
paragraph text
|
||||
|
||||
- > block quote
|
||||
|
||||
paragraph text
|
||||
|
||||
- ```sh
|
||||
fenced code block
|
||||
```
|
||||
|
||||
paragraph text
|
||||
|
||||
- + unordered list item
|
||||
+ unordered list item
|
||||
|
||||
paragraph text
|
||||
|
||||
- 1. ordered list item
|
||||
2. ordered list item
|
||||
|
||||
paragraph text
|
||||
|
||||
- term
|
||||
: description
|
||||
|
||||
term
|
||||
: description
|
||||
|
||||
paragraph text
|
||||
|
||||
- |-----------------+------------+-----------------+----------------|
|
||||
| Default aligned |Left aligned| Center aligned | Right aligned |
|
||||
|-----------------|:-----------|:---------------:|---------------:|
|
||||
| First body part |Second cell | Third cell | fourth cell |
|
||||
| Second line |foo | **strong** | baz |
|
||||
| Third line |quux | baz | bar |
|
||||
|-----------------+------------+-----------------+----------------|
|
||||
| Second body | | | |
|
||||
| 2 line | | | |
|
||||
|=================+============+=================+================|
|
||||
| Footer row | | | |
|
||||
|-----------------+------------+-----------------+----------------|
|
||||
|
||||
paragraph text
|
||||
|
||||
- ***
|
||||
|
||||
paragraph text
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user