mirror of
https://github.com/snachodog/just-the-docs.git
synced 2025-09-16 06:13:32 -06:00
Compare commits
113 Commits
v0.3.3-doc
...
v0.4.0.rc1
Author | SHA1 | Date | |
---|---|---|---|
|
2cc1a26a0d | ||
|
ffa4ec1994 | ||
|
daa86968bb | ||
|
d364a8152e | ||
|
e2f1546c61 | ||
|
1d15ea3b84 | ||
|
d3c73eb525 | ||
|
1bef041a01 | ||
|
672c284b6f | ||
|
528141d30c | ||
|
64c909aeb3 | ||
|
b00867a831 | ||
|
a12f53b1f1 | ||
|
3ab276ba1e | ||
|
6a380039a0 | ||
|
3c14eeef2e | ||
|
9e725fc746 | ||
|
b2581c19a6 | ||
|
0a7be65c32 | ||
|
c2ec3d89c2 | ||
|
f6b22804bc | ||
|
a6f0452115 | ||
|
146ab184d8 | ||
|
2049ebc394 | ||
|
cc2110d743 | ||
|
5d4de413c0 | ||
|
ba472b9aef | ||
|
7422c87605 | ||
|
38e3ed6881 | ||
|
2e23f7b7ed | ||
|
009a0f9c5a | ||
|
6907f06977 | ||
|
3ca57e3b0d | ||
|
764dbb35a9 | ||
|
7a3c37052f | ||
|
2bfe85658b | ||
|
0ff0a4bbab | ||
|
ff3771968b | ||
|
6287d8a6da | ||
|
26fad7dd0f | ||
|
c980fd4a64 | ||
|
312f1bceac | ||
|
d083aeb3fd | ||
|
c68a19b906 | ||
|
5fd9c3b32c | ||
|
1ecc3d08e0 | ||
|
70b34f01f7 | ||
|
10388ed8b0 | ||
|
a45b328c7a | ||
|
2b4f399336 | ||
|
3a834d24ab | ||
|
6afa220a39 | ||
|
e892a261fb | ||
|
68b7c8a534 | ||
|
aac87fad27 | ||
|
260d98d825 | ||
|
4e0e3ab3d8 | ||
|
9fe92419da | ||
|
e513fd6fdb | ||
|
a14f32ceed | ||
|
e2150256f2 | ||
|
b0ed390a9f | ||
|
00d3b4fe5a | ||
|
45120c8742 | ||
|
2136b55a52 | ||
|
25de2c03a3 | ||
|
c589be462e | ||
|
4dfe5273f2 | ||
|
351a0b7ff4 | ||
|
e8ba44167c | ||
|
444512c06a | ||
|
ac91b2dd1c | ||
|
89fb42dc66 | ||
|
9fa3a0fc5f | ||
|
577b9c5862 | ||
|
0f3d0e8285 | ||
|
37e90d2676 | ||
|
655335d552 | ||
|
ee47119f31 | ||
|
4dedfe0b50 | ||
|
7e111fa8c2 | ||
|
1032a0aae3 | ||
|
3eb4ceb59a | ||
|
0519013521 | ||
|
aae3d0309f | ||
|
6f8ae3e97e | ||
|
7f354d47a3 | ||
|
f8331f1c26 | ||
|
25aa612617 | ||
|
2692e6714c | ||
|
bc4a91c61a | ||
|
fbf125d525 | ||
|
265e88ed7a | ||
|
501c007da1 | ||
|
79f30a22bc | ||
|
13298d20c0 | ||
|
7631aaa309 | ||
|
fac7af13c1 | ||
|
2aa9815064 | ||
|
978846f704 | ||
|
c2f78516b4 | ||
|
04ae951436 | ||
|
404059ab03 | ||
|
e842498637 | ||
|
7f5ebee9b8 | ||
|
cb7df09c8f | ||
|
8bc53f8f45 | ||
|
4ab61105b9 | ||
|
9d4a0a56b7 | ||
|
9e52e712ae | ||
|
3726697fab | ||
|
d24b06ad73 | ||
|
06e61cb2bb |
14
.devcontainer/Dockerfile
Normal file
14
.devcontainer/Dockerfile
Normal file
@@ -0,0 +1,14 @@
|
||||
# [Choice] Debian OS version (use bullseye on local arm64/Apple Silicon): bullseye, buster
|
||||
ARG VARIANT=bullseye
|
||||
FROM mcr.microsoft.com/vscode/devcontainers/jekyll:0-${VARIANT}
|
||||
|
||||
# [Choice] Node.js version: none, lts/*, 16, 14, 12, 10
|
||||
ARG NODE_VERSION="none"
|
||||
RUN if [ "${NODE_VERSION}" != "none" ]; then su vscode -c "umask 0002 && . /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi
|
||||
|
||||
# [Optional] Uncomment this section to install additional OS packages.
|
||||
# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
|
||||
# && apt-get -y install --no-install-recommends <your-package-list-here>
|
||||
|
||||
# [Optional] Uncomment this line to install global node packages.
|
||||
# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g <your-package-here>" 2>&1
|
26
.devcontainer/base.Dockerfile
Normal file
26
.devcontainer/base.Dockerfile
Normal file
@@ -0,0 +1,26 @@
|
||||
# [Choice] Debian OS version (use 2.7-bullseye on local arm64/Apple Silicon): 2.7-bullseye, 2.7-buster
|
||||
ARG VARIANT=2.7-bullseye
|
||||
FROM mcr.microsoft.com/vscode/devcontainers/ruby:${VARIANT}
|
||||
COPY library-scripts/meta.env /usr/local/etc/vscode-dev-containers
|
||||
|
||||
# ENV Variables required by Jekyll
|
||||
ENV LANG=en_US.UTF-8 \
|
||||
LANGUAGE=en_US:en \
|
||||
TZ=Etc/UTC \
|
||||
LC_ALL=en_US.UTF-8 \
|
||||
LANG=en_US.UTF-8 \
|
||||
LANGUAGE=en_US
|
||||
|
||||
# Install bundler, latest jekyll, and github-pages for older jekyll
|
||||
RUN gem install bundler jekyll github-pages
|
||||
|
||||
# [Choice] Node.js version: none, lts/*, 16, 14, 12, 10
|
||||
ARG NODE_VERSION="none"
|
||||
RUN if [ "${NODE_VERSION}" != "none" ]; then su vscode -c "umask 0002 && . /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi
|
||||
|
||||
# [Optional] Uncomment this section to install additional OS packages.
|
||||
# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
|
||||
# && apt-get -y install --no-install-recommends <your-package-list-here>
|
||||
|
||||
# [Optional] Uncomment this line to install global node packages.
|
||||
# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g <your-package-here>" 2>&1
|
35
.devcontainer/devcontainer.json
Normal file
35
.devcontainer/devcontainer.json
Normal file
@@ -0,0 +1,35 @@
|
||||
// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
|
||||
// https://github.com/microsoft/vscode-dev-containers/tree/v0.224.2/containers/jekyll
|
||||
{
|
||||
"name": "Just the docs",
|
||||
"build": {
|
||||
"dockerfile": "Dockerfile",
|
||||
"args": {
|
||||
// Update 'VARIANT' to pick a Debian OS version: bullseye, buster
|
||||
// Use bullseye when on local arm64/Apple Silicon.
|
||||
"VARIANT": "bullseye",
|
||||
// Enable Node.js: pick the latest LTS version
|
||||
"NODE_VERSION": "lts/*"
|
||||
}
|
||||
},
|
||||
|
||||
// Set *default* container specific settings.json values on container create.
|
||||
"settings": {},
|
||||
|
||||
// Add the IDs of extensions you want installed when the container is created.
|
||||
"extensions": ["GitHub.vscode-pull-request-github"],
|
||||
|
||||
// Use 'forwardPorts' to make a list of ports inside the container available locally.
|
||||
"forwardPorts": [
|
||||
// Jekyll server
|
||||
4000,
|
||||
// Live reload server
|
||||
35729
|
||||
],
|
||||
|
||||
// Use 'postCreateCommand' to run commands after the container is created.
|
||||
"postCreateCommand": "sh .devcontainer/post-create.sh",
|
||||
|
||||
// Comment out to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
|
||||
"remoteUser": "vscode"
|
||||
}
|
12
.devcontainer/post-create.sh
Normal file
12
.devcontainer/post-create.sh
Normal file
@@ -0,0 +1,12 @@
|
||||
#!/bin/sh
|
||||
|
||||
# Install the version of Bundler.
|
||||
if [ -f Gemfile.lock ] && grep "BUNDLED WITH" Gemfile.lock > /dev/null; then
|
||||
cat Gemfile.lock | tail -n 2 | grep -C2 "BUNDLED WITH" | tail -n 1 | xargs gem install bundler -v
|
||||
fi
|
||||
|
||||
# If there's a Gemfile, then run `bundle install`
|
||||
# It's assumed that the Gemfile will install Jekyll too
|
||||
if [ -f Gemfile ]; then
|
||||
bundle install
|
||||
fi
|
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
|
||||
|
14
.github/dependabot.yml
vendored
Normal file
14
.github/dependabot.yml
vendored
Normal file
@@ -0,0 +1,14 @@
|
||||
version: 2
|
||||
updates:
|
||||
- package-ecosystem: npm
|
||||
directory: "/"
|
||||
schedule:
|
||||
interval: daily
|
||||
time: "10:00"
|
||||
open-pull-requests-limit: 10
|
||||
- package-ecosystem: bundler
|
||||
directory: "/"
|
||||
schedule:
|
||||
interval: daily
|
||||
time: "10:00"
|
||||
open-pull-requests-limit: 10
|
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
|
||||
|
45
.github/workflows/ci-master.yml
vendored
45
.github/workflows/ci-master.yml
vendored
@@ -1,45 +0,0 @@
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- master
|
||||
|
||||
name: Master branch CI
|
||||
|
||||
jobs:
|
||||
|
||||
jekyll-latest:
|
||||
name: Build Jekyll site (latest)
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
|
||||
- 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"
|
||||
jekyll-3-8-5:
|
||||
name: Build Jekyll site (v3.8.5)
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
|
||||
- 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"
|
||||
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
|
48
.github/workflows/ci.yml
vendored
48
.github/workflows/ci.yml
vendored
@@ -1,44 +1,42 @@
|
||||
on: [pull_request]
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
pull_request:
|
||||
branches:
|
||||
- main
|
||||
- 'v**'
|
||||
|
||||
name: CI
|
||||
|
||||
jobs:
|
||||
|
||||
jekyll-latest:
|
||||
name: Build Jekyll site (latest)
|
||||
jekyll-build:
|
||||
name: Build Jekyll site
|
||||
runs-on: ubuntu-latest
|
||||
strategy:
|
||||
matrix:
|
||||
jekyll-version: [3.8.5, latest]
|
||||
steps:
|
||||
|
||||
- uses: actions/checkout@v2
|
||||
|
||||
- name: Build the site in the jekyll/builder container
|
||||
- uses: actions/checkout@v3
|
||||
- name: Build the site in the jekyll/jekyll 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@v2
|
||||
|
||||
- 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"
|
||||
jekyll/jekyll:${{ matrix.jekyll-version }} /bin/bash -c "gem install bundler && chmod -R 777 /srv/jekyll && bundle install && bundle exec jekyll build && bundle exec rake search:init"
|
||||
|
||||
assets:
|
||||
name: Test CSS and JS
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
strategy:
|
||||
matrix:
|
||||
node-version: [16.x]
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- name: Use Node.js 12.x
|
||||
- uses: actions/checkout@v3
|
||||
- name: Use Node.js ${{ matrix.node-version }}
|
||||
uses: actions/setup-node@v1
|
||||
with:
|
||||
node-version: '12.x'
|
||||
node-version: ${{ matrix.node-version }}
|
||||
- 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"
|
||||
}
|
||||
|
||||
}
|
@@ -5,9 +5,17 @@
|
||||
"assets/css/just-the-docs-dark.scss",
|
||||
"_sass/vendor/**/*.scss"
|
||||
],
|
||||
"extends": ["stylelint-config-primer", "stylelint-config-prettier"],
|
||||
"extends": [
|
||||
"stylelint-config-standard-scss",
|
||||
"stylelint-config-prettier-scss"
|
||||
],
|
||||
"plugins": ["stylelint-prettier"],
|
||||
"rules": {
|
||||
"prettier/prettier": true
|
||||
"prettier/prettier": true,
|
||||
"alpha-value-notation": null,
|
||||
"color-function-notation": null,
|
||||
"declaration-block-no-redundant-longhand-properties": null,
|
||||
"no-descending-specificity": null,
|
||||
"scss/no-global-function-names": null
|
||||
}
|
||||
}
|
||||
|
26
.vscode/tasks.json
vendored
Normal file
26
.vscode/tasks.json
vendored
Normal file
@@ -0,0 +1,26 @@
|
||||
{
|
||||
// See https://go.microsoft.com/fwlink/?LinkId=733558
|
||||
// for the documentation about the tasks.json format
|
||||
"version": "2.0.0",
|
||||
"tasks": [
|
||||
{
|
||||
"label": "Serve",
|
||||
"type": "shell",
|
||||
"command": "bundle exec jekyll serve --livereload",
|
||||
"group": {
|
||||
"kind": "test",
|
||||
"isDefault": true
|
||||
},
|
||||
"isBackground": true
|
||||
},
|
||||
{
|
||||
"label": "Build",
|
||||
"type": "shell",
|
||||
"command": "bundle exec jekyll build",
|
||||
"group": {
|
||||
"kind": "build",
|
||||
"isDefault": true
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
2
404.html
2
404.html
@@ -8,4 +8,4 @@ search_exclude: true
|
||||
|
||||
<h1>Page not found</h1>
|
||||
|
||||
<p>The page you requested could not be found. Try using the navigation {% if site.search_enabled != false %}or search {% endif %}to find what you're looking for or go to this <a href="{{ '/' | absolute_url }}">site's home page</a>.</p>
|
||||
<p>The page you requested could not be found. Try using the navigation {% if site.search_enabled != false %}or search {% endif %}to find what you're looking for or go to this <a href="{{ '/' | relative_url }}">site's home page</a>.</p>
|
||||
|
484
CHANGELOG.md
Normal file
484
CHANGELOG.md
Normal file
@@ -0,0 +1,484 @@
|
||||
# Changelog
|
||||
|
||||
All notable changes to this project are documented in this file.
|
||||
|
||||
*Note:* the project underwent a maintenance shift in the creation of v0.4.0.
|
||||
|
||||
## v0.4.0.rc1
|
||||
|
||||
### We're back!
|
||||
|
||||
Hi all! The Just the Docs team is excited to have our first release in over two years! This release is jam-packed with features and bugfixes that have been requested by the community since 2020. They include:
|
||||
|
||||
- The new callouts component
|
||||
- Allowing pages and collections to coexist on the navigation pane
|
||||
- New styling: dark syntax highlighting, support for jekyll-asciidoc, word-wrapping instead of overflow for various elements
|
||||
- More customization: external nav links, custom nav footers, favicon includes, search color and placeholder configuration, mermaid.js support, and nav sorting
|
||||
- Over 20 bugfixes! Big ones include fixing the `rake` command, using `relative_url`, and search input color
|
||||
- More documentation, especially on using custom includes.
|
||||
- Updating core dependencies to stable Ruby versions
|
||||
- A WIP [template repository](https://github.com/just-the-docs/just-the-docs-template) that allows you to setup your own repository using Just the Docs and GitHub Pages with one click - give it a shot! More documentation, etc. is on the way!
|
||||
|
||||
We want your feedback! Are these changes helpful? Are our docs easy to understand? Should new features like `mermaid` be opt-in or opt-out? Please [open an issue](https://github.com/just-the-docs/just-the-docs/issues) or [start a discussion](https://github.com/just-the-docs/just-the-docs/discussions) and let us know!
|
||||
|
||||
### Trying out `v0.4.0.rc1`
|
||||
|
||||
Due to the massive scope of these changes, we're releasing `v0.4.0.rc1` as a **release candidate** for the theme, with `v0.4.0` coming soon. We want your help in testing the theme! As of now, the gem on RubyGems and the repository are updated to `v0.4.0.rc1` - if your version of Just the Docs is not pinned, you'll see the changes the next time you build / run `bundle install` (if you don't use a `Gemfile.lock`) or `bundle update just-the-docs` (if you do).
|
||||
|
||||
To use this RC explicitly as a remote theme:
|
||||
|
||||
```yml
|
||||
remote_theme: just-the-docs/just-the-docs@v0.4.0.rc1
|
||||
```
|
||||
|
||||
To use this RC explicitly as a gem-based theme, pin the version in your `Gemfile` and re-run `bundle install`:
|
||||
|
||||
```Ruby
|
||||
gem "just-the-docs", "0.4.0.rc1"
|
||||
```
|
||||
|
||||
### Staying on `v0.3.3`
|
||||
|
||||
If you're not ready to make the switch, that's alright! If your version of just-the-docs is pinned to `v0.3.3` (i.e. by a `Gemfile.lock` or in `remote_theme`, then there's nothing you need to do.
|
||||
|
||||
If you have not pinned your theme version, you should either:
|
||||
|
||||
1. pin your gem version in your `Gemfile`, like so
|
||||
```Ruby
|
||||
gem "just-the-docs", "0.3.3"
|
||||
```
|
||||
2. freeze the `remote_theme`, like so
|
||||
```yml
|
||||
remote_theme: just-the-docs/just-the-docs@v0.3.3
|
||||
```
|
||||
|
||||
**Warning**: Use of branches for closed PRs (e.g., https://github.com/just-the-docs/just-the-docs/pull/466, https://github.com/just-the-docs/just-the-docs/pull/578) is now deprecated, as those branches have been (directly or indirectly) merged, and they will be deleted after the release of `v0.4.0.rc1`.
|
||||
|
||||
### Maintenance
|
||||
|
||||
Internally, our maintainer team has expanded: [Patrick Marsceill](https://github.com/pmarsceill), the original maintainer, has stepped down from an active role after almost 4 years! We're very thankful for the work that he's done to create and maintain one of the most popular Jekyll themes. Please join us in giving him thanks!
|
||||
|
||||
The new core team currently consists of @mattxwang, @pdmosses, @skullface, @dougaitken, and @max06. Over the past six months, we've been triaging and merging in PRs, as well as contributing our own fixes. We'll continue to address open issues, merge in PRs from the community, and plan out the future of Just the Docs. If you'd like to contribute, now is a great time!
|
||||
|
||||
### Roadmap
|
||||
|
||||
In the short-term, we're committed to tidying up everything for a `v0.4.0` release. This involves fixing bugs reported from the community in this release, as well as continually merging in minor PRs.
|
||||
|
||||
We're also scoping out medium and long-term projects, and want to keep you in the loop. These include:
|
||||
|
||||
- upgrading to Jekyll 4, and stopping support for Jekyll 3
|
||||
- improved accessibility - issues [#566](https://github.com/just-the-docs/just-the-docs/issues/566), [#870](https://github.com/just-the-docs/just-the-docs/issues/870)
|
||||
- internationalization (i18n) - issue [#59](https://github.com/just-the-docs/just-the-docs/issues/59)
|
||||
- recursive/multi-level navigation - PR [#462](https://github.com/just-the-docs/just-the-docs/pull/462)
|
||||
- toggleable dark mode - issue [#234](https://github.com/just-the-docs/just-the-docs/issues/234)
|
||||
|
||||
as well as DX improvements like better regression tests, CI, and tooling. If you're interested in any of these, please join us [on GitHub](https://github.com/just-the-docs/just-the-docs) - any contribution (raising an issue, writing docs, or submitting a PR) is welcome!
|
||||
|
||||
### Features
|
||||
|
||||
* Added: Combination by @pdmosses in https://github.com/just-the-docs/just-the-docs/pull/578
|
||||
- Added: dark highlighting in https://github.com/just-the-docs/just-the-docs/pull/463
|
||||
- Added: pages and collections in https://github.com/just-the-docs/just-the-docs/pull/448
|
||||
- Added: callouts in https://github.com/just-the-docs/just-the-docs/pull/466
|
||||
- Fixed: breadcrumb behaviour … by @AdityaTiwari2102 in https://github.com/just-the-docs/just-the-docs/pull/477
|
||||
- Fixed: prevent rake command corrupting search data in https://github.com/just-the-docs/just-the-docs/pull/495 (also listed below)
|
||||
- Fixed: nested lists in https://github.com/just-the-docs/just-the-docs/pull/496
|
||||
- Fixed: set color for search input in https://github.com/just-the-docs/just-the-docs/pull/498 (also listed below)
|
||||
- Fixed: sites with no child pages (no PR)
|
||||
- Fixed: TOC/breadcrumbs for multiple collections in https://github.com/just-the-docs/just-the-docs/pull/494
|
||||
- Added: collection configuration option `nav_fold` (no PR)
|
||||
- Fixed: indentation and color for folded collection navigation (no PR)
|
||||
- Fixed: scroll navigation to show the link to the current page in https://github.com/just-the-docs/just-the-docs/pull/639
|
||||
- Fixed: Replace all uses of `absolute_url` by `relative_url`, by @svrooij in https://github.com/just-the-docs/just-the-docs/pull/544
|
||||
* Added: custom favicon `_includes` by @burner1024 in https://github.com/just-the-docs/just-the-docs/pull/364
|
||||
* Added: set color for search input by @pdmosses in https://github.com/just-the-docs/just-the-docs/pull/498
|
||||
* Added: search placeholder configuration by @mattxwang in https://github.com/just-the-docs/just-the-docs/pull/613
|
||||
* Added: 'child_nav_order' front matter to be able to sort navigation pages in reverse by @jmertic in https://github.com/just-the-docs/just-the-docs/pull/726
|
||||
* Added: `nav_footer_custom` include by @nathanjessen in https://github.com/just-the-docs/just-the-docs/pull/474
|
||||
* Added: style fixes for jekyll-asciidoc by @alyssais in https://github.com/just-the-docs/just-the-docs/pull/829
|
||||
* Added: mermaid.js support by @nascosto in https://github.com/just-the-docs/just-the-docs/pull/857
|
||||
* Added: support for external navigation links by @SPGoding in https://github.com/just-the-docs/just-the-docs/pull/876
|
||||
* Added: refactor `mermaid` config to use `mermaid_config.js` include, only require `mermaid.version` in `_config.yml` by @mattxwang in https://github.com/just-the-docs/just-the-docs/pull/909
|
||||
* Fixed: prepend `site.collections_dir` if exists by @alexsegura in https://github.com/just-the-docs/just-the-docs/pull/519
|
||||
* Fixed: nested task lists (#517) by @pdmosses in https://github.com/just-the-docs/just-the-docs/pull/855
|
||||
* Fixed: suppress Liquid processing in CSS comments by @pdmosses in https://github.com/just-the-docs/just-the-docs/pull/686
|
||||
* Fixed: prevent rake command from corrupting search data by @pdmosses in https://github.com/just-the-docs/just-the-docs/pull/495
|
||||
* Fixed: anchor heading links should be visible on focus by @jacobhq in https://github.com/just-the-docs/just-the-docs/pull/846
|
||||
* Fixed: add `overflow-x: auto` to `figure.highlight` by @iridazzle in https://github.com/just-the-docs/just-the-docs/pull/727
|
||||
* Fixed: add `overflow-wrap: word-break` to `body` by @iridazzle in https://github.com/just-the-docs/just-the-docs/pull/889
|
||||
* Fixed: vertical alignment for consecutive labels by @Eisverygoodletter in https://github.com/just-the-docs/just-the-docs/pull/893
|
||||
* Fixed: allow links to wrap by @pdmosses in https://github.com/just-the-docs/just-the-docs/pull/905
|
||||
* Fixed: nav scroll feature and absolute/relative URLs by @pdmosses in https://github.com/just-the-docs/just-the-docs/pull/898
|
||||
|
||||
### Documentation
|
||||
|
||||
* Added: docs on how to break an `ol` by @pdmosses in https://github.com/just-the-docs/just-the-docs/pull/856
|
||||
* Added: docs for custom includes by @nathanjessen in https://github.com/just-the-docs/just-the-docs/pull/806
|
||||
* Added: document caveat about variable dependencies by @waldyrious in https://github.com/just-the-docs/just-the-docs/pull/555
|
||||
* Added: docs on how to use `custom_head` to add a custom favicon by @UnclassedPenguin in https://github.com/just-the-docs/just-the-docs/pull/814
|
||||
* Fixed: `ol` on `index.md` by @pmarsceill in https://github.com/just-the-docs/just-the-docs/pull/778
|
||||
* Fixed: image link in Markdown kitchen sink by @JeffGuKang in https://github.com/just-the-docs/just-the-docs/pull/221
|
||||
* Fixed: images in Markdown kitchen sink by @dougaitken in https://github.com/just-the-docs/just-the-docs/pull/782
|
||||
* Fixed: clearer label of link to Jekyll quickstart by @waldyrious in https://github.com/just-the-docs/just-the-docs/pull/549
|
||||
* Fixed: remove extra spaces in component docs by @MichelleBlanchette in https://github.com/just-the-docs/just-the-docs/pull/554
|
||||
* Fixed: double "your" typo in `index.md` by @sehilyi in https://github.com/just-the-docs/just-the-docs/pull/499
|
||||
* Fixed: "you" -> "your" typo in `index.md` by @nathanjessen in https://github.com/just-the-docs/just-the-docs/pull/473
|
||||
* Fixed: spacing in toc example by @henryiii in https://github.com/just-the-docs/just-the-docs/pull/835
|
||||
* Fixed: typo in `README` on `_config.yml` by @ivanskodje in https://github.com/just-the-docs/just-the-docs/pull/891
|
||||
* Fixed: missing code fence in navigation structure docs by @mattxwang in https://github.com/just-the-docs/just-the-docs/pull/906
|
||||
|
||||
### Maintenance
|
||||
|
||||
* Added: VScode devcontainer by @max06 in https://github.com/just-the-docs/just-the-docs/pull/783
|
||||
* Added: `webrick` to `Gemfile` by @mattxwang in https://github.com/just-the-docs/just-the-docs/pull/799
|
||||
* Added: 'This site is powered by Netlify.' to the footer by @mattxwang in https://github.com/just-the-docs/just-the-docs/pull/797
|
||||
* Updated: new repo path by @pmarsceill in https://github.com/just-the-docs/just-the-docs/pull/775
|
||||
* Updated: rename `master` -> `main` by @pmarsceill in https://github.com/just-the-docs/just-the-docs/pull/776
|
||||
* Updated: README by @pmarsceill in https://github.com/just-the-docs/just-the-docs/pull/777
|
||||
* Updated: Code of Conduct to Contributor Covenant v2.1 by @mattxwang in https://github.com/just-the-docs/just-the-docs/pull/790
|
||||
* Updated: CI files, Ruby & Node Versions by @mattxwang in https://github.com/just-the-docs/just-the-docs/pull/820
|
||||
* Updated: Stylelint to v14, extend SCSS plugins, remove primer-* configs, resolve issues by @mattxwang in https://github.com/just-the-docs/just-the-docs/pull/821
|
||||
|
||||
### Dependencies
|
||||
* Upgrade to GitHub-native Dependabot by @dependabot-preview in https://github.com/just-the-docs/just-the-docs/pull/627
|
||||
* [Security] Bump y18n from 3.2.1 to 3.2.2 by @dependabot-preview in https://github.com/just-the-docs/just-the-docs/pull/606
|
||||
* [Security] Bump hosted-git-info from 2.7.1 to 2.8.9 by @dependabot-preview in https://github.com/just-the-docs/just-the-docs/pull/641
|
||||
* [Security] Bump lodash from 4.17.19 to 4.17.21 by @dependabot-preview in https://github.com/just-the-docs/just-the-docs/pull/640
|
||||
* [Security] Bump ini from 1.3.5 to 1.3.8 by @dependabot-preview in https://github.com/just-the-docs/just-the-docs/pull/511
|
||||
* Bump path-parse from 1.0.6 to 1.0.7 by @dependabot in https://github.com/just-the-docs/just-the-docs/pull/699
|
||||
* Bump ajv from 6.10.0 to 6.12.6 by @dependabot in https://github.com/just-the-docs/just-the-docs/pull/766
|
||||
* Bump prettier from 2.1.2 to 2.5.1 by @dependabot in https://github.com/just-the-docs/just-the-docs/pull/787
|
||||
* Bump prettier from 2.5.1 to 2.6.2 by @dependabot in https://github.com/just-the-docs/just-the-docs/pull/809
|
||||
* Bump prettier from 2.6.2 to 2.7.1 by @dependabot in https://github.com/just-the-docs/just-the-docs/pull/864
|
||||
|
||||
### New Contributors
|
||||
* @alexsegura made their first contribution in https://github.com/just-the-docs/just-the-docs/pull/519
|
||||
* @burner1024 made their first contribution in https://github.com/just-the-docs/just-the-docs/pull/364
|
||||
* @JeffGuKang made their first contribution in https://github.com/just-the-docs/just-the-docs/pull/221
|
||||
* @dougaitken made their first contribution in https://github.com/just-the-docs/just-the-docs/pull/782
|
||||
* @max06 made their first contribution in https://github.com/just-the-docs/just-the-docs/pull/783
|
||||
* @sehilyi made their first contribution in https://github.com/just-the-docs/just-the-docs/pull/499
|
||||
* @nathanjessen made their first contribution in https://github.com/just-the-docs/just-the-docs/pull/473
|
||||
* @waldyrious made their first contribution in https://github.com/just-the-docs/just-the-docs/pull/549
|
||||
* @MichelleBlanchette made their first contribution in https://github.com/just-the-docs/just-the-docs/pull/554
|
||||
* @henryiii made their first contribution in https://github.com/just-the-docs/just-the-docs/pull/835
|
||||
* @jmertic made their first contribution in https://github.com/just-the-docs/just-the-docs/pull/726
|
||||
* @jacobhq made their first contribution in https://github.com/just-the-docs/just-the-docs/pull/846
|
||||
* @UnclassedPenguin made their first contribution in https://github.com/just-the-docs/just-the-docs/pull/814
|
||||
* @alyssais made their first contribution in https://github.com/just-the-docs/just-the-docs/pull/829
|
||||
* @nascosto made their first contribution in https://github.com/just-the-docs/just-the-docs/pull/857
|
||||
* @SPGoding made their first contribution in https://github.com/just-the-docs/just-the-docs/pull/876
|
||||
* @iridazzle made their first contribution in https://github.com/just-the-docs/just-the-docs/pull/727
|
||||
* @ivanskodje made their first contribution in https://github.com/just-the-docs/just-the-docs/pull/891
|
||||
* @Eisverygoodletter made their first contribution in https://github.com/just-the-docs/just-the-docs/pull/893
|
||||
|
||||
**Full Changelog**: https://github.com/just-the-docs/just-the-docs/compare/v0.3.3...v0.4.0.rc1
|
||||
|
||||
## v0.3.3
|
||||
|
||||
### 🚀 Features
|
||||
|
||||
- Add custom header and footer include files @CodeSandwich (#334)
|
||||
|
||||
### 🐛 Bug Fixes
|
||||
|
||||
- Limit the effect of `nav_exclude` to the main navigation @pdmosses (#443)
|
||||
- Update normalize.scss @pdmosses (#444)
|
||||
- Update code.scss @pdmosses (#445)
|
||||
- Fix list alignment @pdmosses (#446)
|
||||
|
||||
### 🧰 Maintenance
|
||||
|
||||
- Bump stylelint-config-primer from 9.0.0 to 9.2.1 @dependabot-preview (#451)
|
||||
- Bump stylelint from 13.6.1 to 13.7.2 @dependabot-preview (#440)
|
||||
- Bump @primer/css from 15.1.0 to 15.2.0 @dependabot-preview (#436)
|
||||
- Bump prettier from 2.1.1 to 2.1.2 @dependabot-preview (#429)
|
||||
|
||||
## v0.3.2
|
||||
|
||||
### Changes
|
||||
|
||||
- Safe page sorting @pdmosses (#411)
|
||||
- v0.3.2 @pmarsceill (#388)
|
||||
|
||||
### 🚀 Features
|
||||
|
||||
- make font-sizes sass variables so they can be changed @pdebruic (#361)
|
||||
- run the site locally inside docker container @fogfish (#398)
|
||||
- Feature/doc collections @SgtSilvio (#379)
|
||||
- Adjust dl layout @pdmosses (#401)
|
||||
|
||||
### 🐛 Bug Fixes
|
||||
|
||||
- Add site.gh_edit_source to "Edit this page on GitHub" link @mrfleap (#418)
|
||||
- Inhibit text-transform for code in h4 @pdmosses (#404)
|
||||
- Fix native font stack precedence issue on Windows systems. @hvianna (#331)
|
||||
- Support for the linenos option on highlighted code @pdmosses (#375)
|
||||
- Update anchor_headings.html @pdmosses (#399)
|
||||
- Fix https @marksie1988 (#359)
|
||||
|
||||
### 🧰 Maintenance
|
||||
|
||||
- Bump prettier from 2.0.5 to 2.1.1 @dependabot-preview (#427)
|
||||
- Bump prettier from 2.0.5 to 2.1.1 @dependabot-preview (#419)
|
||||
- [Security] Bump lodash from 4.17.15 to 4.17.19 @dependabot-preview (#389)
|
||||
- Bump @primer/css from 14.4.0 to 15.1.0 @dependabot-preview (#402)
|
||||
- Bump lodash from 4.17.15 to 4.17.19 @dependabot (#384)
|
||||
- Bump @primer/css from 14.4.0 to 15.0.0 @dependabot-preview (#371)
|
||||
|
||||
|
||||
## v0.3.1
|
||||
|
||||
### Changes
|
||||
|
||||
### 🐛 Bug Fixes
|
||||
|
||||
- Improve accessibility by adding label to Anchor links. @mscoutermarsh (#376)
|
||||
|
||||
### 🧰 Maintenance
|
||||
|
||||
- Remove collapsible TOC on nav doc @pmarsceill (#368)
|
||||
- Pdmosses collapsible toc @pmarsceill (#367)
|
||||
|
||||
|
||||
## v0.3.0
|
||||
|
||||
### Changes
|
||||
|
||||
- v0.2.9 @pmarsceill (#306)
|
||||
|
||||
### 🚀 Features
|
||||
|
||||
- Add print styles @pmarsceill (#362)
|
||||
- Navigation improvements and search sections @SgtSilvio (#352)
|
||||
|
||||
### 🐛 Bug Fixes
|
||||
|
||||
- Remove constraint with jekyll 4.1.0 @PierrickMartos (#348)
|
||||
|
||||
### 🧰 Maintenance
|
||||
|
||||
- Bump version numbers @pmarsceill (#360)
|
||||
- Bump stylelint from 13.3.3 to 13.6.1 @dependabot-preview (#343)
|
||||
- Bump stylelint-config-prettier from 8.0.1 to 8.0.2 @dependabot-preview (#349)
|
||||
|
||||
|
||||
## v0.2.9
|
||||
|
||||
### Bug fixes
|
||||
- Horizontal Alignment #103 @pmarsceill
|
||||
- Code snippet in headers do not inherit font size #140 @pmarsceill
|
||||
- Fix duplicated title and description tags #294 @iefserge
|
||||
- Update nav.html for handling nav_exclude #282 @blawqchain
|
||||
- Fix duplicate entries in nav.html and default.html #239 @KasparEtter
|
||||
- Don't show pages with no title (e.g. redirects in nav) https://github.com/pmarsceill/just-the-docs/pull/295/commits/672de29f2e332a9350af7237e4fb6693c848989e @SgtSilvio
|
||||
- [SEARCH RAKE] Fix search generator #319 @RoiArthurB
|
||||
|
||||
### Enhancements
|
||||
- Improvement/custom themes #186 @SgtSilvio
|
||||
- feat: adds "edit this page" and "page last modified" to footer #217 @malsf21
|
||||
- feat: adds option to open aux links in new tab #229 @malsf21
|
||||
- Default nav order #236 @pdmosses
|
||||
- Enable IP anonymization in Google Analytics (GDPR) #250 @r-brown
|
||||
|
||||
closes #240 #308 #266 #140 #103
|
||||
|
||||
## v0.2.8
|
||||
|
||||
### Bugfixes
|
||||
- bugfix in search.rake #218 @tiaitsch85
|
||||
|
||||
### Dependency and security updates:
|
||||
|
||||
- Update jekyll requirement from ~> 3.8.5 to >= 3.8.5, < 4.1.0 #197 @dependabot-preview
|
||||
- Update rake requirement from ~> 12.3.1 to >= 12.3.1, < 13.1.0 #227 @dependabot-preview
|
||||
- Bump stylelint-config-primer from 8.0.0 to 9.0.0 #247 @dependabot-preview
|
||||
- Update bundler requirement from ~> 2.0.1 to ~> 2.1.4 #268 @dependabot-preview
|
||||
- Bump @primer/css from 12.7.0 to 14.3.0 #296 @dependabot-preview
|
||||
|
||||
### Operations
|
||||
|
||||
- Update CI to test multiple versions of Jekyll
|
||||
- Update CI to check the rake command that builds the search file
|
||||
|
||||
fixes #291 #256 #293 #177
|
||||
|
||||
## v0.2.7
|
||||
|
||||
### Bugs fixed
|
||||
- Anchor headings are now displayed on hover, not only on heading hover
|
||||
- Deduplicated anchor heading svg
|
||||
- If last page of `site.html_pages` was excluded from search, search json breaks
|
||||
- Config variable should be `blanklines` not `blank_lines` for html compression
|
||||
- `list-style-none` does not hide bullets on `ul`
|
||||
|
||||
### Enhancements
|
||||
- Summary for child pages appears in generated TOC
|
||||
- Site logo configuration supported replacing title text with image
|
||||
- Allow custom CSS overrides (new scss partial at the end of the cascade) separate from variable overrides.
|
||||
- Configuration around search strings added to allow search for hyphenated words
|
||||
|
||||
### Maintenance
|
||||
- Update docs to suggest using index.md as section page filename
|
||||
- Bump @primer/css from 12.6.0 to 12.7.0
|
||||
- Bump mixin-deep from 1.3.1 to 1.3.2
|
||||
- Bump stylelint-config-primer from 7.0.1 to 8.0.0
|
||||
|
||||
### PR included
|
||||
- #98 by @stefanoborini Introduces the possibility for a summary in the table of contents
|
||||
- #141 by @ghabs Fix trailing comma bug in search-data.json
|
||||
- #153 by @jacobherrington Change button copy on theme preview
|
||||
- #181 by @m3nu Recommend using index.md as parent page for sections
|
||||
- #183 by @SgtSilvio Improve heading anchors
|
||||
- #187 by @SgtSilvio Improvement/site logo
|
||||
- #200 Bump mixin-deep from 1.3.1 to 1.3.2
|
||||
- #203 by @pdmosses Search config
|
||||
- #205 by @pdmosses Fix blank_lines var to blanklines in config.yml
|
||||
- #206 by @iamcarrico Allow for custom overrides by the user
|
||||
- #208 Bump @primer/css from 12.6.0 to 12.7.0
|
||||
- #213 Bump mixin-deep from 1.3.1 to 1.3.2
|
||||
- #214 Bump stylelint-config-primer from 7.0.1 to 8.0.0
|
||||
- #215 Bump @primer/css from 12.6.0 to 12.7.0
|
||||
|
||||
## v0.2.6
|
||||
|
||||
### Bugs fixed
|
||||
- Google Analytics tag has been updated #162
|
||||
- ~BaseURL has been modified #109~ Reverted -- seems the existing implementation worked
|
||||
- Titles can now wrap fixes #106
|
||||
|
||||
### Enhancements
|
||||
- Search now displays content preview #135
|
||||
- Custom footer content added #179
|
||||
- Now using GitHub Actions for CI #170
|
||||
|
||||
### Maintenance
|
||||
- lunrjs upgraded #135
|
||||
- Nav generation is optimized #159
|
||||
- Stylelint upgrade #143
|
||||
- Stylelint config primer upgrade #149
|
||||
- Lodash upgrade #160
|
||||
|
||||
### PR included
|
||||
~#109 by @daviddarnes - Fix baseurl link~ Reverted
|
||||
#135 by @SgtSilvio - Upgrades lunr.js, improves search UI, adds heading anchors
|
||||
#152 by @yavorg - Improves syntax highlighting for js readablity
|
||||
#159 by @julienduchesne - Optimizes nav generation
|
||||
#162 by @nergmada - Modifies the google analytics code to match the new tags used by GA
|
||||
|
||||
|
||||
## v0.2.5
|
||||
|
||||
### Bugs fixed
|
||||
|
||||
- Duplicate title tag when Jekyll SEO Plugin gem is used #125 #126
|
||||
|
||||
### Enhancements
|
||||
|
||||
- Favicon support added #118
|
||||
|
||||
### Maintenance
|
||||
- Bump stylelint-config-primer from 6.0.0 to 7.0.0 #123
|
||||
- Bump @primer/css from 12.2.3 to 12.3.1 #129
|
||||
- Add workflow to publish to GPR
|
||||
- Fix workflow to publish to Ruby Gems
|
||||
|
||||
## v0.2.4
|
||||
|
||||
### Bugs
|
||||
|
||||
- #102 Remove unnecessary console.log() @JoeNyland
|
||||
- #97 Import custom Sass variable overrides before default variables are defined @montchr and @ptvandi
|
||||
|
||||
### Additions
|
||||
- #117 Add links to docs for setting up GH pages locally @gnarea
|
||||
- #95 Add SEO and 'lang' param for `_config` @gebeto
|
||||
|
||||
## v0.2.3
|
||||
|
||||
### Enhancements
|
||||
- Adds ability to use Google Analytics tracking by @pmarsceill
|
||||
|
||||
### Bug fixes
|
||||
- Fixes 404 error for "/assets/js//search-data.json" by @stephenedmondson
|
||||
- Fixes #80 Single quotes in the string were unescaped and ruby attempted variable substitution of amp within it (which failed) by @novelistparty
|
||||
- Fixes bug that would only show 2 or more search results (not one) by @ilivewithian
|
||||
- Fixes a typo on the layout example by @woernfl
|
||||
- Fixes #78 Page scroll position too far down on load by @pmarsceill
|
||||
- Fixds ability to nest ul in ol without breaking style or counters
|
||||
|
||||
### Dependency updates
|
||||
- Bumps stylelint dependency from 9.9.0 to 9.10.1
|
||||
|
||||
## v0.2.2
|
||||
|
||||
- Bumps stylelint-config-primer to 3.0.1 #44
|
||||
- Bumps bundler req to 2.0.1 #61
|
||||
- Adds custom 404 page
|
||||
- Excludes package-lock.json from jekyll build #47
|
||||
- Fixes keyboard scrolling / focus #48
|
||||
- Adds ARIA roles to navigation elements
|
||||
- Adds support for optional page description metadata (if present in yaml front matter)
|
||||
- Addresses some issues with search in #46
|
||||
- Option to hide TOC on parent pages if turned off in page's YAML front matter #30
|
||||
- Option to suppress an item from being indexed by search if present in page's YAML front matter #32
|
||||
|
||||
## v0.2.1
|
||||
|
||||
This update fixes security vulnerablities in the lodash sub-dependency and bumps other dev dependencies to their latest version.
|
||||
|
||||
## v0.2.0
|
||||
|
||||
Adds:
|
||||
- Dark mode via `color_scheme` parameter
|
||||
- Ability to exclude a page from the main nav with `nav_exclude` parameter closes #21
|
||||
- Ability for create children of children pages (3 nav levels) closes #25
|
||||
|
||||
Changes:
|
||||
- Permalink structure for tiered navigation has been updated
|
||||
- Some colors have been updated for consistency / accessibility
|
||||
|
||||
## v0.1.6
|
||||
|
||||
### Added
|
||||
|
||||
- Support for task list styles #19
|
||||
- Configuration docs
|
||||
- Configuration option to enable / disable search
|
||||
- Normalize.scss dependency pulled into project #16 #
|
||||
|
||||
### Fixed
|
||||
|
||||
- Layout bug in navigation #17
|
||||
|
||||
## v0.1.5
|
||||
|
||||
Major changes:
|
||||
|
||||
- Fixed bug where the rake task would fail when the assets/js directory didn't exist
|
||||
|
||||
## v0.1.4
|
||||
|
||||
Major changes:
|
||||
- Adds Rake as a runtime dependency
|
||||
- Definition list styled
|
||||
- Sidebar and support cleaned up for smaller screen support
|
||||
- Updated some stale docs
|
||||
|
||||
## v0.1.3
|
||||
|
||||
Major changes:
|
||||
- Fix path problems, typos, and general clean-up for OSS.
|
||||
|
||||
## v0.1.2
|
||||
|
||||
Fix paths when deployed to gh-pages
|
||||
|
||||
## v0.1.1
|
||||
|
||||
Major updates:
|
||||
- Adds search to mobile nav
|
||||
- Pulls footer to bottom of the page on mobile (not hidden in nav)
|
||||
|
||||
Minor updates:
|
||||
- Cleans up h1 typography spacing
|
@@ -2,45 +2,131 @@
|
||||
|
||||
## Our Pledge
|
||||
|
||||
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
|
||||
We as members, contributors, and leaders pledge to make participation in our
|
||||
community a harassment-free experience for everyone, regardless of age, body
|
||||
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
||||
identity and expression, level of experience, education, socio-economic status,
|
||||
nationality, personal appearance, race, caste, color, religion, or sexual
|
||||
identity and orientation.
|
||||
|
||||
We pledge to act and interact in ways that contribute to an open, welcoming,
|
||||
diverse, inclusive, and healthy community.
|
||||
|
||||
## Our Standards
|
||||
|
||||
Examples of behavior that contributes to creating a positive environment include:
|
||||
Examples of behavior that contributes to a positive environment for our
|
||||
community include:
|
||||
|
||||
* Using welcoming and inclusive language
|
||||
* Being respectful of differing viewpoints and experiences
|
||||
* Gracefully accepting constructive criticism
|
||||
* Focusing on what is best for the community
|
||||
* Showing empathy towards other community members
|
||||
* Demonstrating empathy and kindness toward other people
|
||||
* Being respectful of differing opinions, viewpoints, and experiences
|
||||
* Giving and gracefully accepting constructive feedback
|
||||
* Accepting responsibility and apologizing to those affected by our mistakes,
|
||||
and learning from the experience
|
||||
* Focusing on what is best not just for us as individuals, but for the overall
|
||||
community
|
||||
|
||||
Examples of unacceptable behavior by participants include:
|
||||
Examples of unacceptable behavior include:
|
||||
|
||||
* The use of sexualized language or imagery and unwelcome sexual attention or advances
|
||||
* Trolling, insulting/derogatory comments, and personal or political attacks
|
||||
* The use of sexualized language or imagery, and sexual attention or advances of
|
||||
any kind
|
||||
* Trolling, insulting or derogatory comments, and personal or political attacks
|
||||
* Public or private harassment
|
||||
* Publishing others' private information, such as a physical or electronic address, without explicit permission
|
||||
* Other conduct which could reasonably be considered inappropriate in a professional setting
|
||||
* Publishing others' private information, such as a physical or email address,
|
||||
without their explicit permission
|
||||
* Other conduct which could reasonably be considered inappropriate in a
|
||||
professional setting
|
||||
|
||||
## Our Responsibilities
|
||||
## Enforcement Responsibilities
|
||||
|
||||
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
|
||||
Community leaders are responsible for clarifying and enforcing our standards of
|
||||
acceptable behavior and will take appropriate and fair corrective action in
|
||||
response to any behavior that they deem inappropriate, threatening, offensive,
|
||||
or harmful.
|
||||
|
||||
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
|
||||
Community leaders have the right and responsibility to remove, edit, or reject
|
||||
comments, commits, code, wiki edits, issues, and other contributions that are
|
||||
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
||||
decisions when appropriate.
|
||||
|
||||
## Scope
|
||||
|
||||
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
|
||||
This Code of Conduct applies within all community spaces, and also applies when
|
||||
an individual is officially representing the community in public spaces.
|
||||
Examples of representing our community include using an official e-mail address,
|
||||
posting via an official social media account, or acting as an appointed
|
||||
representative at an online or offline event.
|
||||
|
||||
## Enforcement
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at patrick.marsceill@gmail.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||
reported to the community leaders responsible for enforcement at
|
||||
patrick.marsceill@gmail.com.
|
||||
All complaints will be reviewed and investigated promptly and fairly.
|
||||
|
||||
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
|
||||
All community leaders are obligated to respect the privacy and security of the
|
||||
reporter of any incident.
|
||||
|
||||
## Enforcement Guidelines
|
||||
|
||||
Community leaders will follow these Community Impact Guidelines in determining
|
||||
the consequences for any action they deem in violation of this Code of Conduct:
|
||||
|
||||
### 1. Correction
|
||||
|
||||
**Community Impact**: Use of inappropriate language or other behavior deemed
|
||||
unprofessional or unwelcome in the community.
|
||||
|
||||
**Consequence**: A private, written warning from community leaders, providing
|
||||
clarity around the nature of the violation and an explanation of why the
|
||||
behavior was inappropriate. A public apology may be requested.
|
||||
|
||||
### 2. Warning
|
||||
|
||||
**Community Impact**: A violation through a single incident or series of
|
||||
actions.
|
||||
|
||||
**Consequence**: A warning with consequences for continued behavior. No
|
||||
interaction with the people involved, including unsolicited interaction with
|
||||
those enforcing the Code of Conduct, for a specified period of time. This
|
||||
includes avoiding interactions in community spaces as well as external channels
|
||||
like social media. Violating these terms may lead to a temporary or permanent
|
||||
ban.
|
||||
|
||||
### 3. Temporary Ban
|
||||
|
||||
**Community Impact**: A serious violation of community standards, including
|
||||
sustained inappropriate behavior.
|
||||
|
||||
**Consequence**: A temporary ban from any sort of interaction or public
|
||||
communication with the community for a specified period of time. No public or
|
||||
private interaction with the people involved, including unsolicited interaction
|
||||
with those enforcing the Code of Conduct, is allowed during this period.
|
||||
Violating these terms may lead to a permanent ban.
|
||||
|
||||
### 4. Permanent Ban
|
||||
|
||||
**Community Impact**: Demonstrating a pattern of violation of community
|
||||
standards, including sustained inappropriate behavior, harassment of an
|
||||
individual, or aggression toward or disparagement of classes of individuals.
|
||||
|
||||
**Consequence**: A permanent ban from any sort of public interaction within the
|
||||
community.
|
||||
|
||||
## Attribution
|
||||
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
||||
version 2.1, available at
|
||||
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
|
||||
|
||||
[homepage]: http://contributor-covenant.org
|
||||
[version]: http://contributor-covenant.org/version/1/4/
|
||||
Community Impact Guidelines were inspired by
|
||||
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
|
||||
|
||||
For answers to common questions about this code of conduct, see the FAQ at
|
||||
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
|
||||
[https://www.contributor-covenant.org/translations][translations].
|
||||
|
||||
[homepage]: https://www.contributor-covenant.org
|
||||
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
|
||||
[Mozilla CoC]: https://github.com/mozilla/diversity
|
||||
[FAQ]: https://www.contributor-covenant.org/faq
|
||||
[translations]: https://www.contributor-covenant.org/translations
|
||||
|
@@ -1,4 +1,4 @@
|
||||
FROM ruby:2.6
|
||||
FROM ruby:2.7
|
||||
|
||||
ENV LC_ALL C.UTF-8
|
||||
ENV LANG en_US.UTF-8
|
||||
@@ -10,4 +10,3 @@ COPY Gemfile just-the-docs.gemspec ./
|
||||
RUN gem install bundler && bundle install
|
||||
|
||||
EXPOSE 4000
|
||||
|
||||
|
23
README.md
23
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/workflows/ci.yml"><img src="https://github.com/just-the-docs/just-the-docs/actions/workflows/ci.yml/badge.svg" alt="CI Build status"></a> <a href="https://app.netlify.com/sites/just-the-docs/deploys"><img src="https://api.netlify.com/api/v1/badges/9dc0386d-c2a4-4077-ad83-f02c33a6c0ca/deploy-status" alt="Netlify 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
|
||||
@@ -39,15 +50,15 @@ Alternatively, you can run it inside Docker while developing your site
|
||||
|
||||
## 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/).
|
||||
@@ -63,6 +74,8 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/pmarsc
|
||||
|
||||
To set up your environment to develop this theme, run `bundle install`.
|
||||
|
||||
A modern [devcontainer configuration](https://code.visualstudio.com/docs/remote/containers) for VSCode is included.
|
||||
|
||||
Your theme is set up just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.
|
||||
|
||||
When the theme is released, only the files in `_layouts`, `_includes`, and `_sass` tracked with Git will be released.
|
||||
|
38
_config.yml
38
_config.yml
@@ -13,21 +13,13 @@
|
||||
# you will see them accessed via {{ site.title }}, {{ site.github_repo }}, and so on.
|
||||
# You can create any custom variable you would like, and they will be accessible
|
||||
# in the templates via {{ site.myvariable }}.
|
||||
title: Just the Docs (v0.3.3)
|
||||
title: Just the Docs
|
||||
description: A Jekyll theme for documentation
|
||||
baseurl: "" # the subpath of your site, e.g. /blog
|
||||
url: "https://v0-3-3-docs.just-the-docs.com" # the base hostname & protocol for your site, e.g. http://example.com
|
||||
baseurl: "/just-the-docs" # the subpath of your site, e.g. /blog
|
||||
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"
|
||||
, "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/"]
|
||||
exclude: ["node_modules/", "*.gemspec", "*.gem", "Gemfile", "Gemfile.lock", "package.json", "package-lock.json", "script/", "LICENSE.txt", "lib/", "bin/", "README.md", "Rakefile"]
|
||||
|
||||
# Set a path/url to a logo that will be displayed instead of the title
|
||||
#logo: "/assets/images/just-the-docs.png"
|
||||
@@ -59,13 +51,22 @@ search:
|
||||
# Supports true or false (default)
|
||||
button: false
|
||||
|
||||
# To enable support for mermaid diagrams (https://mermaid-js.github.io/mermaid/),
|
||||
# uncomment the `mermaid` and `version` keys below
|
||||
# mermaid:
|
||||
# # Version of mermaid library
|
||||
# # Pick an available version from https://cdn.jsdelivr.net/npm/mermaid/
|
||||
# version: "9.1.3"
|
||||
# # Put any additional configuration, such as setting the theme, in _includes/mermaid_config.js
|
||||
# # See also docs/ui-components/code
|
||||
|
||||
# Enable or disable heading anchors
|
||||
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
|
||||
@@ -74,6 +75,11 @@ aux_links_new_tab: false
|
||||
# nav_sort: case_insensitive # default, equivalent to nil
|
||||
nav_sort: case_sensitive # Capital letters sorted before lowercase
|
||||
|
||||
# External navigation links
|
||||
nav_external_links:
|
||||
- title: Just the Docs on GitHub
|
||||
url: https://github.com/just-the-docs/just-the-docs
|
||||
|
||||
# Footer content
|
||||
# appears at the bottom of every page's main content
|
||||
|
||||
@@ -81,7 +87,7 @@ nav_sort: case_sensitive # Capital letters sorted before lowercase
|
||||
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> <a href=\"https://www.netlify.com/\">This site is powered by Netlify.</a>"
|
||||
|
||||
# Footer last edited timestamp
|
||||
last_edit_timestamp: true # show or hide edit time - page must have `last_modified_date` defined in the frontmatter
|
||||
@@ -92,8 +98,8 @@ 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
|
||||
|
||||
|
93
_includes/css/callouts.scss.liquid
Normal file
93
_includes/css/callouts.scss.liquid
Normal file
@@ -0,0 +1,93 @@
|
||||
{%- comment -%}
|
||||
{% include css/callouts.scss.liquid color_scheme = string %}
|
||||
produces SCSS for all the callouts in site.callouts. For the "dark"
|
||||
color scheme, the levels of the text and background colors are reversed.
|
||||
{%- endcomment -%}
|
||||
|
||||
{%- assign callout_background_hue = "000" -%}
|
||||
{%- assign callout_color_hue = "300" -%}
|
||||
{%- if site.callouts_level == "loud" or include.color_scheme == "dark" and site.callouts_level != "quiet" -%}
|
||||
{%- assign callout_background_hue = "300" -%}
|
||||
{%- assign callout_color_hue = "000" -%}
|
||||
{%- endif -%}
|
||||
|
||||
div.opaque {
|
||||
background-color: $body-background-color;
|
||||
}
|
||||
|
||||
{%- for callout in site.callouts %}
|
||||
|
||||
{%- assign callout_opacity = callout[1].opacity | default: site.callouts_opacity | default: 0.2 -%}
|
||||
|
||||
p.{{ callout[0] }}, blockquote.{{ callout[0] }} {
|
||||
background: rgba(${{ callout[1].color }}-{{ callout_background_hue }}, {{ callout_opacity }});
|
||||
border-left: $border-radius solid ${{ callout[1].color }}-{{ callout_color_hue }};
|
||||
border-radius: $border-radius;
|
||||
box-shadow: 0 1px 2px rgba(0, 0, 0, 0.12), 0 3px 10px rgba(0, 0, 0, 0.08);
|
||||
padding: .8rem;
|
||||
{% if callout[1].title %}
|
||||
&::before {
|
||||
color: ${{ callout[1].color }}-{{ callout_color_hue }};
|
||||
content: "{{ callout[1].title }}";
|
||||
display: block;
|
||||
font-weight: bold;
|
||||
text-transform: uppercase;
|
||||
font-size: .75em;
|
||||
padding-bottom: .125rem;
|
||||
}
|
||||
{% endif %}
|
||||
> .{{ callout[0] }}-title {
|
||||
color: ${{ callout[1].color }}-{{ callout_color_hue }};
|
||||
display: block;
|
||||
font-weight: bold;
|
||||
text-transform: uppercase;
|
||||
font-size: .75em;
|
||||
padding-bottom: .125rem;
|
||||
}
|
||||
}
|
||||
|
||||
p.{{ callout[0] }}-title, blockquote.{{ callout[0] }}-title {
|
||||
background: rgba(${{ callout[1].color }}-{{ callout_background_hue }}, {{ callout_opacity }});
|
||||
border-left: $border-radius solid ${{ callout[1].color }}-{{ callout_color_hue }};
|
||||
border-radius: $border-radius;
|
||||
box-shadow: 0 1px 2px rgba(0, 0, 0, 0.12), 0 3px 10px rgba(0, 0, 0, 0.08);
|
||||
padding: .8rem;
|
||||
> p:first-child {
|
||||
margin-top: 0;
|
||||
margin-bottom: 0;
|
||||
color: ${{ callout[1].color }}-{{ callout_color_hue }};
|
||||
display: block;
|
||||
font-weight: bold;
|
||||
text-transform: uppercase;
|
||||
font-size: .75em;
|
||||
padding-bottom: .125rem;
|
||||
}
|
||||
}
|
||||
|
||||
blockquote.{{ callout[0] }} {
|
||||
margin-left: 0;
|
||||
margin-right: 0;
|
||||
|
||||
> p:first-child {
|
||||
margin-top: 0;
|
||||
}
|
||||
|
||||
> p:last-child {
|
||||
margin-bottom: 0;
|
||||
}
|
||||
}
|
||||
|
||||
blockquote.{{ callout[0] }}-title {
|
||||
margin-left: 0;
|
||||
margin-right: 0;
|
||||
|
||||
> p:nth-child(2) {
|
||||
margin-top: 0;
|
||||
}
|
||||
|
||||
> p:last-child {
|
||||
margin-bottom: 0;
|
||||
}
|
||||
}
|
||||
|
||||
{% endfor -%}
|
@@ -1,7 +1,8 @@
|
||||
{% if site.logo %}
|
||||
$logo: "{{ site.logo | absolute_url }}";
|
||||
$logo: "{{ site.logo | relative_url }}";
|
||||
{% endif %}
|
||||
@import "./support/support";
|
||||
@import "./color_schemes/{{ include.color_scheme }}";
|
||||
@import "./modules";
|
||||
{% include css/custom.scss.liquid %}
|
||||
{% include css/callouts.scss.liquid color_scheme = include.color_scheme %}
|
||||
|
1
_includes/favicon.html
Normal file
1
_includes/favicon.html
Normal file
@@ -0,0 +1 @@
|
||||
<link rel="shortcut icon" href="{{ 'favicon.ico' | relative_url }}" type="image/x-icon">
|
@@ -10,7 +10,7 @@
|
||||
{% endif %}
|
||||
{% endunless %}
|
||||
|
||||
<link rel="shortcut icon" href="{{ 'favicon.ico' | relative_url }}" type="image/x-icon">
|
||||
{% include favicon.html %}
|
||||
|
||||
<link rel="stylesheet" href="{{ '/assets/css/just-the-docs-default.css' | relative_url }}">
|
||||
|
||||
@@ -29,6 +29,11 @@
|
||||
{% if site.search_enabled != false %}
|
||||
<script type="text/javascript" src="{{ '/assets/js/vendor/lunr.min.js' | relative_url }}"></script>
|
||||
{% endif %}
|
||||
|
||||
{% if site.mermaid %}
|
||||
<script src="https://cdn.jsdelivr.net/npm/mermaid@{{ site.mermaid.version }}/dist/mermaid.min.js"></script>
|
||||
{% endif %}
|
||||
|
||||
<script type="text/javascript" src="{{ '/assets/js/just-the-docs.js' | relative_url }}"></script>
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
|
5
_includes/icons/external_link.html
Normal file
5
_includes/icons/external_link.html
Normal file
@@ -0,0 +1,5 @@
|
||||
<!-- Feather. MIT License: https://github.com/feathericons/feather/blob/master/LICENSE -->
|
||||
<symbol id="svg-external-link" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-external-link">
|
||||
<title id="svg-external-link-title">(external link)</title>
|
||||
<path d="M18 13v6a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2V8a2 2 0 0 1 2-2h6"></path><polyline points="15 3 21 3 21 9"></polyline><line x1="10" y1="14" x2="21" y2="3"></line>
|
||||
</symbol>
|
1
_includes/mermaid_config.js
Normal file
1
_includes/mermaid_config.js
Normal file
@@ -0,0 +1 @@
|
||||
{}
|
@@ -60,13 +60,17 @@
|
||||
{%- for node in pages_list -%}
|
||||
{%- 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 %}">
|
||||
<li class="nav-list-item{% if page.collection == include.key and 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>
|
||||
<a href="{{ node.url | relative_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 -%}
|
||||
{%- if node.child_nav_order == 'desc' -%}
|
||||
{%- assign children_list = pages_list | where: "parent", node.title | where_exp:"item", "item.grand_parent == nil" | reverse -%}
|
||||
{%- else -%}
|
||||
{%- assign children_list = pages_list | where: "parent", node.title | where_exp:"item", "item.grand_parent == nil" -%}
|
||||
{%- endif -%}
|
||||
<ul class="nav-list ">
|
||||
{%- for child in children_list -%}
|
||||
{%- unless child.nav_exclude -%}
|
||||
@@ -74,14 +78,18 @@
|
||||
{%- 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>
|
||||
<a href="{{ child.url | relative_url }}" class="nav-list-link{% if page.url == child.url %} active{% endif %}">{{ child.title }}</a>
|
||||
{%- if child.has_children -%}
|
||||
{%- if node.child_nav_order == 'desc' -%}
|
||||
{%- assign grand_children_list = pages_list | where: "parent", child.title | where: "grand_parent", node.title | reverse -%}
|
||||
{%- else -%}
|
||||
{%- assign grand_children_list = pages_list | where: "parent", child.title | where: "grand_parent", node.title -%}
|
||||
{%- endif -%}
|
||||
<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>
|
||||
<a href="{{ grand_child.url | relative_url }}" class="nav-list-link{% if page.url == grand_child.url %} active{% endif %}">{{ grand_child.title }}</a>
|
||||
</li>
|
||||
{%- endunless -%}
|
||||
{%- endfor -%}
|
||||
@@ -96,4 +104,39 @@
|
||||
{%- endunless -%}
|
||||
{%- endif -%}
|
||||
{%- endfor -%}
|
||||
{%- assign nav_external_links = site.nav_external_links -%}
|
||||
{%- for node in nav_external_links -%}
|
||||
<li class="nav-list-item external">
|
||||
<a href="{{ node.url | absolute_url }}" class="nav-list-link external">
|
||||
{{ node.title }}
|
||||
{% unless node.hide_icon %}<svg viewBox="0 0 24 24" aria-labelledby="svg-external-link-title"><use xlink:href="#svg-external-link"></use></svg>{% endunless %}
|
||||
</a>
|
||||
</li>
|
||||
{%- endfor -%}
|
||||
</ul>
|
||||
|
||||
{%- if page.collection == include.key -%}
|
||||
|
||||
{%- for node in pages_list -%}
|
||||
{%- if node.parent == nil -%}
|
||||
{%- if page.grand_parent == node.title or page.parent == node.title and page.grand_parent == nil -%}
|
||||
{%- assign first_level_url = node.url | relative_url -%}
|
||||
{%- endif -%}
|
||||
{%- if node.has_children -%}
|
||||
{%- assign children_list = pages_list | where: "parent", node.title -%}
|
||||
{%- for child in children_list -%}
|
||||
{%- if child.has_children -%}
|
||||
{%- if page.url == child.url or page.parent == child.title and page.grand_parent == child.parent -%}
|
||||
{%- assign second_level_url = child.url | relative_url -%}
|
||||
{%- endif -%}
|
||||
{%- endif -%}
|
||||
{%- endfor -%}
|
||||
{%- endif -%}
|
||||
{%- endif -%}
|
||||
{%- endfor -%}
|
||||
|
||||
{% if page.has_children == true and page.has_toc != false %}
|
||||
{%- assign toc_list = pages_list | where: "parent", page.title | where: "grand_parent", page.parent -%}
|
||||
{%- endif -%}
|
||||
|
||||
{%- endif -%}
|
||||
|
0
_includes/nav_footer_custom.html
Normal file
0
_includes/nav_footer_custom.html
Normal file
1
_includes/search_placeholder_custom.html
Normal file
1
_includes/search_placeholder_custom.html
Normal file
@@ -0,0 +1 @@
|
||||
Search {{site.title}}
|
@@ -38,16 +38,25 @@ layout: table_wrappers
|
||||
<path d="M13 2H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2V9z"></path><polyline points="13 2 13 9 20 9"></polyline>
|
||||
</svg>
|
||||
</symbol>
|
||||
{% include icons/external_link.html %}
|
||||
</svg>
|
||||
|
||||
<div class="side-bar">
|
||||
<div class="site-header">
|
||||
<a href="{{ '/' | absolute_url }}" class="site-title lh-tight">{% include title.html %}</a>
|
||||
<a href="{{ '/' | relative_url }}" class="site-title lh-tight">{% include title.html %}</a>
|
||||
<a href="#" id="menu-button" class="site-button">
|
||||
<svg viewBox="0 0 24 24" class="icon"><use xlink:href="#svg-menu"></use></svg>
|
||||
</a>
|
||||
</div>
|
||||
<nav role="navigation" aria-label="Main" id="site-nav" class="site-nav">
|
||||
{% assign pages_top_size = site.html_pages
|
||||
| where_exp:"item", "item.title != nil"
|
||||
| where_exp:"item", "item.parent == nil"
|
||||
| where_exp:"item", "item.nav_exclude != true"
|
||||
| size %}
|
||||
{% if pages_top_size > 0 %}
|
||||
{% include nav.html pages=site.html_pages key=nil %}
|
||||
{% endif %}
|
||||
{% if site.just_the_docs.collections %}
|
||||
{% assign collections_size = site.just_the_docs.collections | size %}
|
||||
{% for collection_entry in site.just_the_docs.collections %}
|
||||
@@ -55,26 +64,49 @@ layout: table_wrappers
|
||||
{% 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>
|
||||
{% if collections_size > 1 or pages_top_size > 0 %}
|
||||
{% if collection_value.nav_fold == true %}
|
||||
<ul class="nav-list nav-category-list">
|
||||
<li class="nav-list-item{% if page.collection == collection_key %} active{% endif %}">
|
||||
{%- if collection.size > 0 -%}
|
||||
<a href="#" class="nav-list-expander"><svg viewBox="0 0 24 24"><use xlink:href="#svg-arrow-right"></use></svg></a>
|
||||
{%- endif -%}
|
||||
<div class="nav-category">{{ collection_value.name }}</div>
|
||||
{% include nav.html pages=collection key=collection_key %}
|
||||
</li>
|
||||
</ul>
|
||||
{% else %}
|
||||
<div class="nav-category">{{ collection_value.name }}</div>
|
||||
{% include nav.html pages=collection key=collection_key %}
|
||||
{% endif %}
|
||||
{% else %}
|
||||
{% include nav.html pages=collection key=collection_key %}
|
||||
{% 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.
|
||||
</footer>
|
||||
|
||||
{% capture nav_footer_custom %}
|
||||
{%- include nav_footer_custom.html -%}
|
||||
{% endcapture %}
|
||||
{% if nav_footer_custom != "" %}
|
||||
{{ nav_footer_custom }}
|
||||
{% else %}
|
||||
<footer class="site-footer">
|
||||
This site uses <a href="https://github.com/just-the-docs/just-the-docs">Just the Docs</a>, a documentation theme for Jekyll.
|
||||
</footer>
|
||||
{% endif %}
|
||||
</div>
|
||||
<div class="main" id="top">
|
||||
<div id="main-header" class="main-header">
|
||||
{% if site.search_enabled != false %}
|
||||
|
||||
{% capture search_placeholder %}{% include search_placeholder_custom.html %}{% endcapture %}
|
||||
|
||||
<div class="search">
|
||||
<div class="search-input-wrap">
|
||||
<input type="text" id="search-input" class="search-input" tabindex="0" placeholder="Search {{ site.title }}" aria-label="Search {{ site.title }}" autocomplete="off">
|
||||
<input type="text" id="search-input" class="search-input" tabindex="0" placeholder="{{ search_placeholder | strip_html | strip }}" aria-label="{{ search_placeholder | strip_html| strip }}" autocomplete="off">
|
||||
<label for="search-input" class="search-label"><svg viewBox="0 0 24 24" class="search-icon"><use xlink:href="#svg-search"></use></svg></label>
|
||||
</div>
|
||||
<div id="search-results" class="search-results"></div>
|
||||
@@ -102,21 +134,6 @@ 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 %}
|
||||
@@ -141,10 +158,9 @@ layout: table_wrappers
|
||||
<hr>
|
||||
<h2 class="text-delta">Table of contents</h2>
|
||||
<ul>
|
||||
{%- assign children_list = pages_list | where: "parent", page.title | where: "grand_parent", page.parent -%}
|
||||
{% for child in children_list %}
|
||||
{% for child in toc_list %}
|
||||
<li>
|
||||
<a href="{{ child.url | absolute_url }}">{{ child.title }}</a>{% if child.summary %} - {{ child.summary }}{% endif %}
|
||||
<a href="{{ child.url | relative_url }}">{{ child.title }}</a>{% if child.summary %} - {{ child.summary }}{% endif %}
|
||||
</li>
|
||||
{% endfor %}
|
||||
</ul>
|
||||
@@ -177,7 +193,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 }}{% if site.gh_edit_source %}/{{ site.gh_edit_source }}{% endif %}/{{ 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 %}{% if page.collection and site.collections_dir %}/{{ site.collections_dir }}{% endif %}/{{ page.path }}" id="edit-this-page">{{ site.gh_edit_link_text }}</a>
|
||||
</p>
|
||||
{% endif %}
|
||||
</div>
|
||||
@@ -199,4 +215,11 @@ layout: table_wrappers
|
||||
{% endif %}
|
||||
</div>
|
||||
</body>
|
||||
{% if site.mermaid %}
|
||||
<script>
|
||||
var config = {% include mermaid_config.js %};
|
||||
mermaid.initialize(config);
|
||||
window.mermaid.init(undefined, document.querySelectorAll('.language-mermaid'));
|
||||
</script>
|
||||
{% endif %}
|
||||
</html>
|
||||
|
@@ -1,7 +1,5 @@
|
||||
//
|
||||
// Base element style overrides
|
||||
//
|
||||
// stylelint-disable selector-no-type, selector-max-type
|
||||
// stylelint-disable selector-no-type, selector-max-type, selector-max-specificity, selector-max-id
|
||||
|
||||
* {
|
||||
box-sizing: border-box;
|
||||
@@ -14,6 +12,7 @@
|
||||
|
||||
html {
|
||||
@include fs-4;
|
||||
|
||||
scroll-behavior: smooth;
|
||||
}
|
||||
|
||||
@@ -23,6 +22,7 @@ body {
|
||||
line-height: $body-line-height;
|
||||
color: $body-text-color;
|
||||
background-color: $body-background-color;
|
||||
overflow-wrap: break-word;
|
||||
}
|
||||
|
||||
ol,
|
||||
@@ -45,7 +45,8 @@ h2,
|
||||
h3,
|
||||
h4,
|
||||
h5,
|
||||
h6 {
|
||||
h6,
|
||||
#toctitle {
|
||||
margin-top: 0;
|
||||
margin-bottom: 1em;
|
||||
font-weight: 500;
|
||||
|
@@ -1,6 +1,4 @@
|
||||
//
|
||||
// Buttons and things that look like buttons
|
||||
//
|
||||
// stylelint-disable color-named
|
||||
|
||||
.btn {
|
||||
|
231
_sass/code.scss
231
_sass/code.scss
@@ -1,7 +1,7 @@
|
||||
//
|
||||
// Code and syntax highlighting
|
||||
//
|
||||
// stylelint-disable selector-no-qualifying-type, declaration-block-semicolon-newline-after,declaration-block-single-line-max-declarations, selector-no-type, selector-max-type
|
||||
// stylelint-disable selector-no-qualifying-type, declaration-block-semicolon-newline-after,declaration-block-single-line-max-declarations, selector-no-type, selector-max-type, scss/comment-no-empty
|
||||
|
||||
// {% raw %}
|
||||
|
||||
code {
|
||||
padding: 0.2em 0.15em;
|
||||
@@ -36,6 +36,9 @@ a:visited code {
|
||||
// > td.gutter.gl > pre.lineno
|
||||
// | td.code > pre
|
||||
//
|
||||
// ----...---- (AsciiDoc)
|
||||
// div.listingblock > div.content > pre.rouge.highlight
|
||||
//
|
||||
// fix_linenos removes the outermost pre when it encloses table.rouge-table
|
||||
//
|
||||
// See docs/index-test.md for some tests.
|
||||
@@ -44,7 +47,8 @@ a:visited code {
|
||||
// Kramdown line_numbers = true: fences have a wider gutter than with Liquid?
|
||||
|
||||
// ```[LANG]...```
|
||||
div.highlighter-rouge {
|
||||
div.highlighter-rouge,
|
||||
div.listingblock {
|
||||
padding: $sp-3;
|
||||
margin-top: 0;
|
||||
margin-bottom: $sp-3;
|
||||
@@ -69,6 +73,7 @@ figure.highlight {
|
||||
padding: $sp-3;
|
||||
margin-top: 0;
|
||||
margin-bottom: $sp-3;
|
||||
overflow-x: auto;
|
||||
background-color: $code-background-color;
|
||||
border-radius: $border-radius;
|
||||
box-shadow: none;
|
||||
@@ -93,6 +98,7 @@ figure.highlight {
|
||||
td,
|
||||
pre {
|
||||
@include fs-2;
|
||||
|
||||
min-width: 0;
|
||||
padding: 0;
|
||||
background-color: $code-background-color;
|
||||
@@ -109,213 +115,6 @@ figure.highlight {
|
||||
}
|
||||
}
|
||||
|
||||
.highlight .c {
|
||||
color: #586e75;
|
||||
} // comment //
|
||||
.highlight .err {
|
||||
color: #93a1a1;
|
||||
} // error //
|
||||
.highlight .g {
|
||||
color: #93a1a1;
|
||||
} // generic //
|
||||
.highlight .k {
|
||||
color: #859900;
|
||||
} // keyword //
|
||||
.highlight .l {
|
||||
color: #93a1a1;
|
||||
} // literal //
|
||||
.highlight .n {
|
||||
color: #93a1a1;
|
||||
} // name //
|
||||
.highlight .o {
|
||||
color: #859900;
|
||||
} // operator //
|
||||
.highlight .x {
|
||||
color: #cb4b16;
|
||||
} // other //
|
||||
.highlight .p {
|
||||
color: #93a1a1;
|
||||
} // punctuation //
|
||||
.highlight .cm {
|
||||
color: #586e75;
|
||||
} // comment.multiline //
|
||||
.highlight .cp {
|
||||
color: #859900;
|
||||
} // comment.preproc //
|
||||
.highlight .c1 {
|
||||
color: #586e75;
|
||||
} // comment.single //
|
||||
.highlight .cs {
|
||||
color: #859900;
|
||||
} // comment.special //
|
||||
.highlight .gd {
|
||||
color: #2aa198;
|
||||
} // generic.deleted //
|
||||
.highlight .ge {
|
||||
font-style: italic;
|
||||
color: #93a1a1;
|
||||
} // generic.emph //
|
||||
.highlight .gr {
|
||||
color: #dc322f;
|
||||
} // generic.error //
|
||||
.highlight .gh {
|
||||
color: #cb4b16;
|
||||
} // generic.heading //
|
||||
.highlight .gi {
|
||||
color: #859900;
|
||||
} // generic.inserted //
|
||||
.highlight .go {
|
||||
color: #93a1a1;
|
||||
} // generic.output //
|
||||
.highlight .gp {
|
||||
color: #93a1a1;
|
||||
} // generic.prompt //
|
||||
.highlight .gs {
|
||||
font-weight: bold;
|
||||
color: #93a1a1;
|
||||
} // generic.strong //
|
||||
.highlight .gu {
|
||||
color: #cb4b16;
|
||||
} // generic.subheading //
|
||||
.highlight .gt {
|
||||
color: #93a1a1;
|
||||
} // generic.traceback //
|
||||
.highlight .kc {
|
||||
color: #cb4b16;
|
||||
} // keyword.constant //
|
||||
.highlight .kd {
|
||||
color: #268bd2;
|
||||
} // keyword.declaration //
|
||||
.highlight .kn {
|
||||
color: #859900;
|
||||
} // keyword.namespace //
|
||||
.highlight .kp {
|
||||
color: #859900;
|
||||
} // keyword.pseudo //
|
||||
.highlight .kr {
|
||||
color: #268bd2;
|
||||
} // keyword.reserved //
|
||||
.highlight .kt {
|
||||
color: #dc322f;
|
||||
} // keyword.type //
|
||||
.highlight .ld {
|
||||
color: #93a1a1;
|
||||
} // literal.date //
|
||||
.highlight .m {
|
||||
color: #2aa198;
|
||||
} // literal.number //
|
||||
.highlight .s {
|
||||
color: #2aa198;
|
||||
} // literal.string //
|
||||
.highlight .na {
|
||||
color: #555;
|
||||
} // name.attribute //
|
||||
.highlight .nb {
|
||||
color: #b58900;
|
||||
} // name.builtin //
|
||||
.highlight .nc {
|
||||
color: #268bd2;
|
||||
} // name.class //
|
||||
.highlight .no {
|
||||
color: #cb4b16;
|
||||
} // name.constant //
|
||||
.highlight .nd {
|
||||
color: #268bd2;
|
||||
} // name.decorator //
|
||||
.highlight .ni {
|
||||
color: #cb4b16;
|
||||
} // name.entity //
|
||||
.highlight .ne {
|
||||
color: #cb4b16;
|
||||
} // name.exception //
|
||||
.highlight .nf {
|
||||
color: #268bd2;
|
||||
} // name.function //
|
||||
.highlight .nl {
|
||||
color: #555;
|
||||
} // name.label //
|
||||
.highlight .nn {
|
||||
color: #93a1a1;
|
||||
} // name.namespace //
|
||||
.highlight .nx {
|
||||
color: #555;
|
||||
} // name.other //
|
||||
.highlight .py {
|
||||
color: #93a1a1;
|
||||
} // name.property //
|
||||
.highlight .nt {
|
||||
color: #268bd2;
|
||||
} // name.tag //
|
||||
.highlight .nv {
|
||||
color: #268bd2;
|
||||
} // name.variable //
|
||||
.highlight .ow {
|
||||
color: #859900;
|
||||
} // operator.word //
|
||||
.highlight .w {
|
||||
color: #93a1a1;
|
||||
} // text.whitespace //
|
||||
.highlight .mf {
|
||||
color: #2aa198;
|
||||
} // literal.number.float //
|
||||
.highlight .mh {
|
||||
color: #2aa198;
|
||||
} // literal.number.hex //
|
||||
.highlight .mi {
|
||||
color: #2aa198;
|
||||
} // literal.number.integer //
|
||||
.highlight .mo {
|
||||
color: #2aa198;
|
||||
} // literal.number.oct //
|
||||
.highlight .sb {
|
||||
color: #586e75;
|
||||
} // literal.string.backtick //
|
||||
.highlight .sc {
|
||||
color: #2aa198;
|
||||
} // literal.string.char //
|
||||
.highlight .sd {
|
||||
color: #93a1a1;
|
||||
} // literal.string.doc //
|
||||
.highlight .s2 {
|
||||
color: #2aa198;
|
||||
} // literal.string.double //
|
||||
.highlight .se {
|
||||
color: #cb4b16;
|
||||
} // literal.string.escape //
|
||||
.highlight .sh {
|
||||
color: #93a1a1;
|
||||
} // literal.string.heredoc //
|
||||
.highlight .si {
|
||||
color: #2aa198;
|
||||
} // literal.string.interpol //
|
||||
.highlight .sx {
|
||||
color: #2aa198;
|
||||
} // literal.string.other //
|
||||
.highlight .sr {
|
||||
color: #dc322f;
|
||||
} // literal.string.regex //
|
||||
.highlight .s1 {
|
||||
color: #2aa198;
|
||||
} // literal.string.single //
|
||||
.highlight .ss {
|
||||
color: #2aa198;
|
||||
} // literal.string.symbol //
|
||||
.highlight .bp {
|
||||
color: #268bd2;
|
||||
} // name.builtin.pseudo //
|
||||
.highlight .vc {
|
||||
color: #268bd2;
|
||||
} // name.variable.class //
|
||||
.highlight .vg {
|
||||
color: #268bd2;
|
||||
} // name.variable.global //
|
||||
.highlight .vi {
|
||||
color: #268bd2;
|
||||
} // name.variable.instance //
|
||||
.highlight .il {
|
||||
color: #2aa198;
|
||||
} // literal.number.integer.long //
|
||||
|
||||
//
|
||||
// Code examples (rendered)
|
||||
//
|
||||
@@ -328,6 +127,7 @@ figure.highlight {
|
||||
border-radius: $border-radius;
|
||||
|
||||
+ .highlighter-rouge,
|
||||
+ .sectionbody .listingblock,
|
||||
+ figure.highlight {
|
||||
position: relative;
|
||||
margin-top: -$sp-4;
|
||||
@@ -338,3 +138,12 @@ figure.highlight {
|
||||
border-top-right-radius: 0;
|
||||
}
|
||||
}
|
||||
|
||||
// Mermaid diagram code blocks should be left unstyled.
|
||||
code.language-mermaid {
|
||||
padding: 0;
|
||||
background-color: inherit;
|
||||
border: 0;
|
||||
}
|
||||
|
||||
// {% endraw %}
|
||||
|
@@ -1,17 +1,28 @@
|
||||
$body-background-color: $grey-dk-300;
|
||||
$sidebar-color: $grey-dk-300;
|
||||
$border-color: $grey-dk-200;
|
||||
|
||||
$body-text-color: $grey-lt-300;
|
||||
$body-heading-color: $grey-lt-000;
|
||||
$nav-child-link-color: $grey-dk-000;
|
||||
$search-result-preview-color: $grey-dk-000;
|
||||
|
||||
$link-color: $blue-000;
|
||||
$btn-primary-color: $blue-200;
|
||||
$base-button-color: $grey-dk-250;
|
||||
|
||||
$code-background-color: $grey-dk-250;
|
||||
$search-background-color: $grey-dk-250;
|
||||
$table-background-color: $grey-dk-250;
|
||||
$feedback-color: darken($sidebar-color, 3%);
|
||||
|
||||
// The following highlight theme is more legible than that used for the light color scheme
|
||||
|
||||
// @import "./vendor/OneDarkJekyll/syntax-one-dark";
|
||||
// $code-background-color: #282c34;
|
||||
|
||||
@import "./vendor/OneDarkJekyll/syntax-one-dark-vivid";
|
||||
|
||||
$code-background-color: #31343f;
|
||||
|
||||
// @import "./vendor/OneDarkJekyll/syntax-firewatch";
|
||||
// $code-background-color: #282c34;
|
||||
|
||||
// @import "./vendor/OneDarkJekyll/syntax-firewatch-green";
|
||||
// $code-background-color: #282c34;
|
||||
|
@@ -0,0 +1,208 @@
|
||||
// Moved from _sass/code.scss
|
||||
|
||||
.highlight .c {
|
||||
color: #586e75;
|
||||
} // comment //
|
||||
.highlight .err {
|
||||
color: #93a1a1;
|
||||
} // error //
|
||||
.highlight .g {
|
||||
color: #93a1a1;
|
||||
} // generic //
|
||||
.highlight .k {
|
||||
color: #859900;
|
||||
} // keyword //
|
||||
.highlight .l {
|
||||
color: #93a1a1;
|
||||
} // literal //
|
||||
.highlight .n {
|
||||
color: #93a1a1;
|
||||
} // name //
|
||||
.highlight .o {
|
||||
color: #859900;
|
||||
} // operator //
|
||||
.highlight .x {
|
||||
color: #cb4b16;
|
||||
} // other //
|
||||
.highlight .p {
|
||||
color: #93a1a1;
|
||||
} // punctuation //
|
||||
.highlight .cm {
|
||||
color: #586e75;
|
||||
} // comment.multiline //
|
||||
.highlight .cp {
|
||||
color: #859900;
|
||||
} // comment.preproc //
|
||||
.highlight .c1 {
|
||||
color: #586e75;
|
||||
} // comment.single //
|
||||
.highlight .cs {
|
||||
color: #859900;
|
||||
} // comment.special //
|
||||
.highlight .gd {
|
||||
color: #2aa198;
|
||||
} // generic.deleted //
|
||||
.highlight .ge {
|
||||
font-style: italic;
|
||||
color: #93a1a1;
|
||||
} // generic.emph //
|
||||
.highlight .gr {
|
||||
color: #dc322f;
|
||||
} // generic.error //
|
||||
.highlight .gh {
|
||||
color: #cb4b16;
|
||||
} // generic.heading //
|
||||
.highlight .gi {
|
||||
color: #859900;
|
||||
} // generic.inserted //
|
||||
.highlight .go {
|
||||
color: #93a1a1;
|
||||
} // generic.output //
|
||||
.highlight .gp {
|
||||
color: #93a1a1;
|
||||
} // generic.prompt //
|
||||
.highlight .gs {
|
||||
font-weight: bold;
|
||||
color: #93a1a1;
|
||||
} // generic.strong //
|
||||
.highlight .gu {
|
||||
color: #cb4b16;
|
||||
} // generic.subheading //
|
||||
.highlight .gt {
|
||||
color: #93a1a1;
|
||||
} // generic.traceback //
|
||||
.highlight .kc {
|
||||
color: #cb4b16;
|
||||
} // keyword.constant //
|
||||
.highlight .kd {
|
||||
color: #268bd2;
|
||||
} // keyword.declaration //
|
||||
.highlight .kn {
|
||||
color: #859900;
|
||||
} // keyword.namespace //
|
||||
.highlight .kp {
|
||||
color: #859900;
|
||||
} // keyword.pseudo //
|
||||
.highlight .kr {
|
||||
color: #268bd2;
|
||||
} // keyword.reserved //
|
||||
.highlight .kt {
|
||||
color: #dc322f;
|
||||
} // keyword.type //
|
||||
.highlight .ld {
|
||||
color: #93a1a1;
|
||||
} // literal.date //
|
||||
.highlight .m {
|
||||
color: #2aa198;
|
||||
} // literal.number //
|
||||
.highlight .s {
|
||||
color: #2aa198;
|
||||
} // literal.string //
|
||||
.highlight .na {
|
||||
color: #555;
|
||||
} // name.attribute //
|
||||
.highlight .nb {
|
||||
color: #b58900;
|
||||
} // name.builtin //
|
||||
.highlight .nc {
|
||||
color: #268bd2;
|
||||
} // name.class //
|
||||
.highlight .no {
|
||||
color: #cb4b16;
|
||||
} // name.constant //
|
||||
.highlight .nd {
|
||||
color: #268bd2;
|
||||
} // name.decorator //
|
||||
.highlight .ni {
|
||||
color: #cb4b16;
|
||||
} // name.entity //
|
||||
.highlight .ne {
|
||||
color: #cb4b16;
|
||||
} // name.exception //
|
||||
.highlight .nf {
|
||||
color: #268bd2;
|
||||
} // name.function //
|
||||
.highlight .nl {
|
||||
color: #555;
|
||||
} // name.label //
|
||||
.highlight .nn {
|
||||
color: #93a1a1;
|
||||
} // name.namespace //
|
||||
.highlight .nx {
|
||||
color: #555;
|
||||
} // name.other //
|
||||
.highlight .py {
|
||||
color: #93a1a1;
|
||||
} // name.property //
|
||||
.highlight .nt {
|
||||
color: #268bd2;
|
||||
} // name.tag //
|
||||
.highlight .nv {
|
||||
color: #268bd2;
|
||||
} // name.variable //
|
||||
.highlight .ow {
|
||||
color: #859900;
|
||||
} // operator.word //
|
||||
.highlight .w {
|
||||
color: #93a1a1;
|
||||
} // text.whitespace //
|
||||
.highlight .mf {
|
||||
color: #2aa198;
|
||||
} // literal.number.float //
|
||||
.highlight .mh {
|
||||
color: #2aa198;
|
||||
} // literal.number.hex //
|
||||
.highlight .mi {
|
||||
color: #2aa198;
|
||||
} // literal.number.integer //
|
||||
.highlight .mo {
|
||||
color: #2aa198;
|
||||
} // literal.number.oct //
|
||||
.highlight .sb {
|
||||
color: #586e75;
|
||||
} // literal.string.backtick //
|
||||
.highlight .sc {
|
||||
color: #2aa198;
|
||||
} // literal.string.char //
|
||||
.highlight .sd {
|
||||
color: #93a1a1;
|
||||
} // literal.string.doc //
|
||||
.highlight .s2 {
|
||||
color: #2aa198;
|
||||
} // literal.string.double //
|
||||
.highlight .se {
|
||||
color: #cb4b16;
|
||||
} // literal.string.escape //
|
||||
.highlight .sh {
|
||||
color: #93a1a1;
|
||||
} // literal.string.heredoc //
|
||||
.highlight .si {
|
||||
color: #2aa198;
|
||||
} // literal.string.interpol //
|
||||
.highlight .sx {
|
||||
color: #2aa198;
|
||||
} // literal.string.other //
|
||||
.highlight .sr {
|
||||
color: #dc322f;
|
||||
} // literal.string.regex //
|
||||
.highlight .s1 {
|
||||
color: #2aa198;
|
||||
} // literal.string.single //
|
||||
.highlight .ss {
|
||||
color: #2aa198;
|
||||
} // literal.string.symbol //
|
||||
.highlight .bp {
|
||||
color: #268bd2;
|
||||
} // name.builtin.pseudo //
|
||||
.highlight .vc {
|
||||
color: #268bd2;
|
||||
} // name.variable.class //
|
||||
.highlight .vg {
|
||||
color: #268bd2;
|
||||
} // name.variable.global //
|
||||
.highlight .vi {
|
||||
color: #268bd2;
|
||||
} // name.variable.instance //
|
||||
.highlight .il {
|
||||
color: #2aa198;
|
||||
} // literal.number.integer.long //
|
||||
|
@@ -1,9 +1,7 @@
|
||||
@charset "UTF-8";
|
||||
|
||||
//
|
||||
// Styles for rendered markdown in the .main-content container
|
||||
//
|
||||
// stylelint-disable selector-no-type, max-nesting-depth, selector-max-compound-selectors, selector-max-type
|
||||
// stylelint-disable selector-no-type, max-nesting-depth, selector-max-compound-selectors, selector-max-type, selector-max-specificity, selector-max-id
|
||||
|
||||
.main-content {
|
||||
line-height: $content-line-height;
|
||||
@@ -21,7 +19,6 @@
|
||||
a {
|
||||
overflow: hidden;
|
||||
text-overflow: ellipsis;
|
||||
white-space: nowrap;
|
||||
}
|
||||
|
||||
ul,
|
||||
@@ -59,7 +56,7 @@
|
||||
ol {
|
||||
counter-reset: sub-counter;
|
||||
|
||||
li {
|
||||
> li {
|
||||
&::before {
|
||||
content: counter(sub-counter, lower-alpha);
|
||||
counter-increment: sub-counter;
|
||||
@@ -82,14 +79,7 @@
|
||||
}
|
||||
}
|
||||
|
||||
.task-list {
|
||||
padding-left: 0;
|
||||
}
|
||||
|
||||
.task-list-item {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
|
||||
&::before {
|
||||
content: "";
|
||||
}
|
||||
@@ -97,6 +87,9 @@
|
||||
|
||||
.task-list-item-checkbox {
|
||||
margin-right: 0.6em;
|
||||
margin-left: -1.4em;
|
||||
|
||||
// The same margin-left is used above for ul > li::before
|
||||
}
|
||||
|
||||
hr + * {
|
||||
@@ -121,6 +114,7 @@
|
||||
grid-column: 1;
|
||||
font-weight: 500;
|
||||
text-align: right;
|
||||
|
||||
&::after {
|
||||
content: ":";
|
||||
}
|
||||
@@ -130,6 +124,7 @@
|
||||
grid-column: 2;
|
||||
margin-bottom: 0;
|
||||
margin-left: 1em;
|
||||
|
||||
blockquote,
|
||||
div,
|
||||
dl,
|
||||
@@ -188,6 +183,7 @@
|
||||
}
|
||||
|
||||
.anchor-heading:hover,
|
||||
.anchor-heading:focus,
|
||||
h1:hover > .anchor-heading,
|
||||
h2:hover > .anchor-heading,
|
||||
h3:hover > .anchor-heading,
|
||||
@@ -208,24 +204,36 @@
|
||||
h3,
|
||||
h4,
|
||||
h5,
|
||||
h6 {
|
||||
h6,
|
||||
#toctitle {
|
||||
position: relative;
|
||||
margin-top: 1.5em;
|
||||
margin-bottom: 0.25em;
|
||||
|
||||
&:first-child {
|
||||
margin-top: $sp-2;
|
||||
}
|
||||
|
||||
+ table,
|
||||
+ .table-wrapper,
|
||||
+ .code-example,
|
||||
+ .highlighter-rouge {
|
||||
+ .highlighter-rouge,
|
||||
+ .sectionbody .listingblock {
|
||||
margin-top: 1em;
|
||||
}
|
||||
|
||||
+ p {
|
||||
+ p:not(.label) {
|
||||
margin-top: 0;
|
||||
}
|
||||
}
|
||||
|
||||
> h1:first-child,
|
||||
> h2:first-child,
|
||||
> h3:first-child,
|
||||
> h4:first-child,
|
||||
> h5:first-child,
|
||||
> h6:first-child,
|
||||
> .sect1:first-child > h2,
|
||||
> .sect2:first-child > h3,
|
||||
> .sect3:first-child > h4,
|
||||
> .sect4:first-child > h5,
|
||||
> .sect5:first-child > h6 {
|
||||
margin-top: $sp-2;
|
||||
}
|
||||
}
|
||||
|
@@ -0,0 +1,4 @@
|
||||
$pink-000: #f77ef1;
|
||||
$pink-100: #f967f1;
|
||||
$pink-200: #e94ee1;
|
||||
$pink-300: #dd2cd4;
|
||||
|
@@ -1,6 +1,4 @@
|
||||
//
|
||||
// Labels (not the form kind)
|
||||
//
|
||||
|
||||
.label,
|
||||
.label-blue {
|
||||
@@ -16,6 +14,7 @@
|
||||
vertical-align: middle;
|
||||
background-color: $blue-100;
|
||||
@include fs-2;
|
||||
|
||||
border-radius: 12px;
|
||||
}
|
||||
|
||||
|
@@ -1,6 +1,4 @@
|
||||
//
|
||||
// The basic two column layout
|
||||
//
|
||||
|
||||
.side-bar {
|
||||
z-index: 0;
|
||||
@@ -40,6 +38,7 @@
|
||||
|
||||
.main-content-wrap {
|
||||
@include container;
|
||||
|
||||
padding-top: $gutter-spacing-sm;
|
||||
padding-bottom: $gutter-spacing-sm;
|
||||
|
||||
@@ -111,6 +110,7 @@
|
||||
|
||||
.site-title {
|
||||
@include container;
|
||||
|
||||
flex-grow: 1;
|
||||
display: flex;
|
||||
height: 100%;
|
||||
@@ -184,6 +184,7 @@ body {
|
||||
|
||||
.site-footer {
|
||||
@include container;
|
||||
|
||||
position: absolute;
|
||||
bottom: 0;
|
||||
left: 0;
|
||||
|
@@ -1,11 +1,7 @@
|
||||
//
|
||||
// Import external dependencies
|
||||
//
|
||||
@import "./vendor/normalize.scss/normalize.scss";
|
||||
@import "./vendor/normalize.scss/normalize";
|
||||
|
||||
//
|
||||
// Modules
|
||||
//
|
||||
@import "./base";
|
||||
@import "./layout";
|
||||
@import "./content";
|
||||
|
@@ -1,6 +1,4 @@
|
||||
//
|
||||
// Main nav, breadcrumb, etc...
|
||||
//
|
||||
// stylelint-disable selector-no-type, max-nesting-depth, selector-max-compound-selectors, selector-max-type, selector-max-specificity
|
||||
|
||||
.nav-list {
|
||||
@@ -11,6 +9,7 @@
|
||||
|
||||
.nav-list-item {
|
||||
@include fs-4;
|
||||
|
||||
position: relative;
|
||||
margin: 0;
|
||||
|
||||
@@ -44,6 +43,12 @@
|
||||
}
|
||||
}
|
||||
|
||||
&.external > svg {
|
||||
width: $sp-4;
|
||||
height: $sp-4;
|
||||
vertical-align: text-bottom;
|
||||
}
|
||||
|
||||
&.active {
|
||||
font-weight: 600;
|
||||
text-decoration: none;
|
||||
@@ -65,6 +70,7 @@
|
||||
@if $nav-list-expander-right {
|
||||
right: 0;
|
||||
}
|
||||
|
||||
width: $nav-list-item-height-sm;
|
||||
height: $nav-list-item-height-sm;
|
||||
padding-top: #{$nav-list-item-height-sm / 4};
|
||||
@@ -137,7 +143,7 @@
|
||||
padding-bottom: $sp-2;
|
||||
padding-left: $gutter-spacing-sm;
|
||||
font-weight: 600;
|
||||
text-align: end;
|
||||
text-align: start;
|
||||
text-transform: uppercase;
|
||||
border-bottom: $border $border-color;
|
||||
@include fs-2;
|
||||
@@ -154,6 +160,26 @@
|
||||
}
|
||||
}
|
||||
|
||||
.nav-list.nav-category-list {
|
||||
> .nav-list-item {
|
||||
margin: 0;
|
||||
|
||||
> .nav-list {
|
||||
padding: 0;
|
||||
|
||||
> .nav-list-item {
|
||||
> .nav-list-link {
|
||||
color: $link-color;
|
||||
}
|
||||
|
||||
> .nav-list-expander {
|
||||
color: $link-color;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Aux nav
|
||||
|
||||
.aux-nav {
|
||||
|
@@ -1,4 +1,4 @@
|
||||
// stylelint-disable selector-max-specificity, selector-max-id, selector-max-type, selector-no-qualifying-type, primer/no-override,
|
||||
// stylelint-disable selector-max-specificity, selector-max-id, selector-max-type, selector-no-qualifying-type
|
||||
|
||||
@media print {
|
||||
.site-footer,
|
||||
|
@@ -1,6 +1,4 @@
|
||||
//
|
||||
// Search input and autocomplete
|
||||
//
|
||||
|
||||
.search {
|
||||
position: relative;
|
||||
@@ -48,6 +46,7 @@
|
||||
padding-bottom: $sp-2;
|
||||
padding-left: #{$gutter-spacing-sm + $sp-5};
|
||||
font-size: 16px;
|
||||
color: $body-text-color;
|
||||
background-color: $search-background-color;
|
||||
border-top: 0;
|
||||
border-right: 0;
|
||||
|
@@ -1,9 +1,9 @@
|
||||
@function rem($size, $unit: "") {
|
||||
$remSize: $size / $root-font-size;
|
||||
$rem-size: $size / $root-font-size;
|
||||
|
||||
@if ($unit == false) {
|
||||
@return #{$remSize};
|
||||
@if $unit == false {
|
||||
@return #{$rem-size};
|
||||
} @else {
|
||||
@return #{$remSize}rem;
|
||||
@return #{$rem-size}rem;
|
||||
}
|
||||
}
|
||||
|
@@ -1,82 +1,67 @@
|
||||
//
|
||||
// Typography
|
||||
//
|
||||
|
||||
$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;
|
||||
$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-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-5: 16px !default; // h3
|
||||
$font-size-6: 18px !default; // h2
|
||||
$font-size-7: 24px !default;
|
||||
$font-size-8: 32px !default; //h1
|
||||
$font-size-8: 32px !default; // h1
|
||||
$font-size-9: 36px !default;
|
||||
$font-size-10: 42px !default;
|
||||
$font-size-10-sm: 48px !default;
|
||||
|
||||
//
|
||||
// Colors
|
||||
//
|
||||
|
||||
$white: #fff !default;
|
||||
|
||||
$grey-dk-000: #959396 !default;
|
||||
$grey-dk-100: #5c5962 !default;
|
||||
$grey-dk-200: #44434d !default;
|
||||
$grey-dk-250: #302d36 !default;
|
||||
$grey-dk-300: #27262b !default;
|
||||
|
||||
$grey-lt-000: #f5f6fa !default;
|
||||
$grey-lt-100: #eeebee !default;
|
||||
$grey-lt-200: #ecebed !default;
|
||||
$grey-lt-300: #e6e1e8 !default;
|
||||
|
||||
$purple-000: #7253ed !default;
|
||||
$purple-100: #5e41d0 !default;
|
||||
$purple-200: #4e26af !default;
|
||||
$purple-300: #381885 !default;
|
||||
|
||||
$blue-000: #2c84fa !default;
|
||||
$blue-100: #2869e6 !default;
|
||||
$blue-200: #264caf !default;
|
||||
$blue-300: #183385 !default;
|
||||
|
||||
$green-000: #41d693 !default;
|
||||
$green-100: #11b584 !default;
|
||||
$green-200: #009c7b !default;
|
||||
$green-300: #026e57 !default;
|
||||
|
||||
$yellow-000: #ffeb82 !default;
|
||||
$yellow-100: #fadf50 !default;
|
||||
$yellow-200: #f7d12e !default;
|
||||
$yellow-300: #e7af06 !default;
|
||||
|
||||
$red-000: #f77e7e !default;
|
||||
$red-100: #f96e65 !default;
|
||||
$red-200: #e94c4c !default;
|
||||
$red-300: #dd2e2e !default;
|
||||
|
||||
$body-background-color: $white !default;
|
||||
$sidebar-color: $grey-lt-000 !default;
|
||||
$search-background-color: $white !default;
|
||||
$table-background-color: $white !default;
|
||||
$code-background-color: $grey-lt-000 !default;
|
||||
$feedback-color: darken($sidebar-color, 3%) !default;
|
||||
|
||||
$body-text-color: $grey-dk-100 !default;
|
||||
$body-heading-color: $grey-dk-300 !default;
|
||||
$search-result-preview-color: $grey-dk-000 !default;
|
||||
@@ -85,9 +70,7 @@ $link-color: $purple-000 !default;
|
||||
$btn-primary-color: $purple-100 !default;
|
||||
$base-button-color: #f7f7f7 !default;
|
||||
|
||||
//
|
||||
// Spacing
|
||||
//
|
||||
|
||||
$spacing-unit: 1rem; // 1rem == 16px
|
||||
|
||||
@@ -104,7 +87,6 @@ $spacers: (
|
||||
sp-9: $spacing-unit * 3.5,
|
||||
sp-10: $spacing-unit * 4,
|
||||
) !default;
|
||||
|
||||
$sp-1: map-get($spacers, sp-1) !default; // 0.25 rem == 4px
|
||||
$sp-2: map-get($spacers, sp-2) !default; // 0.5 rem == 8px
|
||||
$sp-3: map-get($spacers, sp-3) !default; // 0.75 rem == 12px
|
||||
@@ -116,17 +98,13 @@ $sp-8: map-get($spacers, sp-8) !default; // 3 rem == 48px
|
||||
$sp-9: map-get($spacers, sp-9) !default; // 3.5 rem == 56px
|
||||
$sp-10: map-get($spacers, sp-10) !default; // 4 rem == 64px
|
||||
|
||||
//
|
||||
// Borders
|
||||
//
|
||||
|
||||
$border: 1px solid !default;
|
||||
$border-radius: 4px !default;
|
||||
$border-color: $grey-lt-100 !default;
|
||||
|
||||
//
|
||||
// Grid system
|
||||
//
|
||||
|
||||
$gutter-spacing: $sp-6 !default;
|
||||
$gutter-spacing-sm: $sp-4 !default;
|
||||
@@ -140,9 +118,7 @@ $header-height: 60px !default;
|
||||
$search-results-width: $content-width - $nav-width !default;
|
||||
$transition-duration: 400ms;
|
||||
|
||||
//
|
||||
// Media queries in pixels
|
||||
//
|
||||
|
||||
$media-queries: (
|
||||
xs: 320px,
|
||||
|
@@ -10,7 +10,7 @@
|
||||
$value: map-get($media-queries, $name);
|
||||
|
||||
// If the key exists in the map
|
||||
@if $value != null {
|
||||
@if $value {
|
||||
// Prints a media query based on the value
|
||||
@media (min-width: rem($value)) {
|
||||
@content;
|
||||
|
@@ -1,6 +1,4 @@
|
||||
//
|
||||
// Tables
|
||||
//
|
||||
// stylelint-disable max-nesting-depth, selector-no-type, selector-max-type
|
||||
|
||||
.table-wrapper {
|
||||
@@ -22,6 +20,7 @@ table {
|
||||
th,
|
||||
td {
|
||||
@include fs-3;
|
||||
|
||||
min-width: 120px;
|
||||
padding-top: $sp-2;
|
||||
padding-right: $sp-3;
|
||||
|
@@ -1,16 +1,17 @@
|
||||
//
|
||||
// Typography
|
||||
//
|
||||
// stylelint-disable primer/selector-no-utility, primer/no-override, selector-no-type, selector-max-type
|
||||
|
||||
// stylelint-disable selector-no-type, selector-max-type, selector-max-specificity, selector-max-id
|
||||
|
||||
h1,
|
||||
.text-alpha {
|
||||
@include fs-8;
|
||||
|
||||
font-weight: 300;
|
||||
}
|
||||
|
||||
h2,
|
||||
.text-beta {
|
||||
.text-beta,
|
||||
#toctitle {
|
||||
@include fs-6;
|
||||
}
|
||||
|
||||
@@ -22,6 +23,7 @@ h3,
|
||||
h4,
|
||||
.text-delta {
|
||||
@include fs-2;
|
||||
|
||||
font-weight: 400;
|
||||
text-transform: uppercase;
|
||||
letter-spacing: 0.1em;
|
||||
@@ -34,13 +36,11 @@ h4 code {
|
||||
h5,
|
||||
.text-epsilon {
|
||||
@include fs-3;
|
||||
color: $grey-dk-200;
|
||||
}
|
||||
|
||||
h6,
|
||||
.text-zeta {
|
||||
@include fs-2;
|
||||
color: $grey-dk-200;
|
||||
}
|
||||
|
||||
.text-small {
|
||||
|
@@ -1,6 +1,4 @@
|
||||
//
|
||||
// Utility classes for colors
|
||||
//
|
||||
|
||||
// Text colors
|
||||
|
||||
|
@@ -1,22 +1,23 @@
|
||||
// stylelint-disable primer/selector-no-utility, primer/no-override
|
||||
//
|
||||
// Utility classes for layout
|
||||
//
|
||||
|
||||
// Display
|
||||
|
||||
.d-block {
|
||||
display: block !important;
|
||||
}
|
||||
|
||||
.d-flex {
|
||||
display: flex !important;
|
||||
}
|
||||
|
||||
.d-inline {
|
||||
display: inline !important;
|
||||
}
|
||||
|
||||
.d-inline-block {
|
||||
display: inline-block !important;
|
||||
}
|
||||
|
||||
.d-none {
|
||||
display: none !important;
|
||||
}
|
||||
@@ -78,18 +79,23 @@
|
||||
.v-align-baseline {
|
||||
vertical-align: baseline !important;
|
||||
}
|
||||
|
||||
.v-align-bottom {
|
||||
vertical-align: bottom !important;
|
||||
}
|
||||
|
||||
.v-align-middle {
|
||||
vertical-align: middle !important;
|
||||
}
|
||||
|
||||
.v-align-text-bottom {
|
||||
vertical-align: text-bottom !important;
|
||||
}
|
||||
|
||||
.v-align-text-top {
|
||||
vertical-align: text-top !important;
|
||||
}
|
||||
|
||||
.v-align-top {
|
||||
vertical-align: top !important;
|
||||
}
|
||||
|
@@ -1,8 +1,6 @@
|
||||
//
|
||||
// Utility classes for lists
|
||||
//
|
||||
|
||||
// stylelint-disable primer/selector-no-utility, primer/no-override, selector-max-type
|
||||
// stylelint-disable selector-max-type
|
||||
|
||||
.list-style-none {
|
||||
padding: 0 !important;
|
||||
|
@@ -1,9 +1,6 @@
|
||||
//
|
||||
// Utility classes for margins and padding
|
||||
//
|
||||
|
||||
// scss-lint:disable SpaceAfterPropertyName
|
||||
// stylelint-disable block-opening-brace-space-after, block-opening-brace-space-before, primer/selector-no-utility, primer/no-override
|
||||
// stylelint-disable block-opening-brace-space-after, block-opening-brace-space-before
|
||||
|
||||
// Margin spacer utilities
|
||||
|
||||
|
@@ -1,8 +1,4 @@
|
||||
//
|
||||
// Utility classes for typography
|
||||
//
|
||||
|
||||
// stylelint-disable primer/selector-no-utility, primer/no-override
|
||||
|
||||
.fs-1 {
|
||||
@include fs-1;
|
||||
@@ -87,5 +83,3 @@
|
||||
.text-uppercase {
|
||||
text-transform: uppercase !important;
|
||||
}
|
||||
|
||||
// stylelint-enable primer/selector-no-utility
|
||||
|
21
_sass/vendor/OneDarkJekyll/LICENSE
vendored
Normal file
21
_sass/vendor/OneDarkJekyll/LICENSE
vendored
Normal file
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2016 Mihály Gyöngyösi
|
||||
|
||||
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.
|
25
_sass/vendor/OneDarkJekyll/README.md
vendored
Normal file
25
_sass/vendor/OneDarkJekyll/README.md
vendored
Normal file
@@ -0,0 +1,25 @@
|
||||
# OneDarkJekyll
|
||||
|
||||
*Use Atom's One Dark syntax colors in your Jekyll powered blog!*
|
||||
|
||||
It's LESS file which can be compiled to a - Pygments, Rouge compatible - stylesheet from Atom editor's One Dark syntax theme (and any theme based on it, for example One Dark Vivid, Firewatch, etc.).
|
||||
|
||||
Download the stylesheet files or compile a new one from any Atom syntax theme which based on One Dark (the variable names in `colors.less` must match with One Dark's)
|
||||
|
||||
## Create a new syntax stylesheet
|
||||
|
||||
1. `npm install -g less less-plugin-clean-css`
|
||||
2. Clone this repository
|
||||
3. Download the `colors.css` file from the syntax theme's repository (for example https://github.com/atom/one-dark-syntax/blob/master/styles/colors.less in case of One-Dark)
|
||||
4. Put the previously downloaded file next to `syntax.less`
|
||||
5. Run `lessc syntax.less syntax.css --clean-css`
|
||||
6. Use the `syntax.css`
|
||||
|
||||
It's not final and in case you find any error/improvement feel free to create a PR. :)
|
||||
|
||||
----
|
||||
|
||||
# UPDATES FOR USE IN JUST-THE-DOCS:
|
||||
|
||||
1. Layout added in `*.css`
|
||||
2. Renamed `*.css` to `*.scss`
|
30
_sass/vendor/OneDarkJekyll/colors.less
vendored
Normal file
30
_sass/vendor/OneDarkJekyll/colors.less
vendored
Normal file
@@ -0,0 +1,30 @@
|
||||
// Config -----------------------------------
|
||||
@syntax-hue: 220;
|
||||
@syntax-saturation: 13%;
|
||||
@syntax-brightness: 18%;
|
||||
|
||||
|
||||
// Monochrome -----------------------------------
|
||||
@mono-1: hsl(@syntax-hue, 14%, 71%); // default text
|
||||
@mono-2: hsl(@syntax-hue, 9%, 55%);
|
||||
@mono-3: hsl(@syntax-hue, 10%, 40%);
|
||||
|
||||
// Colors -----------------------------------
|
||||
@hue-1: hsl(187, 47%, 55%); // <-cyan
|
||||
@hue-2: hsl(207, 82%, 66%); // <-blue
|
||||
@hue-3: hsl(286, 60%, 67%); // <-purple
|
||||
@hue-4: hsl( 95, 38%, 62%); // <-green
|
||||
|
||||
@hue-5: hsl(355, 65%, 65%); // <-red 1
|
||||
@hue-5-2: hsl( 5, 48%, 51%); // <-red 2
|
||||
|
||||
@hue-6: hsl( 29, 54%, 61%); // <-orange 1
|
||||
@hue-6-2: hsl( 39, 67%, 69%); // <-orange 2
|
||||
|
||||
|
||||
// Base colors -----------------------------------
|
||||
@syntax-fg: @mono-1;
|
||||
@syntax-bg: hsl(@syntax-hue, @syntax-saturation, @syntax-brightness);
|
||||
@syntax-gutter: darken(@syntax-fg, 26%);
|
||||
@syntax-guide: fade(@syntax-fg, 15%);
|
||||
@syntax-accent: hsl(@syntax-hue, 100%, 66% );
|
200
_sass/vendor/OneDarkJekyll/syntax-firewatch-green.scss
vendored
Normal file
200
_sass/vendor/OneDarkJekyll/syntax-firewatch-green.scss
vendored
Normal file
@@ -0,0 +1,200 @@
|
||||
.highlight,
|
||||
pre.highlight {
|
||||
background: #282c34;
|
||||
color: #abb2bf;
|
||||
}
|
||||
.highlight pre {
|
||||
background: #282c34;
|
||||
}
|
||||
.highlight .hll {
|
||||
background: #282c34;
|
||||
}
|
||||
.highlight .c {
|
||||
color: #5c6370;
|
||||
font-style: italic;
|
||||
}
|
||||
.highlight .err {
|
||||
color: #960050;
|
||||
background-color: #1e0010;
|
||||
}
|
||||
.highlight .k {
|
||||
color: #5ba473;
|
||||
}
|
||||
.highlight .l {
|
||||
color: #c8ae9d;
|
||||
}
|
||||
.highlight .n {
|
||||
color: #abb2bf;
|
||||
}
|
||||
.highlight .o {
|
||||
color: #abb2bf;
|
||||
}
|
||||
.highlight .p {
|
||||
color: #abb2bf;
|
||||
}
|
||||
.highlight .cm {
|
||||
color: #5c6370;
|
||||
font-style: italic;
|
||||
}
|
||||
.highlight .cp {
|
||||
color: #5c6370;
|
||||
font-style: italic;
|
||||
}
|
||||
.highlight .c1 {
|
||||
color: #5c6370;
|
||||
font-style: italic;
|
||||
}
|
||||
.highlight .cs {
|
||||
color: #5c6370;
|
||||
font-style: italic;
|
||||
}
|
||||
.highlight .ge {
|
||||
font-style: italic;
|
||||
}
|
||||
.highlight .gs {
|
||||
font-weight: 700;
|
||||
}
|
||||
.highlight .kc {
|
||||
color: #5ba473;
|
||||
}
|
||||
.highlight .kd {
|
||||
color: #5ba473;
|
||||
}
|
||||
.highlight .kn {
|
||||
color: #5ba473;
|
||||
}
|
||||
.highlight .kp {
|
||||
color: #5ba473;
|
||||
}
|
||||
.highlight .kr {
|
||||
color: #5ba473;
|
||||
}
|
||||
.highlight .kt {
|
||||
color: #5ba473;
|
||||
}
|
||||
.highlight .ld {
|
||||
color: #c8ae9d;
|
||||
}
|
||||
.highlight .m {
|
||||
color: #d19a66;
|
||||
}
|
||||
.highlight .s {
|
||||
color: #c8ae9d;
|
||||
}
|
||||
.highlight .na {
|
||||
color: #d19a66;
|
||||
}
|
||||
.highlight .nb {
|
||||
color: #e5c07b;
|
||||
}
|
||||
.highlight .nc {
|
||||
color: #e5c07b;
|
||||
}
|
||||
.highlight .no {
|
||||
color: #e5c07b;
|
||||
}
|
||||
.highlight .nd {
|
||||
color: #e5c07b;
|
||||
}
|
||||
.highlight .ni {
|
||||
color: #e5c07b;
|
||||
}
|
||||
.highlight .ne {
|
||||
color: #e5c07b;
|
||||
}
|
||||
.highlight .nf {
|
||||
color: #abb2bf;
|
||||
}
|
||||
.highlight .nl {
|
||||
color: #e5c07b;
|
||||
}
|
||||
.highlight .nn {
|
||||
color: #abb2bf;
|
||||
}
|
||||
.highlight .nx {
|
||||
color: #abb2bf;
|
||||
}
|
||||
.highlight .py {
|
||||
color: #e5c07b;
|
||||
}
|
||||
.highlight .nt {
|
||||
color: #77b181;
|
||||
}
|
||||
.highlight .nv {
|
||||
color: #e5c07b;
|
||||
}
|
||||
.highlight .ow {
|
||||
font-weight: 700;
|
||||
}
|
||||
.highlight .w {
|
||||
color: #f8f8f2;
|
||||
}
|
||||
.highlight .mf {
|
||||
color: #d19a66;
|
||||
}
|
||||
.highlight .mh {
|
||||
color: #d19a66;
|
||||
}
|
||||
.highlight .mi {
|
||||
color: #d19a66;
|
||||
}
|
||||
.highlight .mo {
|
||||
color: #d19a66;
|
||||
}
|
||||
.highlight .sb {
|
||||
color: #c8ae9d;
|
||||
}
|
||||
.highlight .sc {
|
||||
color: #c8ae9d;
|
||||
}
|
||||
.highlight .sd {
|
||||
color: #c8ae9d;
|
||||
}
|
||||
.highlight .s2 {
|
||||
color: #c8ae9d;
|
||||
}
|
||||
.highlight .se {
|
||||
color: #c8ae9d;
|
||||
}
|
||||
.highlight .sh {
|
||||
color: #c8ae9d;
|
||||
}
|
||||
.highlight .si {
|
||||
color: #c8ae9d;
|
||||
}
|
||||
.highlight .sx {
|
||||
color: #c8ae9d;
|
||||
}
|
||||
.highlight .sr {
|
||||
color: #56b6c2;
|
||||
}
|
||||
.highlight .s1 {
|
||||
color: #c8ae9d;
|
||||
}
|
||||
.highlight .ss {
|
||||
color: #56b6c2;
|
||||
}
|
||||
.highlight .bp {
|
||||
color: #e5c07b;
|
||||
}
|
||||
.highlight .vc {
|
||||
color: #e5c07b;
|
||||
}
|
||||
.highlight .vg {
|
||||
color: #e5c07b;
|
||||
}
|
||||
.highlight .vi {
|
||||
color: #77b181;
|
||||
}
|
||||
.highlight .il {
|
||||
color: #d19a66;
|
||||
}
|
||||
.highlight .gu {
|
||||
color: #75715e;
|
||||
}
|
||||
.highlight .gd {
|
||||
color: #f92672;
|
||||
}
|
||||
.highlight .gi {
|
||||
color: #a6e22e;
|
||||
}
|
200
_sass/vendor/OneDarkJekyll/syntax-firewatch.scss
vendored
Normal file
200
_sass/vendor/OneDarkJekyll/syntax-firewatch.scss
vendored
Normal file
@@ -0,0 +1,200 @@
|
||||
.highlight,
|
||||
pre.highlight {
|
||||
background: #282c34;
|
||||
color: #abb2bf;
|
||||
}
|
||||
.highlight pre {
|
||||
background: #282c34;
|
||||
}
|
||||
.highlight .hll {
|
||||
background: #282c34;
|
||||
}
|
||||
.highlight .c {
|
||||
color: #5c6370;
|
||||
font-style: italic;
|
||||
}
|
||||
.highlight .err {
|
||||
color: #960050;
|
||||
background-color: #1e0010;
|
||||
}
|
||||
.highlight .k {
|
||||
color: #dd672c;
|
||||
}
|
||||
.highlight .l {
|
||||
color: #c8ae9d;
|
||||
}
|
||||
.highlight .n {
|
||||
color: #abb2bf;
|
||||
}
|
||||
.highlight .o {
|
||||
color: #abb2bf;
|
||||
}
|
||||
.highlight .p {
|
||||
color: #abb2bf;
|
||||
}
|
||||
.highlight .cm {
|
||||
color: #5c6370;
|
||||
font-style: italic;
|
||||
}
|
||||
.highlight .cp {
|
||||
color: #5c6370;
|
||||
font-style: italic;
|
||||
}
|
||||
.highlight .c1 {
|
||||
color: #5c6370;
|
||||
font-style: italic;
|
||||
}
|
||||
.highlight .cs {
|
||||
color: #5c6370;
|
||||
font-style: italic;
|
||||
}
|
||||
.highlight .ge {
|
||||
font-style: italic;
|
||||
}
|
||||
.highlight .gs {
|
||||
font-weight: 700;
|
||||
}
|
||||
.highlight .kc {
|
||||
color: #dd672c;
|
||||
}
|
||||
.highlight .kd {
|
||||
color: #dd672c;
|
||||
}
|
||||
.highlight .kn {
|
||||
color: #dd672c;
|
||||
}
|
||||
.highlight .kp {
|
||||
color: #dd672c;
|
||||
}
|
||||
.highlight .kr {
|
||||
color: #dd672c;
|
||||
}
|
||||
.highlight .kt {
|
||||
color: #dd672c;
|
||||
}
|
||||
.highlight .ld {
|
||||
color: #c8ae9d;
|
||||
}
|
||||
.highlight .m {
|
||||
color: #d19a66;
|
||||
}
|
||||
.highlight .s {
|
||||
color: #c8ae9d;
|
||||
}
|
||||
.highlight .na {
|
||||
color: #d19a66;
|
||||
}
|
||||
.highlight .nb {
|
||||
color: #e5c07b;
|
||||
}
|
||||
.highlight .nc {
|
||||
color: #e5c07b;
|
||||
}
|
||||
.highlight .no {
|
||||
color: #e5c07b;
|
||||
}
|
||||
.highlight .nd {
|
||||
color: #e5c07b;
|
||||
}
|
||||
.highlight .ni {
|
||||
color: #e5c07b;
|
||||
}
|
||||
.highlight .ne {
|
||||
color: #e5c07b;
|
||||
}
|
||||
.highlight .nf {
|
||||
color: #abb2bf;
|
||||
}
|
||||
.highlight .nl {
|
||||
color: #e5c07b;
|
||||
}
|
||||
.highlight .nn {
|
||||
color: #abb2bf;
|
||||
}
|
||||
.highlight .nx {
|
||||
color: #abb2bf;
|
||||
}
|
||||
.highlight .py {
|
||||
color: #e5c07b;
|
||||
}
|
||||
.highlight .nt {
|
||||
color: #e06c75;
|
||||
}
|
||||
.highlight .nv {
|
||||
color: #e5c07b;
|
||||
}
|
||||
.highlight .ow {
|
||||
font-weight: 700;
|
||||
}
|
||||
.highlight .w {
|
||||
color: #f8f8f2;
|
||||
}
|
||||
.highlight .mf {
|
||||
color: #d19a66;
|
||||
}
|
||||
.highlight .mh {
|
||||
color: #d19a66;
|
||||
}
|
||||
.highlight .mi {
|
||||
color: #d19a66;
|
||||
}
|
||||
.highlight .mo {
|
||||
color: #d19a66;
|
||||
}
|
||||
.highlight .sb {
|
||||
color: #c8ae9d;
|
||||
}
|
||||
.highlight .sc {
|
||||
color: #c8ae9d;
|
||||
}
|
||||
.highlight .sd {
|
||||
color: #c8ae9d;
|
||||
}
|
||||
.highlight .s2 {
|
||||
color: #c8ae9d;
|
||||
}
|
||||
.highlight .se {
|
||||
color: #c8ae9d;
|
||||
}
|
||||
.highlight .sh {
|
||||
color: #c8ae9d;
|
||||
}
|
||||
.highlight .si {
|
||||
color: #c8ae9d;
|
||||
}
|
||||
.highlight .sx {
|
||||
color: #c8ae9d;
|
||||
}
|
||||
.highlight .sr {
|
||||
color: #56b6c2;
|
||||
}
|
||||
.highlight .s1 {
|
||||
color: #c8ae9d;
|
||||
}
|
||||
.highlight .ss {
|
||||
color: #56b6c2;
|
||||
}
|
||||
.highlight .bp {
|
||||
color: #e5c07b;
|
||||
}
|
||||
.highlight .vc {
|
||||
color: #e5c07b;
|
||||
}
|
||||
.highlight .vg {
|
||||
color: #e5c07b;
|
||||
}
|
||||
.highlight .vi {
|
||||
color: #e06c75;
|
||||
}
|
||||
.highlight .il {
|
||||
color: #d19a66;
|
||||
}
|
||||
.highlight .gu {
|
||||
color: #75715e;
|
||||
}
|
||||
.highlight .gd {
|
||||
color: #f92672;
|
||||
}
|
||||
.highlight .gi {
|
||||
color: #a6e22e;
|
||||
}
|
200
_sass/vendor/OneDarkJekyll/syntax-one-dark-vivid.scss
vendored
Normal file
200
_sass/vendor/OneDarkJekyll/syntax-one-dark-vivid.scss
vendored
Normal file
@@ -0,0 +1,200 @@
|
||||
.highlight,
|
||||
pre.highlight {
|
||||
background: #31343f;
|
||||
color: #dee2f7;
|
||||
}
|
||||
.highlight pre {
|
||||
background: #31343f;
|
||||
}
|
||||
.highlight .hll {
|
||||
background: #31343f;
|
||||
}
|
||||
.highlight .c {
|
||||
color: #63677e;
|
||||
font-style: italic;
|
||||
}
|
||||
.highlight .err {
|
||||
color: #960050;
|
||||
background-color: #1e0010;
|
||||
}
|
||||
.highlight .k {
|
||||
color: #e19ef5;
|
||||
}
|
||||
.highlight .l {
|
||||
color: #a3eea0;
|
||||
}
|
||||
.highlight .n {
|
||||
color: #dee2f7;
|
||||
}
|
||||
.highlight .o {
|
||||
color: #dee2f7;
|
||||
}
|
||||
.highlight .p {
|
||||
color: #dee2f7;
|
||||
}
|
||||
.highlight .cm {
|
||||
color: #63677e;
|
||||
font-style: italic;
|
||||
}
|
||||
.highlight .cp {
|
||||
color: #63677e;
|
||||
font-style: italic;
|
||||
}
|
||||
.highlight .c1 {
|
||||
color: #63677e;
|
||||
font-style: italic;
|
||||
}
|
||||
.highlight .cs {
|
||||
color: #63677e;
|
||||
font-style: italic;
|
||||
}
|
||||
.highlight .ge {
|
||||
font-style: italic;
|
||||
}
|
||||
.highlight .gs {
|
||||
font-weight: 700;
|
||||
}
|
||||
.highlight .kc {
|
||||
color: #e19ef5;
|
||||
}
|
||||
.highlight .kd {
|
||||
color: #e19ef5;
|
||||
}
|
||||
.highlight .kn {
|
||||
color: #e19ef5;
|
||||
}
|
||||
.highlight .kp {
|
||||
color: #e19ef5;
|
||||
}
|
||||
.highlight .kr {
|
||||
color: #e19ef5;
|
||||
}
|
||||
.highlight .kt {
|
||||
color: #e19ef5;
|
||||
}
|
||||
.highlight .ld {
|
||||
color: #a3eea0;
|
||||
}
|
||||
.highlight .m {
|
||||
color: #eddc96;
|
||||
}
|
||||
.highlight .s {
|
||||
color: #a3eea0;
|
||||
}
|
||||
.highlight .na {
|
||||
color: #eddc96;
|
||||
}
|
||||
.highlight .nb {
|
||||
color: #fdce68;
|
||||
}
|
||||
.highlight .nc {
|
||||
color: #fdce68;
|
||||
}
|
||||
.highlight .no {
|
||||
color: #fdce68;
|
||||
}
|
||||
.highlight .nd {
|
||||
color: #fdce68;
|
||||
}
|
||||
.highlight .ni {
|
||||
color: #fdce68;
|
||||
}
|
||||
.highlight .ne {
|
||||
color: #fdce68;
|
||||
}
|
||||
.highlight .nf {
|
||||
color: #dee2f7;
|
||||
}
|
||||
.highlight .nl {
|
||||
color: #fdce68;
|
||||
}
|
||||
.highlight .nn {
|
||||
color: #dee2f7;
|
||||
}
|
||||
.highlight .nx {
|
||||
color: #dee2f7;
|
||||
}
|
||||
.highlight .py {
|
||||
color: #fdce68;
|
||||
}
|
||||
.highlight .nt {
|
||||
color: #f9867b;
|
||||
}
|
||||
.highlight .nv {
|
||||
color: #fdce68;
|
||||
}
|
||||
.highlight .ow {
|
||||
font-weight: 700;
|
||||
}
|
||||
.highlight .w {
|
||||
color: #f8f8f2;
|
||||
}
|
||||
.highlight .mf {
|
||||
color: #eddc96;
|
||||
}
|
||||
.highlight .mh {
|
||||
color: #eddc96;
|
||||
}
|
||||
.highlight .mi {
|
||||
color: #eddc96;
|
||||
}
|
||||
.highlight .mo {
|
||||
color: #eddc96;
|
||||
}
|
||||
.highlight .sb {
|
||||
color: #a3eea0;
|
||||
}
|
||||
.highlight .sc {
|
||||
color: #a3eea0;
|
||||
}
|
||||
.highlight .sd {
|
||||
color: #a3eea0;
|
||||
}
|
||||
.highlight .s2 {
|
||||
color: #a3eea0;
|
||||
}
|
||||
.highlight .se {
|
||||
color: #a3eea0;
|
||||
}
|
||||
.highlight .sh {
|
||||
color: #a3eea0;
|
||||
}
|
||||
.highlight .si {
|
||||
color: #a3eea0;
|
||||
}
|
||||
.highlight .sx {
|
||||
color: #a3eea0;
|
||||
}
|
||||
.highlight .sr {
|
||||
color: #7be2f9;
|
||||
}
|
||||
.highlight .s1 {
|
||||
color: #a3eea0;
|
||||
}
|
||||
.highlight .ss {
|
||||
color: #7be2f9;
|
||||
}
|
||||
.highlight .bp {
|
||||
color: #fdce68;
|
||||
}
|
||||
.highlight .vc {
|
||||
color: #fdce68;
|
||||
}
|
||||
.highlight .vg {
|
||||
color: #fdce68;
|
||||
}
|
||||
.highlight .vi {
|
||||
color: #f9867b;
|
||||
}
|
||||
.highlight .il {
|
||||
color: #eddc96;
|
||||
}
|
||||
.highlight .gu {
|
||||
color: #75715e;
|
||||
}
|
||||
.highlight .gd {
|
||||
color: #f92672;
|
||||
}
|
||||
.highlight .gi {
|
||||
color: #a6e22e;
|
||||
}
|
200
_sass/vendor/OneDarkJekyll/syntax-one-dark.scss
vendored
Normal file
200
_sass/vendor/OneDarkJekyll/syntax-one-dark.scss
vendored
Normal file
@@ -0,0 +1,200 @@
|
||||
.highlight,
|
||||
pre.highlight {
|
||||
background: #282c34;
|
||||
color: #abb2bf;
|
||||
}
|
||||
.highlight pre {
|
||||
background: #282c34;
|
||||
}
|
||||
.highlight .hll {
|
||||
background: #282c34;
|
||||
}
|
||||
.highlight .c {
|
||||
color: #5c6370;
|
||||
font-style: italic;
|
||||
}
|
||||
.highlight .err {
|
||||
color: #960050;
|
||||
background-color: #1e0010;
|
||||
}
|
||||
.highlight .k {
|
||||
color: #c678dd;
|
||||
}
|
||||
.highlight .l {
|
||||
color: #98c379;
|
||||
}
|
||||
.highlight .n {
|
||||
color: #abb2bf;
|
||||
}
|
||||
.highlight .o {
|
||||
color: #abb2bf;
|
||||
}
|
||||
.highlight .p {
|
||||
color: #abb2bf;
|
||||
}
|
||||
.highlight .cm {
|
||||
color: #5c6370;
|
||||
font-style: italic;
|
||||
}
|
||||
.highlight .cp {
|
||||
color: #5c6370;
|
||||
font-style: italic;
|
||||
}
|
||||
.highlight .c1 {
|
||||
color: #5c6370;
|
||||
font-style: italic;
|
||||
}
|
||||
.highlight .cs {
|
||||
color: #5c6370;
|
||||
font-style: italic;
|
||||
}
|
||||
.highlight .ge {
|
||||
font-style: italic;
|
||||
}
|
||||
.highlight .gs {
|
||||
font-weight: 700;
|
||||
}
|
||||
.highlight .kc {
|
||||
color: #c678dd;
|
||||
}
|
||||
.highlight .kd {
|
||||
color: #c678dd;
|
||||
}
|
||||
.highlight .kn {
|
||||
color: #c678dd;
|
||||
}
|
||||
.highlight .kp {
|
||||
color: #c678dd;
|
||||
}
|
||||
.highlight .kr {
|
||||
color: #c678dd;
|
||||
}
|
||||
.highlight .kt {
|
||||
color: #c678dd;
|
||||
}
|
||||
.highlight .ld {
|
||||
color: #98c379;
|
||||
}
|
||||
.highlight .m {
|
||||
color: #d19a66;
|
||||
}
|
||||
.highlight .s {
|
||||
color: #98c379;
|
||||
}
|
||||
.highlight .na {
|
||||
color: #d19a66;
|
||||
}
|
||||
.highlight .nb {
|
||||
color: #e5c07b;
|
||||
}
|
||||
.highlight .nc {
|
||||
color: #e5c07b;
|
||||
}
|
||||
.highlight .no {
|
||||
color: #e5c07b;
|
||||
}
|
||||
.highlight .nd {
|
||||
color: #e5c07b;
|
||||
}
|
||||
.highlight .ni {
|
||||
color: #e5c07b;
|
||||
}
|
||||
.highlight .ne {
|
||||
color: #e5c07b;
|
||||
}
|
||||
.highlight .nf {
|
||||
color: #abb2bf;
|
||||
}
|
||||
.highlight .nl {
|
||||
color: #e5c07b;
|
||||
}
|
||||
.highlight .nn {
|
||||
color: #abb2bf;
|
||||
}
|
||||
.highlight .nx {
|
||||
color: #abb2bf;
|
||||
}
|
||||
.highlight .py {
|
||||
color: #e5c07b;
|
||||
}
|
||||
.highlight .nt {
|
||||
color: #e06c75;
|
||||
}
|
||||
.highlight .nv {
|
||||
color: #e5c07b;
|
||||
}
|
||||
.highlight .ow {
|
||||
font-weight: 700;
|
||||
}
|
||||
.highlight .w {
|
||||
color: #f8f8f2;
|
||||
}
|
||||
.highlight .mf {
|
||||
color: #d19a66;
|
||||
}
|
||||
.highlight .mh {
|
||||
color: #d19a66;
|
||||
}
|
||||
.highlight .mi {
|
||||
color: #d19a66;
|
||||
}
|
||||
.highlight .mo {
|
||||
color: #d19a66;
|
||||
}
|
||||
.highlight .sb {
|
||||
color: #98c379;
|
||||
}
|
||||
.highlight .sc {
|
||||
color: #98c379;
|
||||
}
|
||||
.highlight .sd {
|
||||
color: #98c379;
|
||||
}
|
||||
.highlight .s2 {
|
||||
color: #98c379;
|
||||
}
|
||||
.highlight .se {
|
||||
color: #98c379;
|
||||
}
|
||||
.highlight .sh {
|
||||
color: #98c379;
|
||||
}
|
||||
.highlight .si {
|
||||
color: #98c379;
|
||||
}
|
||||
.highlight .sx {
|
||||
color: #98c379;
|
||||
}
|
||||
.highlight .sr {
|
||||
color: #56b6c2;
|
||||
}
|
||||
.highlight .s1 {
|
||||
color: #98c379;
|
||||
}
|
||||
.highlight .ss {
|
||||
color: #56b6c2;
|
||||
}
|
||||
.highlight .bp {
|
||||
color: #e5c07b;
|
||||
}
|
||||
.highlight .vc {
|
||||
color: #e5c07b;
|
||||
}
|
||||
.highlight .vg {
|
||||
color: #e5c07b;
|
||||
}
|
||||
.highlight .vi {
|
||||
color: #e06c75;
|
||||
}
|
||||
.highlight .il {
|
||||
color: #d19a66;
|
||||
}
|
||||
.highlight .gu {
|
||||
color: #75715e;
|
||||
}
|
||||
.highlight .gd {
|
||||
color: #f92672;
|
||||
}
|
||||
.highlight .gi {
|
||||
color: #a6e22e;
|
||||
}
|
56
_sass/vendor/OneDarkJekyll/syntax-variables.less
vendored
Normal file
56
_sass/vendor/OneDarkJekyll/syntax-variables.less
vendored
Normal file
@@ -0,0 +1,56 @@
|
||||
@import "colors.less";
|
||||
|
||||
// Official Syntax Variables -----------------------------------
|
||||
|
||||
// General colors
|
||||
@syntax-text-color: @syntax-fg;
|
||||
@syntax-cursor-color: @syntax-accent;
|
||||
@syntax-selection-color: lighten(@syntax-background-color, 10%);
|
||||
@syntax-selection-flash-color: @syntax-accent;
|
||||
@syntax-background-color: @syntax-bg;
|
||||
|
||||
// Guide colors
|
||||
@syntax-wrap-guide-color: @syntax-guide;
|
||||
@syntax-indent-guide-color: @syntax-guide;
|
||||
@syntax-invisible-character-color: @syntax-guide;
|
||||
|
||||
// For find and replace markers
|
||||
@syntax-result-marker-color: fade(@syntax-accent, 24%);
|
||||
@syntax-result-marker-color-selected: @syntax-accent;
|
||||
|
||||
// Gutter colors
|
||||
@syntax-gutter-text-color: @syntax-gutter;
|
||||
@syntax-gutter-text-color-selected: @syntax-fg;
|
||||
@syntax-gutter-background-color: @syntax-bg; // unused
|
||||
@syntax-gutter-background-color-selected: lighten(@syntax-bg, 2%);
|
||||
|
||||
// Git colors - For git diff info. i.e. in the gutter
|
||||
@syntax-color-renamed: hsl(208, 100%, 60%);
|
||||
@syntax-color-added: hsl(150, 60%, 54%);
|
||||
@syntax-color-modified: hsl(40, 60%, 70%);
|
||||
@syntax-color-removed: hsl(0, 70%, 60%);
|
||||
|
||||
// For language entity colors
|
||||
@syntax-color-variable: @hue-5;
|
||||
@syntax-color-constant: @hue-6;
|
||||
@syntax-color-property: @syntax-fg;
|
||||
@syntax-color-value: @syntax-fg;
|
||||
@syntax-color-function: @hue-2;
|
||||
@syntax-color-method: @hue-2;
|
||||
@syntax-color-class: @hue-6-2;
|
||||
@syntax-color-keyword: @hue-3;
|
||||
@syntax-color-tag: @hue-5;
|
||||
@syntax-color-attribute: @hue-6;
|
||||
@syntax-color-import: @hue-3;
|
||||
@syntax-color-snippet: @hue-4;
|
||||
|
||||
|
||||
// Custom Syntax Variables -----------------------------------
|
||||
// Don't use in packages
|
||||
|
||||
@syntax-cursor-line: hsla(@syntax-hue, 100%, 80%, .04); // needs to be semi-transparent to show search results
|
||||
|
||||
@syntax-deprecated-fg: darken(@syntax-color-modified, 50%);
|
||||
@syntax-deprecated-bg: @syntax-color-modified;
|
||||
@syntax-illegal-fg: white;
|
||||
@syntax-illegal-bg: @syntax-color-removed;
|
93
_sass/vendor/OneDarkJekyll/syntax.less
vendored
Normal file
93
_sass/vendor/OneDarkJekyll/syntax.less
vendored
Normal file
@@ -0,0 +1,93 @@
|
||||
/*
|
||||
LESS for Pygments
|
||||
*/
|
||||
|
||||
@import "syntax-variables.less";
|
||||
|
||||
pre.highlight,
|
||||
.highlight {
|
||||
background: @syntax-bg;
|
||||
color: @mono-1;
|
||||
}
|
||||
.highlight {
|
||||
pre { background: @syntax-bg; }
|
||||
.hll { background: @syntax-bg; }
|
||||
.c { color: @mono-3; font-style: italic; } /* Comment */
|
||||
.err { color: @syntax-illegal-fg; background-color: @syntax-illegal-bg; } /* Error */
|
||||
.k { color: @hue-3; } /* Keyword */
|
||||
.l { color: @hue-4; } /* Literal */
|
||||
.n { color: @mono-1; } /* Name */
|
||||
.o { color: @mono-1; } /* Operator */
|
||||
.p { color: @mono-1; } /* Punctuation */
|
||||
.cm { color: @mono-3; font-style: italic; } /* Comment.Multiline */
|
||||
.cp { color: @mono-3; font-style: italic; } /* Comment.Preproc */
|
||||
.c1 { color: @mono-3; font-style: italic; } /* Comment.Single */
|
||||
.cs { color: @mono-3; font-style: italic; } /* Comment.Special */
|
||||
.ge { font-style: italic } /* Generic.Emph */
|
||||
.gs { font-weight: bold } /* Generic.Strong */
|
||||
.kc { color: @hue-3; } /* Keyword.Constant */
|
||||
.kd { color: @hue-3; } /* Keyword.Declaration */
|
||||
.kn { color: @hue-3; } /* Keyword.Namespace */
|
||||
.kp { color: @hue-3; } /* Keyword.Pseudo */
|
||||
.kr { color: @hue-3; } /* Keyword.Reserved */
|
||||
.kt { color: @hue-3; } /* Keyword.Type */
|
||||
.ld { color: @hue-4; } /* Literal.Date */
|
||||
.m { color: @hue-6; } /* Literal.Number */
|
||||
.s { color: @hue-4; } /* Literal.String */
|
||||
.na { color: @hue-6; } /* Name.Attribute */
|
||||
.nb { color: @hue-6-2; } /* Name.Builtin */
|
||||
.nc { color: @hue-6-2; } /* Name.Class */
|
||||
.no { color: @hue-6-2; } /* Name.Constant */
|
||||
.nd { color: @hue-6-2; } /* Name.Decorator */
|
||||
.ni { color: @hue-6-2; } /* Name.Entity */
|
||||
.ne { color: @hue-6-2; } /* Name.Exception */
|
||||
.nf { color: @mono-1; } /* Name.Function */
|
||||
.nl { color: @hue-6-2; } /* Name.Label */
|
||||
.nn { color: @mono-1; } /* Name.Namespace */
|
||||
.nx { color: @mono-1; } /* Name.Other */
|
||||
.py { color: @hue-6-2; } /* Name.Property */
|
||||
.nt { color: @hue-5; } /* Name.Tag */
|
||||
.nv { color: @hue-6-2; } /* Name.Variable */
|
||||
.ow { font-weight: bold; } /* Operator.Word */
|
||||
.w { color: #f8f8f2 } /* Text.Whitespace */
|
||||
.mf { color: @hue-6; } /* Literal.Number.Float */
|
||||
.mh { color: @hue-6; } /* Literal.Number.Hex */
|
||||
.mi { color: @hue-6; } /* Literal.Number.Integer */
|
||||
.mo { color: @hue-6; } /* Literal.Number.Oct */
|
||||
.sb { color: @hue-4; } /* Literal.String.Backtick */
|
||||
.sc { color: @hue-4; } /* Literal.String.Char */
|
||||
.sd { color: @hue-4; } /* Literal.String.Doc */
|
||||
.s2 { color: @hue-4; } /* Literal.String.Double */
|
||||
.se { color: @hue-4; } /* Literal.String.Escape */
|
||||
.sh { color: @hue-4; } /* Literal.String.Heredoc */
|
||||
.si { color: @hue-4; } /* Literal.String.Interpol */
|
||||
.sx { color: @hue-4; } /* Literal.String.Other */
|
||||
.sr { color: @hue-1; } /* Literal.String.Regex */
|
||||
.s1 { color: @hue-4; } /* Literal.String.Single */
|
||||
.ss { color: @hue-1; } /* Literal.String.Symbol */
|
||||
.bp { color: @hue-6-2; } /* Name.Builtin.Pseudo */
|
||||
.vc { color: @hue-6-2; } /* Name.Variable.Class */
|
||||
.vg { color: @hue-6-2; } /* Name.Variable.Global */
|
||||
.vi { color: @hue-5; } /* Name.Variable.Instance */
|
||||
.il { color: @hue-6; } /* Literal.Number.Integer.Long */
|
||||
|
||||
.gh { } /* Generic Heading & Diff Header */
|
||||
.gu { color: #75715e; } /* Generic.Subheading & Diff Unified/Comment? */
|
||||
.gd { color: @syntax-color-removed; } /* Generic.Deleted & Diff Deleted */
|
||||
.gi { color: @syntax-color-added; } /* Generic.Inserted & Diff Inserted */
|
||||
|
||||
::selection { background-color: @syntax-selection-color; }
|
||||
|
||||
.language-json {
|
||||
.w + .s2 { color: @hue-5; }
|
||||
.kc { color: @hue-1; }
|
||||
}
|
||||
|
||||
.language-python {
|
||||
// python related modifications
|
||||
}
|
||||
|
||||
.language-csharp {
|
||||
// csharp related modifications
|
||||
}
|
||||
}
|
6
_sass/vendor/normalize.scss/normalize.scss
vendored
6
_sass/vendor/normalize.scss/normalize.scss
vendored
@@ -174,7 +174,8 @@ textarea {
|
||||
*/
|
||||
|
||||
button,
|
||||
input { /* 1 */
|
||||
input {
|
||||
/* 1 */
|
||||
overflow: visible;
|
||||
}
|
||||
|
||||
@@ -184,7 +185,8 @@ input { /* 1 */
|
||||
*/
|
||||
|
||||
button,
|
||||
select { /* 1 */
|
||||
select {
|
||||
/* 1 */
|
||||
text-transform: none;
|
||||
}
|
||||
|
||||
|
BIN
assets/images/large-image.jpg
Normal file
BIN
assets/images/large-image.jpg
Normal file
Binary file not shown.
After Width: | Height: | Size: 532 KiB |
BIN
assets/images/small-image.jpg
Normal file
BIN
assets/images/small-image.jpg
Normal file
Binary file not shown.
After Width: | Height: | Size: 43 KiB |
@@ -69,7 +69,7 @@ function initNav() {
|
||||
|
||||
function initSearch() {
|
||||
var request = new XMLHttpRequest();
|
||||
request.open('GET', '{{ "assets/js/search-data.json" | absolute_url }}', true);
|
||||
request.open('GET', '{{ "assets/js/search-data.json" | relative_url }}', true);
|
||||
|
||||
request.onload = function(){
|
||||
if (request.status >= 200 && request.status < 400) {
|
||||
@@ -454,7 +454,19 @@ jtd.getTheme = function() {
|
||||
|
||||
jtd.setTheme = function(theme) {
|
||||
var cssFile = document.querySelector('[rel="stylesheet"]');
|
||||
cssFile.setAttribute('href', '{{ "assets/css/just-the-docs-" | absolute_url }}' + theme + '.css');
|
||||
cssFile.setAttribute('href', '{{ "assets/css/just-the-docs-" | relative_url }}' + theme + '.css');
|
||||
}
|
||||
|
||||
// Scroll site-nav to ensure the link to the current page is visible
|
||||
|
||||
function scrollNav() {
|
||||
const href = document.location.pathname;
|
||||
const siteNav = document.getElementById('site-nav');
|
||||
const targetLink = siteNav.querySelector('a[href="' + href + '"], a[href="' + href + '/"]');
|
||||
if(targetLink){
|
||||
const rect = targetLink.getBoundingClientRect();
|
||||
siteNav.scrollBy(0, rect.top - 3*rect.height);
|
||||
}
|
||||
}
|
||||
|
||||
// Document ready
|
||||
@@ -464,6 +476,7 @@ jtd.onReady(function(){
|
||||
{%- if site.search_enabled != false %}
|
||||
initSearch();
|
||||
{%- endif %}
|
||||
scrollNav();
|
||||
});
|
||||
|
||||
})(window.jtd = window.jtd || {});
|
||||
|
@@ -3,7 +3,7 @@ permalink: /assets/js/search-data.json
|
||||
---
|
||||
{
|
||||
{%- assign i = 0 -%}
|
||||
{%- assign pages_array = '' | split: '' -%}
|
||||
{%- 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 -%}
|
||||
@@ -50,7 +50,7 @@ permalink: /assets/js/search-data.json
|
||||
"doc": {{ page.title | jsonify }},
|
||||
"title": {{ title | jsonify }},
|
||||
"content": {{ content | replace: '</h', ' . </h' | replace: '<hr', ' . <hr' | replace: '</p', ' . </p' | replace: '<ul', ' . <ul' | replace: '</ul', ' . </ul' | replace: '<ol', ' . <ol' | replace: '</ol', ' . </ol' | replace: '</tr', ' . </tr' | replace: '<li', ' | <li' | replace: '</li', ' | </li' | replace: '</td', ' | </td' | replace: '<td', ' | <td' | replace: '</th', ' | </th' | replace: '<th', ' | <th' | strip_html | remove: 'Table of contents' | normalize_whitespace | replace: '. . .', '.' | replace: '. .', '.' | replace: '| |', '|' | append: ' ' | jsonify }},
|
||||
"url": "{{ url | absolute_url }}",
|
||||
"url": "{{ url | relative_url }}",
|
||||
"relUrl": "{{ url }}"
|
||||
}
|
||||
{%- assign i = i | plus: 1 -%}
|
||||
@@ -61,7 +61,7 @@ permalink: /assets/js/search-data.json
|
||||
"doc": {{ page.title | jsonify }},
|
||||
"title": {{ page.title | jsonify }},
|
||||
"content": {{ parts[0] | replace: '</h', ' . </h' | replace: '<hr', ' . <hr' | replace: '</p', ' . </p' | replace: '<ul', ' . <ul' | replace: '</ul', ' . </ul' | replace: '<ol', ' . <ol' | replace: '</ol', ' . </ol' | replace: '</tr', ' . </tr' | replace: '<li', ' | <li' | replace: '</li', ' | </li' | replace: '</td', ' | </td' | replace: '<td', ' | <td' | replace: '</th', ' | </th' | replace: '<th', ' | <th' | strip_html | remove: 'Table of contents' | normalize_whitespace | replace: '. . .', '.' | replace: '. .', '.' | replace: '| |', '|' | append: ' ' | jsonify }},
|
||||
"url": "{{ page.url | absolute_url }}",
|
||||
"url": "{{ page.url | relative_url }}",
|
||||
"relUrl": "{{ page.url }}"
|
||||
}
|
||||
{%- assign i = i | plus: 1 -%}
|
||||
|
@@ -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,9 +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
|
||||
|
||||
@@ -62,13 +59,26 @@ search:
|
||||
button: false
|
||||
```
|
||||
|
||||
## Mermaid Diagrams
|
||||
|
||||
The minimum configuration requires the key for `version` ([from jsDelivr](https://cdn.jsdelivr.net/npm/mermaid/)) in `_config.yml`:
|
||||
|
||||
```yaml
|
||||
mermaid:
|
||||
# Version of mermaid library
|
||||
# Pick an available version from https://cdn.jsdelivr.net/npm/mermaid/
|
||||
version: "9.1.3"
|
||||
```
|
||||
|
||||
See [the Code documentation]({{ site.baseurl }}{% link docs/ui-components/code.md %}#mermaid-diagram-code-blocks) for more configuration options and information.
|
||||
|
||||
## Aux links
|
||||
|
||||
```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"
|
||||
|
||||
# Makes Aux links open in a new tab. Default is false
|
||||
aux_links_new_tab: false
|
||||
@@ -84,6 +94,11 @@ aux_links_new_tab: false
|
||||
heading_anchors: true
|
||||
```
|
||||
|
||||
## External navigation links
|
||||
|
||||
External links can be added to the navigation through the `nav_external_links` option.
|
||||
See [Navigation Structure]({{ site.baseurl }}{% link docs/navigation-structure.md %}#external-navigation-links) for more details.
|
||||
|
||||
## Footer content
|
||||
|
||||
```yaml
|
||||
@@ -91,7 +106,7 @@ heading_anchors: true
|
||||
# appears at the bottom of every page's main content
|
||||
# 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/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
|
||||
@@ -100,8 +115,8 @@ 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
|
||||
```
|
||||
@@ -111,7 +126,7 @@ _note: `footer_content` is deprecated, but still supported. For a better experie
|
||||
- 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
|
||||
|
||||
@@ -121,6 +136,7 @@ _note: `footer_content` is deprecated, but still supported. For a better experie
|
||||
# Color scheme supports "light" (default) and "dark"
|
||||
color_scheme: dark
|
||||
```
|
||||
|
||||
<button class="btn js-toggle-dark-mode">Preview dark color scheme</button>
|
||||
|
||||
<script>
|
||||
@@ -139,6 +155,59 @@ jtd.addEvent(toggleDarkMode, 'click', function(){
|
||||
|
||||
See [Customization]({{ site.baseurl }}{% link docs/customization.md %}) for more information.
|
||||
|
||||
## Callouts
|
||||
|
||||
To use this feature, you need to configure a `color` and (optionally) `title` for each kind of callout you want to use, e.g.:
|
||||
|
||||
```yaml
|
||||
callouts:
|
||||
warning:
|
||||
title: Warning
|
||||
color: red
|
||||
```
|
||||
|
||||
This uses the color `$red-000` for the background of the callout, and `$red-300` for the title and box decoration.[^dark] You can then style a paragraph as a `warning` callout like this:
|
||||
|
||||
```markdown
|
||||
{: .warning }
|
||||
A paragraph...
|
||||
```
|
||||
|
||||
[^dark]:
|
||||
If you use the `dark` color scheme, this callout uses `$red-300` for the background, and `$red-000` for the title.
|
||||
|
||||
The colors `grey-lt`, `grey-dk`, `purple`, `blue`, `green`, `yellow`, and `red` are predefined; to use a custom color, you need to define its `000` and `300` levels in your SCSS files. For example, to use `pink`, add the following to your `_sass/custom/custom.scss` file:
|
||||
|
||||
```scss
|
||||
$pink-000: #f77ef1;
|
||||
$pink-100: #f967f1;
|
||||
$pink-200: #e94ee1;
|
||||
$pink-300: #dd2cd4;
|
||||
```
|
||||
|
||||
You can override the default `opacity` of the background for a particular callout, e.g.:
|
||||
|
||||
```yaml
|
||||
callouts:
|
||||
custom:
|
||||
color: pink
|
||||
opacity: 0.3
|
||||
```
|
||||
|
||||
You can change the default opacity (`0.2`) for all callouts, e.g.:
|
||||
|
||||
```yaml
|
||||
callouts_opacity: 0.3
|
||||
```
|
||||
|
||||
You can also adjust the overall level of callouts.
|
||||
The value of `callouts_level` is either `quiet` or `loud`;
|
||||
`loud` increases the saturation and lightness of the backgrounds.
|
||||
The default level is `quiet` when using the `light` or custom color schemes,
|
||||
and `loud` when using the `dark color scheme.`
|
||||
|
||||
See [Callouts]({{ site.baseurl }}{% link docs/ui-components/callouts.md %}) for more information.
|
||||
|
||||
## Google Analytics
|
||||
|
||||
```yaml
|
||||
@@ -151,37 +220,44 @@ ga_tracking_anonymize_ip: true # Use GDPR compliant Google Analytics settings (t
|
||||
## 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.
|
||||
You can also use [Jekyll collections](https://jekyllrb.com/docs/collections/) which group documents semantically together.
|
||||
|
||||
For example, put all your test files in the `_tests` folder and create the `tests` collection:
|
||||
|
||||
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:
|
||||
# Define a collection named "tests", its documents reside in the "_tests" directory
|
||||
tests:
|
||||
permalink: "/:collection/:path/"
|
||||
output: true
|
||||
|
||||
just_the_docs:
|
||||
# Define which collections are used in just-the-docs
|
||||
collections:
|
||||
# Reference the "docs" collection
|
||||
docs:
|
||||
# Reference the "tests" collection
|
||||
tests:
|
||||
# Give the collection a name
|
||||
name: Documentation
|
||||
name: Tests
|
||||
# Exclude the collection from the navigation
|
||||
# Supports true or false (default)
|
||||
nav_exclude: false
|
||||
# nav_exclude: true
|
||||
# Fold the collection in the navigation
|
||||
# Supports true or false (default)
|
||||
# nav_fold: true
|
||||
# Exclude the collection from the search
|
||||
# Supports true or false (default)
|
||||
search_exclude: false
|
||||
# search_exclude: true
|
||||
```
|
||||
|
||||
The navigation for all your normal pages (if any) is displayed before those in collections.
|
||||
|
||||
You can reference multiple collections.
|
||||
This creates categories in the navigation with the configured names.
|
||||
|
||||
```yaml
|
||||
collections:
|
||||
docs:
|
||||
tests:
|
||||
permalink: "/:collection/:path/"
|
||||
output: true
|
||||
tutorials:
|
||||
@@ -190,9 +266,12 @@ collections:
|
||||
|
||||
just_the_docs:
|
||||
collections:
|
||||
docs:
|
||||
name: Documentation
|
||||
tests:
|
||||
name: Tests
|
||||
tutorials:
|
||||
name: Tutorials
|
||||
```
|
||||
|
||||
When *all* your pages are in a single collection, its name is not displayed.
|
||||
|
||||
The navigation for each collection is a separate name space for page titles: a page in one collection cannot be a child of a page in a different collection, or of a normal page.
|
||||
|
@@ -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:
|
||||
|
||||
@@ -67,12 +69,17 @@ For example, to change the link color from the purple default to blue, include t
|
||||
$link-color: $blue-000;
|
||||
```
|
||||
|
||||
Keep in mind that changing a variable will not automatically change the value of other variables that depend on it.
|
||||
For example, the default link color (`$link-color`) is set to `$purple-000`. However, redefining `$purple-000` in a custom color scheme will not automatically change `$link-color` to match it.
|
||||
Instead, each variable that relies on previously-cascaded values must be manually reimplemented by copying the dependent rules from `_variables.scss` — in this case, rewriting `$link-color: $purple-000;`.
|
||||
|
||||
_Note:_ Editing the variables directly in `_sass/support/variables.scss` is not recommended and can cause other dependencies to fail.
|
||||
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 +87,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 +98,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 +116,52 @@ 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;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Override includes
|
||||
|
||||
The site can be modified by overriding any of the custom [Jekyll includes](https://jekyllrb.com/docs/includes/) provided by default in the theme.
|
||||
|
||||
To do this, create an `_includes` directory and make a copy of the specific file you wish to modify. Any content added to this file will override the theme defaults. You can learn more about this process in the Jekyll docs for [Overriding theme defaults](https://jekyllrb.com/docs/themes/#overriding-theme-defaults).
|
||||
|
||||
The following includes were made available to you:
|
||||
|
||||
### Custom Footer
|
||||
|
||||
`_includes/footer_custom.html`
|
||||
|
||||
This content appears at the bottom of every page's main content. More info for this include can be found in the [Configuration - Footer content]({% link docs/configuration.md %}#footer-content).
|
||||
|
||||
### Custom Head
|
||||
|
||||
`_includes/head_custom.html`
|
||||
|
||||
Any HTML added to this file will be inserted before the closing `<head>` tag. This might include additional `<meta>`, `<link>`, or `<script>` tags.
|
||||
|
||||
#### Example
|
||||
|
||||
To add a custom favicon, create `_includes/head_custom.html` and add:
|
||||
```html
|
||||
<link rel="shortcut icon" type="image/png" href="{{site.baseurl}}/path/to/your/favicon.png">
|
||||
```
|
||||
|
||||
### Custom Header
|
||||
|
||||
`_includes/header_custom.html`
|
||||
|
||||
Content added to this file appears at the top of every page's main content between the site search and auxiliary links if they are enabled. If `search_enabled` were set to false and `aux_links` were removed, the content of `header_custom.html` would occupy the space at the top of every page.
|
||||
|
||||
### Custom Nav Footer
|
||||
|
||||
`_includes/nav_footer_custom.html`
|
||||
|
||||
Any content added to this file will appear at the bottom left of the page below the site's navigation. By default an attribution to Just the Docs is displayed which reads, `This site uses Just the Docs, a documentation theme for Jekyll.`.
|
||||
|
@@ -4,6 +4,22 @@ title: Markdown kitchen sink
|
||||
nav_order: 99
|
||||
---
|
||||
|
||||
<button class="btn js-toggle-dark-mode">Preview dark color scheme</button>
|
||||
|
||||
<script>
|
||||
const toggleDarkMode = document.querySelector('.js-toggle-dark-mode');
|
||||
|
||||
jtd.addEvent(toggleDarkMode, 'click', function(){
|
||||
if (jtd.getTheme() === 'dark') {
|
||||
jtd.setTheme('light');
|
||||
toggleDarkMode.textContent = 'Preview dark color scheme';
|
||||
} else {
|
||||
jtd.setTheme('dark');
|
||||
toggleDarkMode.textContent = 'Return to the light side';
|
||||
}
|
||||
});
|
||||
</script>
|
||||
|
||||
Text can be **bold**, _italic_, or ~~strikethrough~~.
|
||||
|
||||
[Link to another page](another-page).
|
||||
@@ -53,6 +69,12 @@ end
|
||||
|
||||
###### [](#header-6)Header 6
|
||||
|
||||
[This is a very long link which wraps and therefore doesn't overflow
|
||||
even when it comes at the beginning](.) of the line.
|
||||
|
||||
- [This is a very long link which wraps and therefore doesn't overflow the line
|
||||
when used first in an item ](.) in a list.
|
||||
|
||||
| head1 | head two | three |
|
||||
|:-------------|:------------------|:------|
|
||||
| ok | good swedish fish | nice |
|
||||
@@ -78,6 +100,24 @@ end
|
||||
1. Item three
|
||||
1. Item four
|
||||
|
||||
### And an ordered list, continued:
|
||||
|
||||
1. Item one
|
||||
1. Item two
|
||||
|
||||
Some text
|
||||
|
||||
{:style="counter-reset:none"}
|
||||
1. Item three
|
||||
1. Item four
|
||||
|
||||
### And an ordered list starting from 42:
|
||||
|
||||
{:style="counter-reset:step-counter 41"}
|
||||
1. Item 42
|
||||
1. Item 43
|
||||
1. Item 44
|
||||
|
||||
### And a nested list:
|
||||
|
||||
- level 1 item
|
||||
@@ -118,14 +158,62 @@ end
|
||||
- [ ] Hello, this is another TODO item
|
||||
- [x] Goodbye, this item is done
|
||||
|
||||
### Nesting task lists
|
||||
|
||||
- [ ] level 1 item (task)
|
||||
- [ ] level 2 item (task)
|
||||
- [ ] level 2 item (task)
|
||||
- [ ] level 1 item (task)
|
||||
- [ ] level 1 item (task)
|
||||
|
||||
### Nesting a ul in a task list
|
||||
|
||||
- [ ] level 1 item (task)
|
||||
- level 2 item (ul)
|
||||
- level 2 item (ul)
|
||||
- [ ] level 1 item (task)
|
||||
- [ ] level 1 item (task)
|
||||
|
||||
### Nesting a task list in a ul
|
||||
|
||||
- level 1 item (ul)
|
||||
- [ ] level 2 item (task)
|
||||
- [ ] level 2 item (task)
|
||||
- level 1 item (ul)
|
||||
- level 1 item (ul)
|
||||
|
||||
### Small image
|
||||
|
||||

|
||||

|
||||
|
||||
### Large image
|
||||
|
||||

|
||||

|
||||
|
||||
"[Wroclaw University Library digitizing rare archival texts](https://www.flickr.com/photos/97810305@N08/9401451269)" by [j_cadmus](https://www.flickr.com/photos/97810305@N08) is marked with [CC BY 2.0](https://creativecommons.org/licenses/by/2.0/?ref=openverse).
|
||||
|
||||
### Labels
|
||||
|
||||
I'm a label
|
||||
{: .label }
|
||||
|
||||
blue
|
||||
{: .label .label-blue }
|
||||
green
|
||||
{: .label .label-green }
|
||||
purple
|
||||
{: .label .label-purple }
|
||||
yellow
|
||||
{: .label .label-yellow }
|
||||
red
|
||||
{: .label .label-red }
|
||||
|
||||
**bold**
|
||||
{: .label }
|
||||
*italic*
|
||||
{: .label }
|
||||
***bold + italic***
|
||||
{: .label }
|
||||
|
||||
### Definition lists can be used with HTML syntax.
|
||||
|
||||
@@ -168,13 +256,61 @@ Term2
|
||||
|
||||
: Second description of Term1 and Term2,
|
||||
possibly more than one line
|
||||
|
||||
|
||||
### More code
|
||||
|
||||
```python{% raw %}
|
||||
def dump_args(func):
|
||||
"This decorator dumps out the arguments passed to a function before calling it"
|
||||
argnames = func.func_code.co_varnames[:func.func_code.co_argcount]
|
||||
fname = func.func_name
|
||||
def echo_func(*args,**kwargs):
|
||||
print fname, ":", ', '.join(
|
||||
'%s=%r' % entry
|
||||
for entry in zip(argnames,args) + kwargs.items())
|
||||
return func(*args, **kwargs)
|
||||
return echo_func
|
||||
|
||||
@dump_args
|
||||
def f1(a,b,c):
|
||||
print a + b + c
|
||||
|
||||
f1(1, 2, 3)
|
||||
|
||||
def precondition(precondition, use_conditions=DEFAULT_ON):
|
||||
return conditions(precondition, None, use_conditions)
|
||||
|
||||
def postcondition(postcondition, use_conditions=DEFAULT_ON):
|
||||
return conditions(None, postcondition, use_conditions)
|
||||
|
||||
class conditions(object):
|
||||
__slots__ = ('__precondition', '__postcondition')
|
||||
|
||||
def __init__(self, pre, post, use_conditions=DEFAULT_ON):
|
||||
if not use_conditions:
|
||||
pre, post = None, None
|
||||
|
||||
self.__precondition = pre
|
||||
self.__postcondition = post
|
||||
{% endraw %}```
|
||||
|
||||
```
|
||||
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.
|
||||
```
|
||||
|
||||
### Mermaid Diagrams
|
||||
|
||||
The following code is displayed as a diagram only when a `mermaid` key supplied in `_config.yml`.
|
||||
|
||||
```mermaid
|
||||
graph TD;
|
||||
A-->B;
|
||||
A-->C;
|
||||
B-->D;
|
||||
C-->D;
|
||||
```
|
||||
|
||||
|
||||
```
|
||||
The final element.
|
||||
```
|
||||
|
@@ -12,7 +12,7 @@ nav_order: 5
|
||||
Table of contents
|
||||
</summary>
|
||||
{: .text-delta }
|
||||
1. TOC
|
||||
- TOC
|
||||
{:toc}
|
||||
</details>
|
||||
|
||||
@@ -39,6 +39,7 @@ layout: default
|
||||
title: Customization
|
||||
nav_order: 4
|
||||
---
|
||||
|
||||
```
|
||||
|
||||
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.
|
||||
@@ -47,7 +48,7 @@ The parameter values can be numbers (integers, floats) and/or strings. When you
|
||||
|
||||
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.
|
||||
> _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.
|
||||
|
||||
---
|
||||
|
||||
@@ -64,11 +65,12 @@ 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 no `title` are automatically excluded from the navigation.
|
||||
|
||||
---
|
||||
|
||||
@@ -104,7 +106,8 @@ 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 }
|
||||
@@ -116,11 +119,13 @@ 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).
|
||||
@@ -135,10 +140,27 @@ 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.
|
||||
|
||||
### Ordering child pages
|
||||
|
||||
You can optionally add the following to the YAML front matter to change the default sort order of child pages from ascending to descending order:
|
||||
|
||||
- `child_nav_order: desc`
|
||||
|
||||
#### Example
|
||||
{: .no_toc }
|
||||
```yaml
|
||||
---
|
||||
layout: default
|
||||
title: Descending Child Pages
|
||||
child_nav_order: desc
|
||||
---
|
||||
```
|
||||
|
||||
### Auto-generating Table of Contents
|
||||
|
||||
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.
|
||||
@@ -154,9 +176,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.
|
||||
@@ -175,6 +199,7 @@ parent: UI Components
|
||||
nav_order: 2
|
||||
has_children: true
|
||||
---
|
||||
|
||||
```
|
||||
|
||||
```yaml
|
||||
@@ -185,6 +210,7 @@ parent: Buttons
|
||||
grand_parent: UI Components
|
||||
nav_order: 1
|
||||
---
|
||||
|
||||
```
|
||||
|
||||
This would create the following navigation structure:
|
||||
@@ -216,7 +242,26 @@ To add auxiliary links to your site (in the upper right on all pages), add it to
|
||||
# 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"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## External Navigation Links
|
||||
|
||||
To add external links to the navigation, add them to the `nav_external_links` [configuration]({{ site.baseurl }}{% link docs/configuration.md %}) option in your site's `_config.yml` file.
|
||||
External links will appear under all other items in the listing order.
|
||||
|
||||
#### Example
|
||||
|
||||
{: .no_toc }
|
||||
|
||||
```yaml
|
||||
# External navigation links
|
||||
nav_external_links:
|
||||
- title: Just the Docs on GitHub
|
||||
url: https://github.com/just-the-docs/just-the-docs
|
||||
hide_icon: false # set to true to hide the external link icon - defaults to false
|
||||
```
|
||||
|
||||
---
|
||||
@@ -239,7 +284,7 @@ To generate a Table of Contents on your docs pages, you can use the `{:toc}` met
|
||||
{: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).
|
||||
|
@@ -1,22 +0,0 @@
|
||||
---
|
||||
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...)
|
@@ -1,14 +0,0 @@
|
||||
---
|
||||
layout: default
|
||||
title: Tests for disambiguation A
|
||||
has_children: true
|
||||
---
|
||||
|
||||
# A
|
||||
|
||||
A top-level page
|
||||
|
||||
```yaml
|
||||
title: Tests for disambiguation A
|
||||
has_children: true
|
||||
```
|
@@ -1,14 +0,0 @@
|
||||
---
|
||||
layout: default
|
||||
title: Tests for disambiguation B
|
||||
has_children: true
|
||||
---
|
||||
|
||||
# B
|
||||
|
||||
A top-level page
|
||||
|
||||
```yaml
|
||||
title: Tests for disambiguation B
|
||||
has_children: true
|
||||
```
|
@@ -1,16 +0,0 @@
|
||||
---
|
||||
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
|
||||
```
|
@@ -1,16 +0,0 @@
|
||||
---
|
||||
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
|
||||
```
|
@@ -1,16 +0,0 @@
|
||||
---
|
||||
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
|
||||
```
|
@@ -1,16 +0,0 @@
|
||||
---
|
||||
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
|
||||
```
|
@@ -1,14 +0,0 @@
|
||||
---
|
||||
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.
|
@@ -1,13 +0,0 @@
|
||||
---
|
||||
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
|
||||
```
|
@@ -1,15 +0,0 @@
|
||||
---
|
||||
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
|
||||
```
|
@@ -1,17 +0,0 @@
|
||||
---
|
||||
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
|
||||
```
|
@@ -1,17 +0,0 @@
|
||||
---
|
||||
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
|
||||
```
|
@@ -1,15 +0,0 @@
|
||||
---
|
||||
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
|
||||
```
|
@@ -1,17 +0,0 @@
|
||||
---
|
||||
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
|
||||
```
|
@@ -1,17 +0,0 @@
|
||||
---
|
||||
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
|
||||
```
|
@@ -1,13 +0,0 @@
|
||||
---
|
||||
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
|
||||
```
|
@@ -1,15 +0,0 @@
|
||||
---
|
||||
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
|
||||
```
|
@@ -1,17 +0,0 @@
|
||||
---
|
||||
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
|
||||
```
|
@@ -1,17 +0,0 @@
|
||||
---
|
||||
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
|
||||
```
|
@@ -1,15 +0,0 @@
|
||||
---
|
||||
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
|
||||
```
|
@@ -1,17 +0,0 @@
|
||||
---
|
||||
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
|
||||
```
|
@@ -1,17 +0,0 @@
|
||||
---
|
||||
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
|
||||
```
|
@@ -1,11 +0,0 @@
|
||||
---
|
||||
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
|
||||
```
|
@@ -1,36 +0,0 @@
|
||||
---
|
||||
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/)
|
@@ -1,6 +0,0 @@
|
||||
---
|
||||
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`.
|
@@ -1,8 +0,0 @@
|
||||
---
|
||||
layout: default
|
||||
title: Navigation
|
||||
parent: Tests
|
||||
has_children: true
|
||||
---
|
||||
|
||||
# Navigation
|
@@ -1,14 +0,0 @@
|
||||
---
|
||||
layout: default
|
||||
title: "10"
|
||||
parent: Default
|
||||
grand_parent: Tests for order
|
||||
---
|
||||
|
||||
# 10
|
||||
|
||||
```yaml
|
||||
title: "10"
|
||||
parent: Default
|
||||
grand_parent: Tests for order
|
||||
```
|
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user