Compare commits

...

799 Commits

Author SHA1 Message Date
Matt Wang
e30b4e434c Update _config.yml 2023-02-22 10:26:06 -08:00
Matt Wang
4f88f19306 Update just-the-docs.gemspec 2023-02-22 10:24:13 -08:00
Matt Wang
a203f9f90e Update _config.yml 2023-02-22 10:23:08 -08:00
Patrick Marsceill
5a78a7d39b Merge pull request #455 from pmarsceill/v0.3.3
v0.3.3
2020-10-13 12:25:05 -04:00
Peter Mosses
5665097fc2 Update configuration.md
2019 replaced by 2020 in line 94.
2020-10-13 09:40:33 +02:00
Patrick Marsceill
487a5a680a Update configuration.md 2020-10-12 14:15:12 -04:00
Patrick Marsceill
e7ff383397 I meant auto... oops 2020-10-12 13:20:01 -04:00
Patrick Marsceill
4de9962c72 Fix order 2020-10-12 13:15:11 -04:00
Patrick Marsceill
85af5b81c5 Codeblocks need overflow hidden 2020-10-12 13:11:59 -04:00
Patrick Marsceill
bd1f741d6d Merge pull request #334 from CodeSandwich/custom_header_footer
Add custom header and footer include files
2020-10-12 12:57:25 -04:00
Patrick Marsceill
fdb93755d1 Update configuration.md 2020-10-12 12:49:51 -04:00
Patrick Marsceill
58aea7a29b Update configuration.md 2020-10-12 12:47:56 -04:00
Patrick Marsceill
bb1cd2aaac Merge pull request #451 from pmarsceill/dependabot/npm_and_yarn/stylelint-config-primer-9.2.1
Bump stylelint-config-primer from 9.0.0 to 9.2.1
2020-10-12 12:42:27 -04:00
Patrick Marsceill
863d13fc8e Merge pull request #443 from pdmosses/nav-exclude
Limit the effect of `nav_exclude` to the main navigation
2020-10-12 12:41:33 -04:00
Patrick Marsceill
37bbacbaa9 Merge pull request #440 from pmarsceill/dependabot/npm_and_yarn/stylelint-13.7.2
Bump stylelint from 13.6.1 to 13.7.2
2020-10-12 12:39:32 -04:00
Patrick Marsceill
ce0da9e848 Merge branch 'v0.3.3' into dependabot/npm_and_yarn/stylelint-13.7.2 2020-10-12 12:02:31 -04:00
Patrick Marsceill
7d35ccb333 Merge pull request #436 from pmarsceill/dependabot/npm_and_yarn/primer/css-15.2.0
Bump @primer/css from 15.1.0 to 15.2.0
2020-10-12 11:42:23 -04:00
Patrick Marsceill
f67b4ca2a1 Merge branch 'v0.3.3' into dependabot/npm_and_yarn/primer/css-15.2.0 2020-10-12 11:25:14 -04:00
Patrick Marsceill
9f4968fcb4 Merge pull request #429 from pmarsceill/dependabot/npm_and_yarn/prettier-2.1.2
Bump prettier from 2.1.1 to 2.1.2
2020-10-12 11:23:55 -04:00
Patrick Marsceill
bdbbf56b36 Merge pull request #444 from pdmosses/normalize-update
Update normalize.scss
2020-10-12 11:20:55 -04:00
Patrick Marsceill
1e468b4bff Merge pull request #445 from pdmosses/visited-code-links
Update code.scss
2020-10-12 11:20:27 -04:00
Patrick Marsceill
215655187f Merge pull request #446 from pdmosses/aliign-dd
Fix list alignment
2020-10-12 11:19:38 -04:00
dependabot-preview[bot]
59d3981580 Bump stylelint-config-primer from 9.0.0 to 9.2.1
Bumps [stylelint-config-primer](https://github.com/primer/stylelint-config-primer) from 9.0.0 to 9.2.1.
- [Release notes](https://github.com/primer/stylelint-config-primer/releases)
- [Changelog](https://github.com/primer/stylelint-config-primer/blob/master/CHANGELOG.md)
- [Commits](https://github.com/primer/stylelint-config-primer/compare/v9.0.0...v9.2.1)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-10-03 08:03:53 +00:00
PLanCompS
32afb2a983 prettier 2020-09-29 17:27:59 +02:00
PLanCompS
80e05938c7 prettier 2020-09-29 17:25:34 +02:00
PLanCompS
59f757a790 Fix list alignment
Resolve #420

- Remove `margin-top` for the first child in various list items, to improve alignment.
- Add examples of lists to `docs/tests/styling`.
2020-09-29 17:13:13 +02:00
PLanCompS
2e377e45ac Update code.scss
Fix #417

- Avoid appearance of dark border around visited code links in Safari.
2020-09-29 16:08:16 +02:00
PLanCompS
5d1609b888 Update normalize.scss
Fix #387
- Update `_sass/vendor/normalize.scss/normalize.scss` to v8.0.1.
- Remove outdated `_sass/vendor/normalize.scss/package.json`.
- Update `_sass/vendor/normalize.scss/README.md`.
2020-09-29 13:09:57 +02:00
PLanCompS
641fa6ac5c Create excluded.md
Add a test for explicit exclusion of an untitled page.
2020-09-28 17:26:51 +02:00
PLanCompS
09ab1c3131 List children also when excluded from main navigation
- Limit the effect of `nav_exclude: true` to the main navigation.
- Include links to excluded pages in auto-generating lists of child pages
and in breadcrumbs.
- Refactor implementation by moving assignment of `first_level_url` and `second_level_url` from `_includes/nav.html` to `_layouts/default.html`.
- Clarify the effect of `nav_exclude` in the documentation.
2020-09-28 17:06:06 +02:00
PLanCompS
682dcf4ec1 Folders renamed
Improve folder names.
Correct classification of excluded test pages.
2020-09-28 16:54:07 +02:00
PLanCompS
405180c863 Reorganise tests
Make the titles of test pages more suggestive.
Refactor the documentation of the tests.
2020-09-28 16:37:42 +02:00
PLanCompS
aa247408e4 Tests updated 2020-09-28 12:08:27 +02:00
dependabot-preview[bot]
39ee88299a Bump stylelint from 13.6.1 to 13.7.2
Bumps [stylelint](https://github.com/stylelint/stylelint) from 13.6.1 to 13.7.2.
- [Release notes](https://github.com/stylelint/stylelint/releases)
- [Changelog](https://github.com/stylelint/stylelint/blob/master/CHANGELOG.md)
- [Commits](https://github.com/stylelint/stylelint/compare/13.6.1...13.7.2)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-09-26 01:43:52 +00:00
dependabot-preview[bot]
516a660149 Bump @primer/css from 15.1.0 to 15.2.0
Bumps [@primer/css](https://github.com/primer/css) from 15.1.0 to 15.2.0.
- [Release notes](https://github.com/primer/css/releases)
- [Changelog](https://github.com/primer/css/blob/master/CHANGELOG.md)
- [Commits](https://github.com/primer/css/compare/v15.1.0...v15.2.0)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-09-22 00:31:42 +00:00
dependabot-preview[bot]
fd6c999920 Bump prettier from 2.1.1 to 2.1.2
Bumps [prettier](https://github.com/prettier/prettier) from 2.1.1 to 2.1.2.
- [Release notes](https://github.com/prettier/prettier/releases)
- [Changelog](https://github.com/prettier/prettier/blob/master/CHANGELOG.md)
- [Commits](https://github.com/prettier/prettier/compare/2.1.1...2.1.2)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-09-16 09:08:10 +00:00
Igor Żuk
b89ab93a88 Merge branch 'master' into custom_header_footer 2020-09-15 00:09:50 +02:00
Patrick Marsceill
76f8f064ac Merge pull request #388 from pmarsceill/v0.3.2
v0.3.2
2020-09-14 13:49:37 -04:00
Patrick Marsceill
0513c1930a Tweak search to make it less bulky 2020-09-14 13:33:29 -04:00
Patrick Marsceill
1f30d6bf78 Update line-nos.md 2020-09-14 13:29:09 -04:00
Patrick Marsceill
916a9256b1 Forgot this too 2020-09-14 13:24:10 -04:00
Patrick Marsceill
84e67c34b7 Forgot to remove this 2020-09-14 13:19:33 -04:00
Patrick Marsceill
1b0a313c16 Make examples more clear 2020-09-14 12:54:55 -04:00
Patrick Marsceill
c587c0b217 Fix heading hierarchy 2020-09-14 12:46:26 -04:00
Patrick Marsceill
e4246b35b0 Update permalink 2020-09-14 12:43:59 -04:00
Patrick Marsceill
68d5c56cf3 Move this down 2020-09-14 12:40:17 -04:00
Patrick Marsceill
f76b891038 Merge pull request #427 from pmarsceill/dependabot/npm_and_yarn/prettier-2.1.1
Bump prettier from 2.0.5 to 2.1.1
2020-09-14 12:35:27 -04:00
Patrick Marsceill
9260e59255 Merge branch 'master' into custom_header_footer 2020-09-14 12:32:01 -04:00
Patrick Marsceill
e0f7dea67f Update just-the-docs.gemspec 2020-09-14 12:28:55 -04:00
Patrick Marsceill
575b9237f9 Revert this 2020-09-14 12:28:14 -04:00
Patrick Marsceill
d4da8e7e46 Update index.md 2020-09-14 12:15:15 -04:00
Patrick Marsceill
ada962d917 Add current version number as a test. 2020-09-14 12:07:59 -04:00
Patrick Marsceill
f518ff3caa Update _sass/support/_variables.scss
Co-authored-by: Kevin Lin <kevinl@cs.uw.edu>
2020-09-14 11:19:56 -04:00
Patrick Marsceill
020a50acff Update docs/tests/navigation/exclude/untitled.md
Co-authored-by: Peter Mosses <18308236+pdmosses@users.noreply.github.com>
2020-09-14 10:57:42 -04:00
dependabot-preview[bot]
985bdc02ca Bump prettier from 2.0.5 to 2.1.1
Bumps [prettier](https://github.com/prettier/prettier) from 2.0.5 to 2.1.1.
- [Release notes](https://github.com/prettier/prettier/releases)
- [Changelog](https://github.com/prettier/prettier/blob/master/CHANGELOG.md)
- [Commits](https://github.com/prettier/prettier/compare/2.0.5...2.1.1)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-09-12 08:26:47 +00:00
Peter Mosses
000da77ba2 Update _includes/nav.html
Correction needed for use of collections.

Co-authored-by: Kevin Lin <kevinl@cs.uw.edu>
2020-09-12 08:55:53 +02:00
Patrick Marsceill
f774596f5e Use magic numbers for better alignment 2020-09-11 17:18:44 -04:00
Patrick Marsceill
5cc5ae5edf Merge pull request #418 from mrfleap/master
Add site.gh_edit_source to "Edit this page on GitHub" link
2020-09-11 17:00:29 -04:00
Patrick Marsceill
1c654bad4b Merge pull request #411 from pdmosses/nav-sorting
Safe page sorting
2020-09-11 16:58:06 -04:00
PLanCompS
d59887cc2b Update linenos.md
doc for turning on kramdown linenos globally corrected/
2020-09-11 19:42:44 +02:00
PLanCompS
fea9ae2b07 Update _config.yml
url corrected
2020-09-11 19:41:55 +02:00
PLanCompS
ddccec7bb7 Update navigation-structure.md
Reinstated the collapsible TOC at the top, to support the reference to it right at the end of the file. (The `TOC` feature can only be used once per page, so this is the only way of illustrating the rendering of the collapsible TOC in the docs.)
2020-09-11 18:57:57 +02:00
PLanCompS
cd8d173935 Updated tests activation documenation
Apparetnly Jekyll's `include` config option cannot be used to override an `exclude`, so activating `docs/tests/` requires commenting-out that line in the `exclude` list.
2020-09-11 18:54:32 +02:00
PLanCompS
02763e69d9 Merge branch 'master' into nav-sorting 2020-09-11 18:49:44 +02:00
PLanCompS
d07589a9ee Merge remote-tracking branch 'upstream/v0.3.2' 2020-09-11 18:21:18 +02:00
Patrick Marsceill
2abf8662b6 Merge pull request #419 from pmarsceill/dependabot/npm_and_yarn/prettier-2.1.1
Bump prettier from 2.0.5 to 2.1.1
2020-09-11 12:00:22 -04:00
Patrick Marsceill
d0a9cd38dd Merge pull request #404 from pdmosses/h4-code
Inhibit text-transform for code in h4
2020-09-11 11:51:02 -04:00
Patrick Marsceill
322026633f Merge pull request #331 from hvianna/master
Fix native font stack precedence issue on Windows systems.
2020-09-11 11:48:54 -04:00
Patrick Marsceill
a9842d2846 Merge pull request #361 from pdebruic/add-font-size-vars
make font-sizes sass variables so they can be changed
2020-09-11 11:48:12 -04:00
Patrick Marsceill
db32b66ce9 Merge pull request #375 from pdmosses/linenos
Support for the linenos option on highlighted code
2020-09-11 10:59:13 -04:00
dependabot-preview[bot]
793a7247db Bump prettier from 2.0.5 to 2.1.1
Bumps [prettier](https://github.com/prettier/prettier) from 2.0.5 to 2.1.1.
- [Release notes](https://github.com/prettier/prettier/releases)
- [Changelog](https://github.com/prettier/prettier/blob/master/CHANGELOG.md)
- [Commits](https://github.com/prettier/prettier/compare/2.0.5...2.1.1)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-08-26 08:53:22 +00:00
Phillip Cutter
cdfad69c5b Migrated from site.source to site.gh_edit_source 2020-08-25 18:08:31 -07:00
Phillip Cutter
55f80acb4f Added site.source to GitHub edit link 2020-08-25 17:53:54 -07:00
PLanCompS
ca367e09d5 Added regression tests for navigation
See the change to `_config.yml` for how to activate the tests.
2020-08-13 16:52:30 +02:00
PLanCompS
591a3c2351 Update navigation-structure.md
Clarifications
2020-08-13 16:48:45 +02:00
PLanCompS
cfbdee1168 Update nav.html
Fixed conversion of numeric titles to strings.
2020-08-13 16:47:58 +02:00
PLanCompS
cff0254d93 Update navigation-structure.md
Adjusted the documentation to explain how mixtures of numbers and strings are treated by `nav_order`.
2020-08-11 20:47:22 +02:00
PLanCompS
e4759daecf Update nav.html
Indentation adjusted
2020-08-11 18:31:54 +02:00
PLanCompS
a7be52df3b Update nav.html 2020-08-11 18:26:34 +02:00
PLanCompS
4fc59a578f Separate sorting of numbers and strings for navigation order
The values of `title` and `nav_order` can be numbers or strings.
Jekyll gives build failures when sorting on mixtures of different types,
so numbers and strings need to be sorted separately.

Here, numbers are sorted by their values, and come before all strings.
An omitted `nav_order` value is equivalent to the page's `title` value
(except that a numerical `title` value is treated as a string).

The case-sensitivity of string sorting is determined by `site.nav_sort`.
2020-08-11 18:25:58 +02:00
PLanCompS
bb8c387899 Merge remote-tracking branch 'upstream/master' into h4-code 2020-08-11 08:34:49 +02:00
PLanCompS
74da664c0a Linenos test moved to UI Components as a child of Code 2020-08-10 16:53:48 +02:00
Patrick Marsceill
6ac67d2228 Merge branch 'master' into v0.3.2 2020-08-10 10:48:48 -04:00
Patrick Marsceill
7883789d94 Merge pull request #398 from fogfish/master
run the site locally inside docker container
2020-08-10 10:47:39 -04:00
Patrick Marsceill
101dd2efdc Merge pull request #399 from pdmosses/anchor-headings-1.0.7
Update anchor_headings.html
2020-08-10 10:46:17 -04:00
Patrick Marsceill
6be8a2e38a Merge pull request #379 from SgtSilvio/feature/doc-collections
Feature/doc collections
2020-08-10 10:42:30 -04:00
Patrick Marsceill
54c921cbcd Merge pull request #389 from pmarsceill/dependabot/npm_and_yarn/lodash-4.17.19
[Security] Bump lodash from 4.17.15 to 4.17.19
2020-08-10 10:41:31 -04:00
Patrick Marsceill
169fa727a3 Merge branch 'master' into dependabot/npm_and_yarn/lodash-4.17.19 2020-08-10 10:34:49 -04:00
Patrick Marsceill
c11814bb7e Merge pull request #402 from pmarsceill/dependabot/npm_and_yarn/primer/css-15.1.0
Bump @primer/css from 14.4.0 to 15.1.0
2020-08-10 10:34:35 -04:00
Patrick Marsceill
264c99b311 Update release-drafter.yml 2020-08-10 10:34:17 -04:00
Patrick Marsceill
5be5d629ff Merge pull request #401 from pdmosses/description-lists
Adjust dl layout
2020-08-10 10:30:05 -04:00
PLanCompS
83ec553348 Ensure pages with nav_exclude are ignored by navigation
Pages with `nav_exclude: true` were included when sorting on `title` or `nav_order`. That could cause build failures when the type of value of the field differs from that on other pages, as reported in https://github.com/pmarsceill/just-the-docs/issues/406.

Pages with `nav_exclude: true` or no `title` are never displayed in the navigation, so removing them from `pages_list` cannot break existing sites. This change also allows the removal of some tests in the code. (The indentation of the code should now be adjusted, but that has been deferred, to restrict the size of the diff for review.)

For testing, the title of `404.html` has been changed to the number `404`,  the page `docs/untitled-test.md`  has been added, and `nav_sort_order` has been set to `case_sensitive`. Those updates give build failures with the current version of `_includes/nav.html`, but not after the suggested changes.

It will still be possible for build failures to occur due to sorting fields of *non-excluded* pages with differing types of values (e.g., `nav_order`a mixture of numbers and strings). To make the code completely safe will require relatively complicated changes,.
2020-08-10 15:58:42 +02:00
PLanCompS
98b22be66b Inhibit text-transform for code in h4
Tested in `index-test.md`

Fixes #403
2020-08-06 10:04:43 +02:00
dependabot-preview[bot]
f1475cf012 Bump @primer/css from 14.4.0 to 15.1.0
Bumps [@primer/css](https://github.com/primer/css) from 14.4.0 to 15.1.0.
- [Release notes](https://github.com/primer/css/releases)
- [Changelog](https://github.com/primer/css/blob/master/CHANGELOG.md)
- [Commits](https://github.com/primer/css/compare/v14.4.0...v15.1.0)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-08-05 17:32:23 +00:00
CodeSandwich
d2d3609dea Improve default footer contrast
This improves Google Lighthouse accessibility score. As a human I agree that it was too faint.
2020-08-04 12:33:25 +02:00
PLanCompS
eb98fe0eeb Update content.scss
Cosmetic
2020-08-03 19:54:58 +02:00
PLanCompS
9fca3861ce Adjust dl layout
Works for description lists with multiple `dt` and `dd` elements.
2020-08-03 17:38:48 +02:00
PLanCompS
d4adef025e Update _layouts/default.html to preserve aria-labelledby in headings
Correction suggested by @allejo in comment https://github.com/pmarsceill/just-the-docs/pull/399#discussion_r464128713.
Also prevents losing the aria-labelledby attribute in future updates to this snippet.
2020-08-03 08:50:04 +02:00
PLanCompS
5258835588 Update anchor_headings.html
Fixes a bug where content after headings in header elements disappeared.
Header elements are not currently used in JtD, but could make the HTML more semantic.
2020-08-02 12:59:05 +02:00
Dmitry Kolesnikov
ff40b7881a run the site locally inside docker container 2020-07-28 17:31:49 +03:00
PLanCompS
86061c80a4 grandchildren-test removed 2020-07-27 14:19:06 +02:00
PLanCompS
2c4304c125 Merge remote-tracking branch 'upstream/master' 2020-07-27 14:11:42 +02:00
CodeSandwich
cd192aa4e2 Add custom header and footer include files 2020-07-26 00:35:58 +02:00
Patrick Marsceill
19d6bcf5d3 Merge branch 'master' into v0.3.2 2020-07-22 14:31:25 -04:00
dependabot-preview[bot]
248328670b [Security] Bump lodash from 4.17.15 to 4.17.19
Bumps [lodash](https://github.com/lodash/lodash) from 4.17.15 to 4.17.19. **This update includes a security fix.**
- [Release notes](https://github.com/lodash/lodash/releases)
- [Commits](https://github.com/lodash/lodash/compare/4.17.15...4.17.19)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-07-21 14:51:51 +00:00
Patrick Marsceill
721f322e41 Update _typography.scss 2020-07-20 17:48:56 -04:00
Patrick Marsceill
e358b8d914 Update _variables.scss 2020-07-20 17:39:30 -04:00
Patrick Marsceill
f91a33e43f Merge pull request #384 from pmarsceill/dependabot/npm_and_yarn/lodash-4.17.19
Bump lodash from 4.17.15 to 4.17.19
2020-07-20 17:37:00 -04:00
Patrick Marsceill
c54be05b8a Merge pull request #371 from pmarsceill/dependabot/npm_and_yarn/primer/css-15.0.0
Bump @primer/css from 14.4.0 to 15.0.0
2020-07-20 17:33:55 -04:00
Patrick Marsceill
31b99a2a9b Update release-drafter.yml 2020-07-20 17:32:21 -04:00
Patrick Marsceill
96fffcc59d Merge pull request #359 from totaldebug/fix_https
Fix https
2020-07-20 17:31:19 -04:00
Patrick Marsceill
584506785b Update just-the-docs.gemspec 2020-07-20 17:26:49 -04:00
Patrick Marsceill
12985168cf Update package.json 2020-07-20 17:26:24 -04:00
Patrick Marsceill
9dd1cde227 Update release-drafter.yml 2020-07-20 17:23:57 -04:00
Patrick Marsceill
0a26b95749 Merge branch 'master' into linenos 2020-07-20 17:11:07 -04:00
Henrique Vianna
8ff2e57796 Merge branch 'master' into master 2020-07-16 15:11:00 -03:00
dependabot-preview[bot]
35ddf7c694 Bump @primer/css from 14.4.0 to 15.0.0
Bumps [@primer/css](https://github.com/primer/css) from 14.4.0 to 15.0.0.
- [Release notes](https://github.com/primer/css/releases)
- [Changelog](https://github.com/primer/css/blob/master/CHANGELOG.md)
- [Commits](https://github.com/primer/css/compare/v14.4.0...v15.0.0)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-07-15 21:57:48 +00:00
dependabot[bot]
923f021381 Bump lodash from 4.17.15 to 4.17.19
Bumps [lodash](https://github.com/lodash/lodash) from 4.17.15 to 4.17.19.
- [Release notes](https://github.com/lodash/lodash/releases)
- [Commits](https://github.com/lodash/lodash/compare/4.17.15...4.17.19)

Signed-off-by: dependabot[bot] <support@github.com>
2020-07-15 21:56:47 +00:00
Patrick Marsceill
46aa1134a8 Update just-the-docs.gemspec 2020-07-15 17:56:37 -04:00
Patrick Marsceill
9edd8d5c50 Bump version to 0.3.1 2020-07-15 17:56:09 -04:00
Silvio Giebl
5dd6324f61 Fixed display of nav-category 2020-07-12 20:02:44 +02:00
Silvio Giebl
a086954c51 Improved documentation for document collections 2020-07-10 21:05:29 +02:00
Silvio Giebl
b32c00a701 Improved documentation of just-the-docs.collections nav_exclude and search_exclude 2020-07-10 20:36:05 +02:00
Silvio Giebl
6b27beaf58 Added just-the-docs.collections nav_exclude and search_exclude
Renamed doc_collections to just-the-docs.collections
2020-07-10 19:07:01 +02:00
Silvio Giebl
9faba6cd91 Removed temporary changes 2020-07-10 17:26:23 +02:00
Silvio Giebl
7dec48433b Improved documentation for doc_collections 2020-07-09 23:51:31 +02:00
Silvio Giebl
b4b74f7e1d Added documentation for doc_collections 2020-07-09 23:43:33 +02:00
Silvio Giebl
d1c3e08337 Updated doc_collections format 2020-07-09 23:33:52 +02:00
Silvio Giebl
d476ce5748 Updated search.rake 2020-07-09 22:14:57 +02:00
Silvio Giebl
93f93f48a7 Added doc collections and categories 2020-07-09 21:07:24 +02:00
PLanCompS
a855af3db3 Update code.scss 2020-07-07 19:59:13 +02:00
PLanCompS
8a9a8a345d Optimisations
Optimised CSS selectors.
Changed markup in `linenos-test` to inhibit line numbers appearing in YAML examples when testing code fences.
2020-07-07 19:54:31 +02:00
PLanCompS
029ba12559 Update code.scss 2020-07-07 19:38:46 +02:00
PLanCompS
d13ac2fe5b Merge branch 'linenos' of https://github.com/pdmosses/just-the-docs into linenos 2020-07-07 19:34:48 +02:00
PLanCompS
61053f677b Major refactoring
The additions to `_config.yml` go together with the changes to `code.scss`,
to facilitate adjusttments by users. See `docs/linenos-test` for the details.
The CSS code has been significantly refactored and simplified,
and seems to produce sensible results (at least on Safari and Firefox).
2020-07-07 19:34:35 +02:00
Patrick Marsceill
a4b862aa4b Merge branch 'master' into add-font-size-vars 2020-07-06 11:25:17 -04:00
Peter Mosses
305bed7cd5 Merge branch 'master' into linenos 2020-07-06 17:24:41 +02:00
Patrick Marsceill
654da0a6ef Merge pull request #369 from SgtSilvio/bugfix/css-main-search-active
Fixed css .search-active.main
2020-07-06 11:24:28 -04:00
Patrick Marsceill
a8f8f8445a Merge pull request #376 from MikesCoolOrg/master
Improve accessibility by adding label to Anchor links.
2020-07-06 11:22:04 -04:00
PLanCompS
49ef043ebb Update code.scss
Removed some comments and layout
2020-07-06 17:20:55 +02:00
PLanCompS
b5cd532435 Update code.scss
Produces sensible (but not perfect) results from different kinds of highlight markup.
The CSS code needs a major refactoring to eliminate duplication and superflous lines.
2020-07-06 15:10:35 +02:00
PLanCompS
b73300595b Simplified the use of fix_linenos
Now using an include parameter.
Enhanced to support Markdown with code fences.
2020-07-06 15:07:53 +02:00
PLanCompS
fdaf5a276b Moved tests from index-test.md to linenos-test.md
This should revert the changes made to index-test.md
2020-07-06 15:04:30 +02:00
Mike Coutermarsh
bf31b8b9a0 Improve accessibility by adding label to Anchor links.
I ran Lighthouse on just-the-docs and noticed the anchor links
were missing a "discernible name".

This adds aria-labelledby to the header element to improve these for
screenreaders.
2020-07-04 14:28:52 -07:00
PLanCompS
74845b4a0e Update code.scss
Fixed more layout details. Numbers of selectors still to be fixed.
2020-07-04 21:17:18 +02:00
PLanCompS
7df7572d91 Update code.scss
Correected layout, order, values.
2020-07-04 21:12:00 +02:00
PLanCompS
b41f28dade Support for the linenos option on highlighted code
The added examples in `docs/index-test.md` extend the previous examplees of highlighting, documenting the required inout.
2020-07-04 19:21:49 +02:00
Silvio Giebl
5a96a218b3 Fixed css .search-active.main 2020-06-30 20:22:32 +02:00
Patrick Marsceill
50d727871e Merge pull request #368 from pmarsceill/remove-collapse-toc-onpage
Remove collapsible TOC on nav doc
2020-06-30 14:04:43 -04:00
Patrick Marsceill
1bdd849d86 Update navigation-structure.md 2020-06-30 13:58:26 -04:00
Patrick Marsceill
5277d14547 Merge pull request #367 from pmarsceill/pdmosses-collapsible-toc
Pdmosses collapsible toc
2020-06-30 13:48:49 -04:00
Patrick Marsceill
2101701aad Merge branch 'master' into pdmosses-collapsible-toc 2020-06-30 13:42:36 -04:00
Patrick Marsceill
845261205f Make cursor pointer, update docs, and add heading 2020-06-30 13:03:17 -04:00
Patrick Marsceill
c8bbcc2d9b Merge branch 'collapsible-toc' of git://github.com/pdmosses/just-the-docs into pdmosses-collapsible-toc 2020-06-30 12:54:51 -04:00
Patrick Marsceill
e8d60818ed Update _variables.scss 2020-06-30 12:46:44 -04:00
Paul DeBruicker
d90482d719 put the font size variables in variables.scss and rename the ones misnamed -mq 2020-06-28 14:52:15 -07:00
Henrique Vianna
72b6de8862 Updated native font stack, as suggested in https://github.com/pmarsceill/just-the-docs/issues/330#issuecomment-650415240 2020-06-27 17:37:39 -03:00
Henrique Vianna
1f492b68f3 Merge remote-tracking branch 'upstream/master' 2020-06-27 17:34:59 -03:00
Steven Marks
fb0faee220 Merge branch 'master' into fix_https 2020-06-27 10:05:26 +01:00
marksie1988
d3d17c0460 fix conflicts 2020-06-27 10:02:36 +01:00
Patrick Marsceill
972da61cf9 Merge pull request #327 from pmarsceill/dependabot/npm_and_yarn/primer/css-14.4.0
Bump @primer/css from 14.3.0 to 14.4.0
2020-06-26 16:00:04 -04:00
Patrick Marsceill
ab9fd6453b Merge pull request #343 from pmarsceill/dependabot/npm_and_yarn/stylelint-13.6.1
Bump stylelint from 13.3.3 to 13.6.1
2020-06-26 15:59:44 -04:00
Patrick Marsceill
2ef11e3701 Merge branch 'master' into dependabot/npm_and_yarn/stylelint-13.6.1 2020-06-26 15:54:25 -04:00
Patrick Marsceill
3382a954d2 Merge branch 'master' into dependabot/npm_and_yarn/primer/css-14.4.0 2020-06-26 15:53:11 -04:00
Patrick Marsceill
848b090d06 Merge pull request #349 from pmarsceill/dependabot/npm_and_yarn/stylelint-config-prettier-8.0.2
Bump stylelint-config-prettier from 8.0.1 to 8.0.2
2020-06-26 15:52:28 -04:00
Patrick Marsceill
8700916a93 Update release-drafter.yml 2020-06-26 15:52:02 -04:00
dependabot-preview[bot]
13d01a6561 Bump @primer/css from 14.3.0 to 14.4.0
Bumps [@primer/css](https://github.com/primer/css) from 14.3.0 to 14.4.0.
- [Release notes](https://github.com/primer/css/releases)
- [Changelog](https://github.com/primer/css/blob/master/CHANGELOG.md)
- [Commits](https://github.com/primer/css/compare/v14.3.0...v14.4.0)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-06-26 19:46:23 +00:00
dependabot-preview[bot]
2efc206d02 Bump stylelint-config-prettier from 8.0.1 to 8.0.2
Bumps [stylelint-config-prettier](https://github.com/prettier/stylelint-config-prettier) from 8.0.1 to 8.0.2.
- [Release notes](https://github.com/prettier/stylelint-config-prettier/releases)
- [Commits](https://github.com/prettier/stylelint-config-prettier/compare/v8.0.1...v8.0.2)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-06-26 19:46:07 +00:00
Patrick Marsceill
20222fe0a7 Merge pull request #360 from pmarsceill/bump-version
Bump version numbers
2020-06-26 15:44:30 -04:00
Patrick Marsceill
c4d5f4f6b0 Merge pull request #362 from pmarsceill/pdebruic-print-css
Add print styles
2020-06-26 15:42:08 -04:00
Patrick Marsceill
12536de881 Merge branch 'master' into bump-version 2020-06-26 15:38:51 -04:00
Patrick Marsceill
c895d5ecd9 Remove print from utils 2020-06-26 15:34:26 -04:00
Patrick Marsceill
b8602eb05d Move print to top level (not util) 2020-06-26 15:33:16 -04:00
Patrick Marsceill
8715224655 Add IDs to target print styles 2020-06-26 15:33:03 -04:00
Paul DeBruicker
87a59ef8ef make font-sizes sass variables so they can be changed 2020-06-26 11:35:58 -07:00
Patrick Marsceill
cba7303660 Merge branch 'master' into print-css 2020-06-26 14:29:36 -04:00
Patrick Marsceill
5def3aee43 Merge pull request #348 from PierrickMartos/master
Remove constraint with jekyll 4.1.0
2020-06-26 14:28:49 -04:00
Patrick Marsceill
53a5feb11b Merge branch 'master' into master 2020-06-26 14:23:28 -04:00
Patrick Marsceill
17c140da35 Update just-the-docs.gemspec 2020-06-26 14:22:29 -04:00
Patrick Marsceill
e29a540a59 Update package.json 2020-06-26 14:20:54 -04:00
Patrick Marsceill
45af827e0a Merge pull request #352 from SgtSilvio/navigation-improvements-and-search-sections
Navigation improvements and search sections
2020-06-26 14:19:37 -04:00
marksie1988
040bef90bb change for https 2020-06-26 13:42:32 +01:00
marksie1988
160cc42e4e show logo on closed nav 2020-06-26 11:59:37 +01:00
marksie1988
e181626b66 merge upstream 2020-06-26 11:50:56 +01:00
marksie1988
88759c1cf7 change to relative_url 2020-06-26 11:41:50 +01:00
marksie1988
d7050b3f04 change to relative_url 2020-06-26 10:08:11 +01:00
Silvio Giebl
597c534279 Replaced svgs with feathericons.com 2020-06-25 23:48:24 +02:00
Silvio Giebl
3f0b7254a2 Update _config.yml with default values 2020-06-25 23:19:24 +02:00
Silvio Giebl
868bb0e3ac Apply suggestions from code review
Co-authored-by: Patrick Marsceill <pmarsceill@users.noreply.github.com>
2020-06-25 23:11:43 +02:00
Patrick Marsceill
1e73c69700 Merge branch 'master' into dependabot/npm_and_yarn/stylelint-13.6.1 2020-06-25 17:09:50 -04:00
Patrick Marsceill
5ec0044b72 Update just-the-docs.gemspec 2020-06-25 16:28:45 -04:00
Patrick Marsceill
15f9f52a77 Merge branch 'master' into master 2020-06-25 16:28:19 -04:00
Silvio Giebl
f2aa3c9a4d Fixed prettier style 2020-06-25 21:42:41 +02:00
Silvio Giebl
397e4a6933 Merge branch 'master' into navigation-improvements-and-search-sections 2020-06-25 21:16:21 +02:00
Patrick Marsceill
171ff71a2b Update ci.yml 2020-06-25 14:23:27 -04:00
Patrick Marsceill
e4a29e54ec Update release-drafter.yml 2020-06-25 14:17:46 -04:00
Patrick Marsceill
eadd46c6e4 Create release-drafter.yml 2020-06-25 14:16:41 -04:00
Paul DeBruicker
d3c389ccc5 add print css. hides the sidebar, keeps the logo 2020-06-25 07:43:12 -07:00
Patrick Marsceill
16c18c1020 Fix bundle exec in CI 2020-06-23 11:56:15 -04:00
Patrick Marsceill
b31355691f Fix rake command in ci 2020-06-23 11:46:30 -04:00
Patrick Marsceill
3eaa0155d1 Update ci-master.yml 2020-06-23 11:19:38 -04:00
Patrick Marsceill
6c4d47cae4 Bundle errors in ci 2020-06-23 11:09:40 -04:00
dependabot-preview[bot]
8102af2cd4 Bump stylelint from 13.3.3 to 13.6.1
Bumps [stylelint](https://github.com/stylelint/stylelint) from 13.3.3 to 13.6.1.
- [Release notes](https://github.com/stylelint/stylelint/releases)
- [Changelog](https://github.com/stylelint/stylelint/blob/master/CHANGELOG.md)
- [Commits](https://github.com/stylelint/stylelint/compare/13.3.3...13.6.1)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-06-23 15:03:50 +00:00
Patrick Marsceill
8c77c24959 Merge pull request #306 from pmarsceill/v0.2.9
v0.2.9
2020-06-23 11:01:58 -04:00
Pierrick Martos
f2ac995815 Remove constraint with jekyll 4.1.0 2020-06-22 17:31:04 +02:00
Silvio Giebl
1cf7d5aba9 Restored search.rake 2020-06-18 22:39:58 +02:00
Silvio Giebl
ed618caf70 Fixed table of children 2020-06-15 23:00:53 +02:00
Silvio Giebl
51f15965f2 Merge branch 'feature/search-sections' into improvement/navigation-new
# Conflicts:
#	_includes/nav.html
#	_layouts/default.html
#	assets/js/search-data.json
#	docs/configuration.md
#	lib/tasks/search.rake
2020-06-15 22:06:16 +02:00
Silvio Giebl
16628f2b8e Improved search responsiveness for many results 2020-06-15 21:57:55 +02:00
Silvio Giebl
0421ab7f82 Fixed stylelint 2020-06-15 21:57:55 +02:00
Silvio Giebl
b7a5458375 Fixed fuzzy search hangs for long words 2020-06-15 21:57:55 +02:00
Silvio Giebl
da9276121a Improved search input for mobile
- font size 16px to prevent zooming on iOS Safari
- search input is scrolled into view on iOS Safari
- box-shadow is displayed correctly
2020-06-15 21:57:54 +02:00
Silvio Giebl
18f3a41600 Merge branch 'bugfix/page-scrolling' into improvement/navigation-new
# Conflicts:
#	_layouts/default.html
#	assets/js/just-the-docs.js
2020-06-15 21:44:30 +02:00
Silvio Giebl
e216623ed3 Merge branch 'improvement/search-button' into improvement/navigation-new 2020-06-15 21:37:31 +02:00
Silvio Giebl
c7466e88a8 Merge branch 'improvement/navigation' into improvement/navigation-new
# Conflicts:
#	_includes/nav.html
#	_layouts/default.html
2020-06-15 21:23:03 +02:00
Henrique Vianna
7cfc63e138 Fix native font stack precedence issue on Windows systems. 2020-06-01 14:35:15 -03:00
Patrick Marsceill
85fa222f49 Merge branch 'v0.2.9' of github.com:pmarsceill/just-the-docs into v0.2.9 2020-05-21 14:15:27 -04:00
Patrick Marsceill
798c14b46a lint 2020-05-21 14:15:14 -04:00
Patrick Marsceill
5fbfe09ce9 Update ci.yml 2020-05-21 14:05:17 -04:00
Patrick Marsceill
439d1d6769 Update ci.yml 2020-05-21 14:00:30 -04:00
Patrick Marsceill
ddf0095a3e Update ci.yml 2020-05-21 14:00:12 -04:00
Patrick Marsceill
2d9b17070a Update ci.yml 2020-05-21 13:56:06 -04:00
Patrick Marsceill
992b38f7de Update ci.yml
Permissioning
2020-05-21 13:51:22 -04:00
Patrick Marsceill
7fdf886d15 Update ci.yml
Fix CI workflow
2020-05-21 13:49:27 -04:00
Patrick Marsceill
5c2087c61b Merge pull request #319 from RoiArthurB/patch-1
[SEARCH RAKE] Fix search generator
2020-05-21 13:26:28 -04:00
Arthur Brugière
34ed214ef6 [SEARCH RAKE] Fix search generator 2020-05-13 14:45:38 +07:00
pmarsceill
09ea2e5ae8 🎨 Prettier 2020-05-05 16:49:42 +00:00
Patrick Marsceill
5ea1b339ce Merge 6345c61aae into 5915b2fef5 2020-05-05 16:49:03 +00:00
Patrick Marsceill
6345c61aae Clean up typography updates 2020-05-05 12:48:45 -04:00
PLanCompS
e40ba9c6c5 Update documentation with collapsible TOC
Makes the TOC at the top of the page collapsible.
Adds an explanation of the markup used to produce a collapsible TOC.
Adds a comment about the possibility of using an unordered list for the TOC,
and about using TOC only once per page.
2020-05-02 14:39:31 +02:00
PLanCompS
bf031eb68b Update .gitignore 2020-05-02 11:24:49 +02:00
Patrick Marsceill
d9b2822448 date fix 2020-05-01 17:32:54 -04:00
Patrick Marsceill
0033934409 Label styles 2020-05-01 17:32:46 -04:00
Patrick Marsceill
beb88adf5f Typography fixes 2020-05-01 17:32:33 -04:00
Patrick Marsceill
f664d410d7 Add back to top link and format footer 2020-05-01 17:31:44 -04:00
Patrick Marsceill
411c508806 Add additional layout and text justifcations 2020-05-01 15:32:42 -04:00
Patrick Marsceill
2f13db1f01 Make code font size dynamic 2020-05-01 15:07:27 -04:00
Patrick Marsceill
ff5047e523 Fix outdated docs
closes #266
2020-05-01 14:55:40 -04:00
Silvio Giebl
d7e57de985 Exclude pages without title from nav (e.g. redirects) 2020-04-29 14:44:51 -04:00
Patrick Marsceill
d39c922806 Merge branch 'v0.2.9' of github.com:pmarsceill/just-the-docs into v0.2.9 2020-04-29 14:39:09 -04:00
Patrick Marsceill
611a4c51a9 Merge branch 'master' into v0.2.9 2020-04-29 14:39:01 -04:00
Patrick Marsceill
10d6abd356 Merge branch 'v0.2.9' of github.com:pmarsceill/just-the-docs into v0.2.9 2020-04-29 14:38:37 -04:00
Patrick Marsceill
9428b93c3d Add .ruby-version to gitignore 2020-04-29 14:38:06 -04:00
Patrick Marsceill
5915b2fef5 Update README.md 2020-04-29 14:05:55 -04:00
Patrick Marsceill
424f9a8ee9 Update ci-master.yml 2020-04-29 14:04:03 -04:00
Patrick Marsceill
484563b297 Merge pull request #239 from KasparEtter/fix-duplicates-in-nav
Fix duplicate entries in nav.html and default.html
2020-04-28 17:52:35 -04:00
Peter Mosses
e97b718f5d Update nav.html
Changed `site.html_pages` to `pages_list`, to repeat the nav order of the grandchildren in the nav panel.
2020-04-28 18:07:50 +02:00
Peter Mosses
561f930e83 Update navigation-structure.md
Deleted a spurious line from a previous version.
2020-04-28 17:33:59 +02:00
Peter Mosses
73ad860f8e Update _includes/nav.html
Co-Authored-By: Patrick Marsceill <pmarsceill@users.noreply.github.com>
2020-04-28 17:08:53 +02:00
Patrick Marsceill
41a74d247d Update docs/navigation-structure.md
Co-Authored-By: Peter Mosses <18308236+pdmosses@users.noreply.github.com>
2020-04-28 10:58:07 -04:00
Peter Mosses
30e1ddcdae Update _layouts/default.html 2020-04-28 08:08:34 +02:00
Patrick Marsceill
b4c278cb8f Merge pull request #229 from malsf21/aux-links-new-tab
feat: adds option to open aux links in new tab
2020-04-27 16:41:37 -04:00
Matt Wang
6d487845a4 Merge branch 'v0.2.9' into aux-links-new-tab 2020-04-27 13:00:42 -07:00
Matt Wang
7fd8f6379a Merge branch 'master' into aux-links-new-tab 2020-04-27 12:49:53 -07:00
Patrick Marsceill
431b6cb4a2 Merge pull request #311 from pmarsceill/add-ci-to-master
Create ci-master.yml
2020-04-27 15:09:59 -04:00
Patrick Marsceill
0ea28edc71 Update ci-master.yml 2020-04-27 15:00:58 -04:00
Patrick Marsceill
3dd97d29c2 Create ci-master.yml 2020-04-27 14:59:16 -04:00
Patrick Marsceill
16e83704d0 Update default.html 2020-04-27 14:18:28 -04:00
Patrick Marsceill
12900d8ed1 Update index.md 2020-04-27 13:54:44 -04:00
Patrick Marsceill
b7fe6e0318 Merge branch 'v0.2.9' into fix-duplicates-in-nav 2020-04-27 13:29:52 -04:00
Patrick Marsceill
b9f89fcd9f Merge branch 'master' into fix-duplicates-in-nav 2020-04-27 13:19:55 -04:00
Patrick Marsceill
70c36d8aad Update _config.yml 2020-04-27 13:14:42 -04:00
Patrick Marsceill
ee44f699ec Update default.html 2020-04-27 13:13:22 -04:00
Patrick Marsceill
30b5da451c Update default.html 2020-04-27 13:07:25 -04:00
Patrick Marsceill
6066d22c82 Update _config.yml 2020-04-27 12:52:07 -04:00
Patrick Marsceill
176ffc8e60 Update _config.yml 2020-04-27 12:51:48 -04:00
Patrick Marsceill
b51decd020 Merge pull request #236 from pdmosses/default-nav-order
Default nav order
2020-04-27 11:12:26 -04:00
Patrick Marsceill
fad434bc74 Merge branch 'v0.2.9' into default-nav-order 2020-04-27 11:05:46 -04:00
PLanCompS
d00aadeee7 Update .gitignore
Added `.jekyll-cache`
2020-04-27 16:28:30 +02:00
PLanCompS
c46ccd3484 Made case-insenstive sorting the default
Added a configuration option to determine whether the sort order is case-sensitive.
The default is case-insensitive.

To test:
- open `/just-the-docs/docs/utilities/` in the browser,
  and check that the navigation links in `Utilities` are sorted alphabetically;
- in `docs/utilities/layout.md', change the preamble to `title: layout`,
  and check that the  links in `Utilities` are still sorted alphabetically;
- add `nav_sort: case_sensitive` in the configuration file,
  and check that the link to `layout` is now listed last under `Utilities`.
2020-04-25 14:53:45 +02:00
PLanCompS
7e959f4b69 Update .gitignore
Added `.jekyll-cache`
2020-04-25 13:54:36 +02:00
Peter Mosses
c071901629 Merge branch 'master' into default-nav-order 2020-04-25 09:52:50 +02:00
PLanCompS
0a81a86447 Merge remote-tracking branch 'upstream/master' 2020-04-25 09:21:00 +02:00
Matt Wang
ec75fa4f02 Merge branch 'master' into aux-links-new-tab 2020-04-24 13:02:09 -07:00
pmarsceill
91808528c9 🎨 Prettier 2020-04-24 19:55:49 +00:00
Patrick Marsceill
2539ed54a8 Merge bbd559e11d into 3ff76320ce 2020-04-24 19:55:14 +00:00
Patrick Marsceill
bbd559e11d update prettierignore 2020-04-24 15:55:07 -04:00
Patrick Marsceill
37fe8ca412 Update _config.yml 2020-04-24 15:52:19 -04:00
Patrick Marsceill
d02f668309 Merge branch 'SgtSilvio-improvement/custom-themes' into v0.2.9 2020-04-24 15:43:34 -04:00
Patrick Marsceill
955ac23149 Rm preview js 2020-04-24 15:41:13 -04:00
Patrick Marsceill
59d4802ce3 Merge branch 'improvement/custom-themes' of git://github.com/SgtSilvio/just-the-docs into SgtSilvio-improvement/custom-themes 2020-04-24 15:39:44 -04:00
pmarsceill
bc08659f50 🎨 Prettier 2020-04-24 19:29:01 +00:00
Patrick Marsceill
6edea8eb54 Merge d56b22a3ec into 3ff76320ce 2020-04-24 19:28:30 +00:00
Patrick Marsceill
d56b22a3ec Merge branch 'master' into v0.2.9 2020-04-24 15:28:28 -04:00
Patrick Marsceill
3ff76320ce Merge pull request #307 from pmarsceill/stylelint-plus-prettier
Fix Stylelint workflow and add prettier
2020-04-24 15:27:35 -04:00
Patrick Marsceill
02d3d3d825 Update package.json 2020-04-24 15:22:32 -04:00
Patrick Marsceill
7e28608e9d Update just-the-docs.gemspec 2020-04-24 15:22:04 -04:00
pmarsceill
6501990a44 🎨 Prettier 2020-04-24 19:20:29 +00:00
Patrick Marsceill
252e69f5cf Merge 94f5d6b018 into a11eaff97e 2020-04-24 19:19:56 +00:00
Patrick Marsceill
94f5d6b018 fix merge conflict 2020-04-24 15:19:49 -04:00
Patrick Marsceill
d07d465005 Merge branch 'stylelint-plus-prettier' of github.com:pmarsceill/just-the-docs into stylelint-plus-prettier 2020-04-24 15:17:52 -04:00
Patrick Marsceill
0ba819bb2d lets just use prettier and forget about it :D) 2020-04-24 15:17:14 -04:00
Patrick Marsceill
8340f9acd0 Fix prettier config 2020-04-24 15:09:51 -04:00
Patrick Marsceill
0716ea77d6 Merge pull request #250 from Labs64/pr-anonymize_ip
Enable IP anonymization in Google Analytics (GDPR)
2020-04-24 14:47:21 -04:00
R.Brown
c06eae8fa3 Update _config.yml
Co-Authored-By: Patrick Marsceill <pmarsceill@users.noreply.github.com>
2020-04-24 19:44:42 +02:00
R.Brown
5152912e5c Update docs/configuration.md
Co-Authored-By: Patrick Marsceill <pmarsceill@users.noreply.github.com>
2020-04-24 19:44:34 +02:00
R.Brown
17cf72bd33 Update _includes/head.html
Co-Authored-By: Patrick Marsceill <pmarsceill@users.noreply.github.com>
2020-04-24 19:44:25 +02:00
pmarsceill
c818624363 🎨 Prettier 2020-04-24 15:44:37 +00:00
Patrick Marsceill
9cf4451ea1 Merge 4197c26a36 into a11eaff97e 2020-04-24 15:44:02 +00:00
Patrick Marsceill
4197c26a36 Update ci.yml 2020-04-24 11:44:00 -04:00
Patrick Marsceill
cf748e7ef5 Update ci.yml 2020-04-24 11:39:50 -04:00
Patrick Marsceill
ec64bc1dce Update ci.yml 2020-04-24 11:25:28 -04:00
Patrick Marsceill
f3f3179644 Update ci.yml 2020-04-24 10:57:20 -04:00
Patrick Marsceill
db17dbac36 bump stylelint 2020-04-24 10:51:22 -04:00
Matt Wang
0c6d96abc3 Merge branch 'master' into aux-links-new-tab 2020-04-24 04:17:55 -07:00
Patrick Marsceill
bb36aac6bc Merge branch 'stylelint-plus-prettier' of github.com:pmarsceill/just-the-docs into stylelint-plus-prettier 2020-04-24 00:30:24 -04:00
Patrick Marsceill
d26bb0fa8f update package 2020-04-24 00:30:13 -04:00
Patrick Marsceill
3bd33abe5d Update ci.yml 2020-04-24 00:27:56 -04:00
Patrick Marsceill
73e658c34e Update ci.yml 2020-04-24 00:22:28 -04:00
Patrick Marsceill
3cd3fc8fe0 Update ci.yml 2020-04-24 00:20:41 -04:00
Patrick Marsceill
bc04ce25e6 Update ci.yml 2020-04-24 00:11:14 -04:00
Patrick Marsceill
3407f6c995 Temporarily add the JS file with liquid tokens so it wont fail 2020-04-24 00:08:41 -04:00
Patrick Marsceill
4da45d677c prettier config 2020-04-24 00:05:39 -04:00
Patrick Marsceill
7f1ffd393e prettier config 2020-04-24 00:03:12 -04:00
Patrick Marsceill
25ffab718a prettier config 2020-04-24 00:02:27 -04:00
Patrick Marsceill
a586e2b8d1 prettier config 2020-04-24 00:00:47 -04:00
Patrick Marsceill
0ba4685ee1 typo 2020-04-23 23:46:41 -04:00
Patrick Marsceill
4c022bd9ac Set up prettier 2020-04-23 23:45:43 -04:00
Patrick Marsceill
b27f5162c8 set up prettier 2020-04-23 23:42:57 -04:00
Patrick Marsceill
835526b901 Add pretter ignore 2020-04-23 23:38:59 -04:00
Patrick Marsceill
2ec9e67ec9 Merge pull request #217 from malsf21/master
feat: adds "edit this page" and "page last modified" to footer
2020-04-23 22:57:16 -04:00
Patrick Marsceill
1819d29c5b Update ci.yml 2020-04-23 22:55:09 -04:00
Patrick Marsceill
15674dae97 Update ci.yml 2020-04-23 22:50:37 -04:00
Patrick Marsceill
9f6a700d6e Update configuration.md 2020-04-23 22:44:07 -04:00
Patrick Marsceill
0507f77f4e Update _config.yml 2020-04-23 22:43:27 -04:00
Patrick Marsceill
3b2a55fd10 Update _config.yml 2020-04-23 22:42:59 -04:00
Patrick Marsceill
2faa91f235 Update default.html 2020-04-23 22:42:00 -04:00
Patrick Marsceill
60756a592d Update configuration.md 2020-04-23 22:41:29 -04:00
Patrick Marsceill
eecc51062b Update default.html 2020-04-23 22:39:11 -04:00
Patrick Marsceill
5d3b88a1e1 Update _config.yml 2020-04-23 22:38:45 -04:00
Patrick Marsceill
17153f001f Update _config.yml 2020-04-23 22:32:46 -04:00
Patrick Marsceill
8d54896986 Merge pull request #282 from blawqchain/patch-1
Update nav.html for handling nav_exclude
2020-04-23 22:26:55 -04:00
Patrick Marsceill
0680935092 Merge pull request #294 from moltenc/fix-title
Fix duplicated title and description tags
2020-04-23 22:25:30 -04:00
Patrick Marsceill
a11eaff97e Update ci.yml 2020-04-23 21:48:44 -04:00
Patrick Marsceill
8fd6eddcfd Merge pull request #305 from pmarsceill/v0.2.8
v0.2.8
2020-04-23 18:47:39 -04:00
Patrick Marsceill
463678623f Update package.json 2020-04-23 17:35:10 -04:00
Patrick Marsceill
0ff319b2ba Update ci.yml 2020-04-23 17:23:50 -04:00
Patrick Marsceill
e0032e07a5 Update ci.yml 2020-04-23 17:14:09 -04:00
Patrick Marsceill
eb6bba7fda Update ci.yml 2020-04-23 17:07:03 -04:00
Patrick Marsceill
fd50bb31a3 Update ci.yml 2020-04-23 16:16:43 -04:00
Patrick Marsceill
db2b790a69 Update ci.yml 2020-04-23 16:13:09 -04:00
Patrick Marsceill
48b1ab47b6 Update ci.yml 2020-04-23 16:12:44 -04:00
Patrick Marsceill
3c584e2d8a Merge pull request #218 from tiaitsch85/patch-1
bugfix in search.rake
2020-04-23 16:03:11 -04:00
Patrick Marsceill
81aad708f3 Update ci.yml 2020-04-23 16:01:12 -04:00
Patrick Marsceill
ec3bfecc1f Merge pull request #227 from pmarsceill/dependabot/bundler/rake-gte-12.3.1-and-lt-13.1.0
Update rake requirement from ~> 12.3.1 to >= 12.3.1, < 13.1.0
2020-04-23 15:49:33 -04:00
Patrick Marsceill
fbbf6a5d01 Merge pull request #247 from pmarsceill/dependabot/npm_and_yarn/stylelint-config-primer-9.0.0
Bump stylelint-config-primer from 8.0.0 to 9.0.0
2020-04-23 15:48:50 -04:00
Patrick Marsceill
b4711bfdf7 Merge pull request #268 from pmarsceill/dependabot/bundler/bundler-tw-2.1.4
Update bundler requirement from ~> 2.0.1 to ~> 2.1.4
2020-04-23 15:42:57 -04:00
Patrick Marsceill
74459588c9 Merge branch 'v0.2.8' into dependabot/bundler/bundler-tw-2.1.4 2020-04-23 15:37:27 -04:00
Patrick Marsceill
4a209f7f80 Update ci.yml 2020-04-23 15:29:33 -04:00
Patrick Marsceill
e5f53a8bfd Update ci.yml 2020-04-23 15:13:29 -04:00
Patrick Marsceill
1a0758dc13 Update just-the-docs.gemspec 2020-04-23 15:03:10 -04:00
Patrick Marsceill
71afb627d3 Update just-the-docs.gemspec 2020-04-23 15:00:50 -04:00
dependabot-preview[bot]
0892c32a1b Update bundler requirement from ~> 2.0.1 to ~> 2.1.4
Updates the requirements on [bundler](https://github.com/bundler/bundler) to permit the latest version.
- [Release notes](https://github.com/bundler/bundler/releases)
- [Changelog](https://github.com/bundler/bundler/blob/master/CHANGELOG.md)
- [Commits](https://github.com/bundler/bundler/compare/v2.0.1...v2.1.4)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-04-23 18:55:10 +00:00
Patrick Marsceill
7a7ce5ef7e Merge pull request #296 from pmarsceill/dependabot/npm_and_yarn/primer/css-14.3.0
Bump @primer/css from 12.7.0 to 14.3.0
2020-04-23 14:53:05 -04:00
Patrick Marsceill
cf78195f16 Merge pull request #197 from pmarsceill/dependabot/bundler/jekyll-gte-3.8.5-and-lt-4.1.0
Update jekyll requirement from ~> 3.8.5 to >= 3.8.5, < 4.1.0
2020-04-23 14:51:14 -04:00
Patrick Marsceill
a04f45dadd Merge pull request #303 from pmarsceill/add-discussions
Create config.yml
2020-04-23 14:44:00 -04:00
Patrick Marsceill
d70aa54ba7 Create config.yml 2020-04-23 14:40:32 -04:00
dependabot-preview[bot]
ac259f90d8 Bump @primer/css from 12.7.0 to 14.3.0
Bumps [@primer/css](https://github.com/primer/css) from 12.7.0 to 14.3.0.
- [Release notes](https://github.com/primer/css/releases)
- [Changelog](https://github.com/primer/css/blob/master/CHANGELOG.md)
- [Commits](https://github.com/primer/css/compare/v12.7.0...v14.3.0)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-03-26 12:40:25 +00:00
Silvio Giebl
f5e6573e16 Removed unnecessary rake command and files
Improved search documentation
2020-03-25 00:23:17 +01:00
Serge
aa8ca74883 Fix duplicated title and description tags
Currently just-the-docs renders two title and description tags
when used with jekyll-seo-tag. This patch fixes plugin detection
conditonal.
2020-03-22 22:51:37 -04:00
Scott V Kissinger
6f2065aa57 Update nav.html for handling nav_exclude
It appears nav_exclude only works on top level navigation items. I needed it to work at the child level as well. I believe these changes accomplish that for the child and grand_child levels.

Love this theme. I've used it a few times. Apologies if this pull request is not according to convention. This is the first time I've done it on someone else's code. Thanks!
2020-02-19 16:01:50 +08:00
Silvio Giebl
672de29f2e Exclude pages without title from nav (e.g. redirects) 2020-02-02 20:54:02 +01:00
Matthew Wang
da79e3e214 adds @bram1028's suggestion 2020-01-22 14:54:31 -08:00
Matthew Wang
9b86e292fa implements requested branch and edit mode configs 2020-01-12 13:47:05 -08:00
Silvio Giebl
e2e01effa6 Add fuzzy search if no results were found 2020-01-03 22:44:04 +01:00
Silvio Giebl
b13b44f18b Fixed stylelint 2020-01-03 08:58:38 +01:00
Silvio Giebl
d357532b4e Fixed stylelint 2020-01-03 08:57:29 +01:00
Silvio Giebl
157e3ff945 Fixed search result word wrap 2020-01-03 08:54:16 +01:00
Silvio Giebl
19e35329d2 Fixed search result word wrap 2020-01-02 14:32:51 +01:00
Silvio Giebl
757742e79c Fixed search result word wrap 2020-01-02 14:20:09 +01:00
Silvio Giebl
538591dddb Fixed search result word wrap 2020-01-02 13:18:39 +01:00
Silvio Giebl
a3d8c14609 Fixed css style 2020-01-02 11:59:52 +01:00
Silvio Giebl
f1c306c814 Multi search match highlight
Added multiple previews, configurable by site.search.previews
Improved search-data.json
2020-01-02 11:55:38 +01:00
Silvio Giebl
74681aeb21 Improved js function nesting 2020-01-01 16:50:31 +01:00
Silvio Giebl
c907e79251 Improved padding of active search input 2020-01-01 00:21:19 +01:00
Silvio Giebl
82b3f15443 Added search.button configuration
Improved documentation for search configurations
2019-12-29 21:30:44 +01:00
Silvio Giebl
2ef0029068 Add documentation for search configurations 2019-12-29 21:08:15 +01:00
Silvio Giebl
ff30552748 Moved config search_tokenizer_separator -> search.tokenizer_separator 2019-12-29 20:08:34 +01:00
Silvio Giebl
7f5b1f14f1 Search for sections (configurable via search.heading_level)
Added more search configurations
Display "no results found"
2019-12-29 19:19:00 +01:00
Silvio Giebl
38689d07b1 Improved search css 2019-12-18 21:32:33 +01:00
Silvio Giebl
0b4ed96f58 Added transition-duration scss variable 2019-12-18 21:02:07 +01:00
Silvio Giebl
b5c13965a7 Improved search css 2019-12-18 20:28:38 +01:00
Silvio Giebl
3576cb4a89 Fixed stylelint 2019-12-04 22:35:45 +01:00
Silvio Giebl
a6f2ed8c6c Improved search on mobile 2019-12-04 22:27:43 +01:00
Silvio Giebl
8310df593c Fixed css style 2019-12-04 18:11:44 +01:00
Silvio Giebl
1d1564e5c0 Improved search layout: scrolling, mobile 2019-12-04 10:39:30 +01:00
Silvio Giebl
9d24b14ba1 Fixed css style 2019-12-03 10:55:36 +01:00
Silvio Giebl
ab7e53b63f Fixed transition of search overlay 2019-12-03 10:52:17 +01:00
Silvio Giebl
abb7f55794 Fixed css style 2019-12-03 09:21:35 +01:00
Silvio Giebl
c057771cca Fixed css style 2019-12-03 09:20:22 +01:00
Silvio Giebl
804cad6c4d Improved search interface 2019-12-03 09:12:54 +01:00
Silvio Giebl
d66ebdec4b Improved showing/hiding search results on focus/blur 2019-12-01 16:26:23 +01:00
Silvio Giebl
5d87f3a9df Prefixed svg ids to not clash with normal ids 2019-12-01 15:51:48 +01:00
Silvio Giebl
0c9678c2e6 Fix search issues 2019-11-30 17:35:09 +01:00
Silvio Giebl
09944de128 Fixed scroll bar hiding on code blocks 2019-11-27 22:52:33 +01:00
Silvio Giebl
73047a078f Scroll page instead of nested div, removed nested divs 2019-11-27 22:07:22 +01:00
Silvio Giebl
cf64965554 Merge branch 'improvement/navigation' into improvement/search-button 2019-11-27 12:55:57 +01:00
Silvio Giebl
4bb8d7612d Fixed style lint 2019-11-27 12:52:44 +01:00
Silvio Giebl
078696415e Improved navigation active and highlight 2019-11-27 12:37:10 +01:00
Silvio Giebl
03979bf8fc Added documentation for custom color schemes and custom css 2019-11-27 11:15:57 +01:00
Silvio Giebl
301a4ab644 Merge branch 'improvement/navigation-merged' into improvement/search-button-merged
# Conflicts:
#	_layouts/default.html
2019-11-26 23:33:18 +01:00
Silvio Giebl
fd91140923 Merge branch 'master2' into improvement/navigation-merged
# Conflicts:
#	_layouts/default.html
2019-11-26 23:30:46 +01:00
Silvio Giebl
bb0e5222ca Merge branch 'master2' into improvement-custom-themes-merged 2019-11-26 23:27:33 +01:00
Peter Mosses
33d1e0f8d7 Update _config.yml
Trying to get the navigation to remain in the forked site
2019-11-16 15:23:29 +01:00
Peter Mosses
5f50531cce Update just-the-docs.gemspec
Trying to get the navigation to remain in the forked site
2019-11-16 15:20:43 +01:00
Peter Mosses
f978770956 Update just-the-docs.gemspec
Trying to get the navigation to remain in the forked site
2019-11-16 15:18:42 +01:00
Peter Mosses
367db86fff Update just-the-docs.gemspec
Trying to get the navigation to remain in the forked site
2019-11-16 15:14:54 +01:00
Peter Mosses
94c1dc3736 Hides dispay of grandchildren
Display of grandchildren links in the navigation is now delayed until their parent is selected.

To test, select the `Grandchildren test` node. Only the direct children should appear. Selecting one of them then shows its children.
2019-11-16 11:44:46 +01:00
Matthew Wang
2c94928917 oops, adds edit_link_text to layout 2019-11-13 23:06:23 -08:00
Alexey Averikhin
25331a5ffa Enable IP anonymization in Google Analytics (GDPR)
- Introduced "ga_tracking_anonymize_ip" parameter to enable/disable Google Analytics IP anonymization (to comply with GDPR).

(cherry picked from commit ce530f36fa0549c78ffe53ea6077f44f6f0b330f) (+1 squashed commit)
Squashed commits:
[69b7718] - enable GA anonymize_ip

(cherry picked from commit f2b67c632af72b61dd634b9a337200781519691e)
2019-11-12 10:27:01 +01:00
dependabot-preview[bot]
65e2759910 Bump stylelint-config-primer from 8.0.0 to 9.0.0
Bumps [stylelint-config-primer](https://github.com/primer/stylelint-config-primer) from 8.0.0 to 9.0.0.
- [Release notes](https://github.com/primer/stylelint-config-primer/releases)
- [Changelog](https://github.com/primer/stylelint-config-primer/blob/master/CHANGELOG.md)
- [Commits](https://github.com/primer/stylelint-config-primer/compare/v8.0.0...v9.0.0)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2019-10-30 14:34:16 +00:00
Kaspar Etter
c09f86cd1d Fix duplicate entries in default.html
Removes children from the table of contents that
belong to a different page with the same title.
2019-10-18 12:07:10 +02:00
Kaspar Etter
102d74c782 Fix duplicate entries in nav.html
This commit resolves #207.
2019-10-16 17:42:30 +02:00
Peter Mosses
06853e895a Update navigation-structure.md
Added documentation of default nav order.
2019-10-11 23:02:19 +01:00
Peter Mosses
210e060f18 Testing default nav order
The `nav_order` fields are removed from the children of the Utilities node, which results in alphabetic order.
2019-10-11 21:43:07 +01:00
Peter Mosses
6660f442b0 Alphabetic navigation order
When `nav_order` is omitted, the order of nodes at each menu level (and in the auto-generated TOC) is alphabetical by `title`, instead of random.
Any nodes with a specified `nav_order` precede all nodes at that level where it is omitted.
Note that `nav_order` fields must have a uniform site-ide type: integers and strings cannot be mixed, otherwise Jekyll reports errors.
The implementation filters the ordered and unordered pages from `site.html_pages`, sorts them separately, and concatenates the resulting arrays.
2019-10-11 21:40:34 +01:00
Matthew Wang
5549a15df9 adds option to make aux links open in new tab 2019-10-01 22:22:34 -07:00
dependabot-preview[bot]
a371a79f41 Update rake requirement from ~> 12.3.1 to >= 12.3.1, < 13.1.0
Updates the requirements on [rake](https://github.com/ruby/rake) to permit the latest version.
- [Release notes](https://github.com/ruby/rake/releases)
- [Changelog](https://github.com/ruby/rake/blob/master/History.rdoc)
- [Commits](https://github.com/ruby/rake/compare/v12.3.1...v13.0.0)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2019-09-27 12:32:23 +00:00
Matthew Wang
9c4622d75f implements conditional or on footer 2019-09-14 17:54:27 -07:00
websTTer
d3e97d31fa Update
duplicated from fix #80 
the same error in Version 2.0.7
fix with same procedure
2019-09-12 08:30:29 +02:00
Matthew Wang
e917ea1f10 Merge branch 'master' into master 2019-09-11 15:40:51 -07:00
Matthew Wang
4ff38dbe9c adds documentation 2019-09-11 15:36:36 -07:00
Matthew Wang
97efc81fa9 implements configuration for footer data and "edit this page" functionality 2019-09-11 15:31:47 -07:00
dependabot-preview[bot]
5fdb8f2e10 Update jekyll requirement from ~> 3.8.5 to >= 3.8.5, < 4.1.0
Updates the requirements on [jekyll](https://github.com/jekyll/jekyll) to permit the latest version.
- [Release notes](https://github.com/jekyll/jekyll/releases)
- [Changelog](https://github.com/jekyll/jekyll/blob/master/History.markdown)
- [Commits](https://github.com/jekyll/jekyll/compare/v3.8.5...v4.0.0)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2019-09-10 16:54:31 +00:00
Patrick Marsceill
8bd2da55fe Merge pull request #212 from pmarsceill/v0.2.7-release
v0.2.7 release
2019-09-10 12:53:16 -04:00
Patrick Marsceill
4ca741b1ce Update just-the-docs.gemspec 2019-09-10 12:46:05 -04:00
Patrick Marsceill
e6896e1997 Update package.json 2019-09-10 12:45:35 -04:00
Patrick Marsceill
492471b15f Merge branch 'master' into v0.2.7-release 2019-09-10 12:37:07 -04:00
Patrick Marsceill
efe5918871 Update base.scss 2019-09-10 12:36:54 -04:00
Patrick Marsceill
56e8119665 Update _lists.scss 2019-09-10 12:32:43 -04:00
Patrick Marsceill
8dbe7209b9 Update _lists.scss 2019-09-10 12:30:00 -04:00
Patrick Marsceill
72741e9498 Update _lists.scss 2019-09-10 12:26:46 -04:00
Patrick Marsceill
5391eb0a13 Update _lists.scss 2019-09-10 12:25:26 -04:00
Patrick Marsceill
20c7b97b3e Update index.md 2019-09-10 12:19:29 -04:00
Patrick Marsceill
1476259d9b Merge branch 'master' into v0.2.7-release 2019-09-10 12:05:54 -04:00
Patrick Marsceill
00c96ac2de Merge pull request #215 from pmarsceill/dependabot/npm_and_yarn/primer/css-12.7.0
Bump @primer/css from 12.6.0 to 12.7.0
2019-09-10 12:05:38 -04:00
Patrick Marsceill
f2ce1b33c1 Merge pull request #214 from pmarsceill/dependabot/npm_and_yarn/stylelint-config-primer-8.0.0
Bump stylelint-config-primer from 7.0.1 to 8.0.0
2019-09-10 12:05:14 -04:00
Patrick Marsceill
afbb385042 Merge pull request #213 from pmarsceill/dependabot/npm_and_yarn/mixin-deep-1.3.2
[Security] Bump mixin-deep from 1.3.1 to 1.3.2
2019-09-10 12:04:46 -04:00
Patrick Marsceill
35da800e88 Update index.md 2019-09-10 12:03:51 -04:00
Patrick Marsceill
54d9738dd1 Update README.md 2019-09-10 11:39:30 -04:00
Patrick Marsceill
c5e53d90c9 Update customization.md 2019-09-10 11:36:48 -04:00
Patrick Marsceill
01a3c35c98 Update search.rake 2019-09-10 11:29:10 -04:00
Patrick Marsceill
b49829c784 Update search.md 2019-09-10 11:26:14 -04:00
Patrick Marsceill
95bdc51a0a Update dark-mode-preview.js 2019-09-10 11:20:26 -04:00
dependabot-preview[bot]
1cca7a8e88 Bump @primer/css from 12.6.0 to 12.7.0
Bumps [@primer/css](https://github.com/primer/css) from 12.6.0 to 12.7.0.
- [Release notes](https://github.com/primer/css/releases)
- [Changelog](https://github.com/primer/css/blob/master/CHANGELOG.md)
- [Commits](https://github.com/primer/css/compare/v12.6.0...v12.7.0)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2019-09-10 10:59:08 +00:00
dependabot-preview[bot]
2c73d71c1b Bump stylelint-config-primer from 7.0.1 to 8.0.0
Bumps [stylelint-config-primer](https://github.com/primer/stylelint-config-primer) from 7.0.1 to 8.0.0.
- [Release notes](https://github.com/primer/stylelint-config-primer/releases)
- [Changelog](https://github.com/primer/stylelint-config-primer/blob/master/CHANGELOG.md)
- [Commits](https://github.com/primer/stylelint-config-primer/compare/v7.0.1...v8.0.0)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2019-09-10 10:58:37 +00:00
dependabot-preview[bot]
722717a0d1 [Security] Bump mixin-deep from 1.3.1 to 1.3.2
Bumps [mixin-deep](https://github.com/jonschlinkert/mixin-deep) from 1.3.1 to 1.3.2. **This update includes a security fix.**
- [Release notes](https://github.com/jonschlinkert/mixin-deep/releases)
- [Commits](https://github.com/jonschlinkert/mixin-deep/compare/1.3.1...1.3.2)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2019-09-10 10:57:42 +00:00
Matthew Wang
be5822cb86 adds page last modified above header 2019-09-09 19:43:33 -07:00
Matthew Wang
7c8ead0bff adds page last modified to footer 2019-09-09 19:31:23 -07:00
Patrick Marsceill
41187ed9b6 Merge pull request #205 from pdmosses/mathjax
Fix blank_lines var to blanklines in config.yml
2019-09-09 16:33:12 -04:00
Patrick Marsceill
3ae06cd59b Update search.md 2019-09-09 16:32:53 -04:00
Patrick Marsceill
7804642c50 Update search.md 2019-09-09 16:32:24 -04:00
Patrick Marsceill
b44ebe6cb3 Merge branch 'v0.2.7-release' into mathjax 2019-09-09 16:30:59 -04:00
Patrick Marsceill
423b8c9f46 Update _config.yml 2019-09-09 16:29:51 -04:00
Peter Mosses
a7285b9e30 Replace blank_lines by blanklines. 2019-09-09 22:26:32 +02:00
Peter Mosses
119a0b241e Revert "Mathjax support added"
This reverts commit 7220197a1f.
2019-09-09 22:22:22 +02:00
Patrick Marsceill
ff106641b0 syntax error 2019-09-09 16:09:05 -04:00
Patrick Marsceill
900639b02c Merge pull request #153 from jacobherrington/change-theme-button-text
Change button copy on theme preview
2019-09-09 16:06:33 -04:00
Patrick Marsceill
dbac62127a Merge branch 'v0.2.7-release' into change-theme-button-text 2019-09-09 16:06:21 -04:00
Patrick Marsceill
850a8fe256 Merge pull request #203 from pdmosses/search-config
Search config
2019-09-09 16:00:11 -04:00
Patrick Marsceill
44d689b994 Lint 2019-09-09 15:55:31 -04:00
Patrick Marsceill
9616dcf761 Update just-the-docs.js 2019-09-09 15:50:48 -04:00
Peter Mosses
1564ca4511 Update configuration.md
Added documentation for `search_tokenizer_separator`.
2019-09-09 21:50:05 +02:00
Patrick Marsceill
e124e10914 Merge pull request #200 from pmarsceill/dependabot/npm_and_yarn/mixin-deep-1.3.2
[Security] Bump mixin-deep from 1.3.1 to 1.3.2
2019-09-09 15:45:09 -04:00
Patrick Marsceill
757be1631c Merge pull request #208 from pmarsceill/dependabot/npm_and_yarn/primer/css-12.7.0
Bump @primer/css from 12.6.0 to 12.7.0
2019-09-09 15:43:46 -04:00
Patrick Marsceill
3b42ec2762 Merge pull request #206 from iamcarrico/allow-for-overrides
Allow for custom overrides by the user
2019-09-09 15:35:31 -04:00
Patrick Marsceill
a98bba778c Merge pull request #141 from ghabs/patch-1
Fix trailing comma bug in search-data.json
2019-09-09 15:32:26 -04:00
Patrick Marsceill
3ecdb59b48 Merge branch 'v0.2.7-release' into patch-1 2019-09-09 15:32:08 -04:00
Patrick Marsceill
843233c6b2 Merge pull request #187 from SgtSilvio/improvement/site-logo
Improvement/site logo
2019-09-09 15:10:55 -04:00
Patrick Marsceill
d3cbc83285 Merge pull request #188 from pdmosses/master
Update nav.html to eliminate generation of undisplayed elements
2019-09-09 15:09:22 -04:00
Patrick Marsceill
f960695bb7 Merge pull request #183 from SgtSilvio/improvement/heading-anchors
Improve heading anchors
2019-09-09 15:07:04 -04:00
Patrick Marsceill
34eaf8b16d Merge pull request #181 from m3nu/master
Recommend using index.md as parent page for sections
2019-09-09 15:05:12 -04:00
Patrick Marsceill
ea9affe25f Merge pull request #98 from stefanoborini/simplify-template
Introduces the possibility for a summary in the table of contents
2019-09-09 15:01:05 -04:00
Patrick Marsceill
d3f6e5907b Merge branch 'master' into simplify-template 2019-09-09 15:00:40 -04:00
dependabot-preview[bot]
3d0240ff0b Bump @primer/css from 12.6.0 to 12.7.0
Bumps [@primer/css](https://github.com/primer/css) from 12.6.0 to 12.7.0.
- [Release notes](https://github.com/primer/css/releases)
- [Changelog](https://github.com/primer/css/blob/master/CHANGELOG.md)
- [Commits](https://github.com/primer/css/compare/v12.6.0...v12.7.0)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2019-09-06 10:34:12 +00:00
Ian Carrico
1aee233e1f Add in some docs 2019-09-04 09:04:10 -04:00
Ian Carrico
47b7991805 Allow for custom overrides by the user 2019-09-04 08:55:11 -04:00
Peter Mosses
7220197a1f Mathjax support added
Mathjax config options added.
`compress_html` config option changed,
Mathjax script loaded by head when `page.mathjax` is truthy.
Documentation and test page added.
See also issue #198.
2019-08-31 23:19:03 +02:00
Peter Mosses
4e65041849 Revert "Add configuration option search_tokenizer_separator"
This reverts commit 50cdf076b4.
2019-08-31 16:52:41 +02:00
Peter Mosses
50cdf076b4 Add configuration option search_tokenizer_separator
The default is for hyphens to separate tokens in search terms: `gem-based` is equivalent to `gem based`.

This adds `search_tokenizer_separator` as a site configuation option, to support search for hyphenated words.
2019-08-29 15:36:13 +02:00
Peter Mosses
ed492bf40e Revert "Update .gitignore"
This reverts commit 13ef185010.
2019-08-29 14:45:09 +02:00
Peter Mosses
690d0b5e8a Revert "Update nav.html"
This reverts commit 0cfc0f0357.
2019-08-29 14:42:47 +02:00
Peter Mosses
5b74b44230 Revert "Optional delay of grandchildren link display"
This reverts commit 8ac545a5eb.
2019-08-29 14:42:23 +02:00
Peter Mosses
8a1e09ec5a Revert "Update nav.html"
This reverts commit c282e4b0a7.
2019-08-29 14:42:10 +02:00
Peter Mosses
cfbc7f41df Revert "Revert "Update nav.html""
This reverts commit 5d58a66301.
2019-08-29 14:41:21 +02:00
Peter Mosses
5e72b7db67 Revert "Revert "Optional delay of grandchildren link display""
This reverts commit 89f79138c3.
2019-08-29 14:41:09 +02:00
Peter Mosses
3af59176f4 Revert "Update nav.html"
This reverts commit 209ac7be7d.
2019-08-29 14:40:38 +02:00
Peter Mosses
13ef185010 Update .gitignore 2019-08-29 14:32:24 +02:00
dependabot-preview[bot]
7382a9a379 [Security] Bump mixin-deep from 1.3.1 to 1.3.2
Bumps [mixin-deep](https://github.com/jonschlinkert/mixin-deep) from 1.3.1 to 1.3.2. **This update includes a security fix.**
- [Release notes](https://github.com/jonschlinkert/mixin-deep/releases)
- [Commits](https://github.com/jonschlinkert/mixin-deep/compare/1.3.1...1.3.2)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2019-08-27 19:28:29 +00:00
Peter Mosses
209ac7be7d Update nav.html
Restrict navigation to display only direct children.
2019-08-22 21:45:09 +02:00
Peter Mosses
89f79138c3 Revert "Optional delay of grandchildren link display"
This reverts commit 8ac545a5eb.
2019-08-22 21:37:11 +02:00
Peter Mosses
5d58a66301 Revert "Update nav.html"
This reverts commit c282e4b0a7.
2019-08-22 07:58:09 +02:00
Peter Mosses
c282e4b0a7 Update nav.html
Separating new PR from #188, since indpendent.
2019-08-21 13:57:07 +02:00
Peter Mosses
8ac545a5eb Optional delay of grandchildren link display
The current default is that when a grandparent is selected, the links to its
children *and all its grandchildren* are displayed in the navigation menu.
Setting `grandchildren_branch: true` in `_config.yml` delays the display of links
to grandchildren until their parent is selected.
2019-08-21 13:49:07 +02:00
Silvio Giebl
3ed2d586fd Fixed stylelintrc.json 2019-08-17 16:07:09 +02:00
Silvio Giebl
95498ccaf8 Added just-the-docs-default.scss which includes the theme set in _config.yml 2019-08-17 15:02:53 +02:00
Silvio Giebl
91760ee8c9 Added documentation for logo variable 2019-08-17 14:46:28 +02:00
Silvio Giebl
132cecfea3 Added logo variable to _config.yml which can be set to a path/url
Automatically replaces the title with a logo
2019-08-17 14:32:25 +02:00
Peter Mosses
0cfc0f0357 Update nav.html
A `navigation-list-child-list` is not displayed unless the enclosing `navigation-list-item` is `active`, so it needs to be generated only when `page.url == node.url or page.parent == node.title or page.grand_parent == node.title`.
2019-08-16 13:32:24 +02:00
Silvio Giebl
bc1cbc1ae4 Fix css style
(cherry picked from commit 9cd348361b81537801cc1602557ac174a46be350)
2019-08-16 00:38:42 +02:00
Silvio Giebl
887a18daa0 Improved search button and results, added blur to content
(cherry picked from commit 99371e971406090a2dba7b9b69f514a8f87afce3)
2019-08-16 00:38:32 +02:00
Silvio Giebl
7c93bcc48f Fixed css style
(cherry picked from commit e5f2a27f0d48d041a3d63001c0b13230a6afdf6b)
2019-08-16 00:38:22 +02:00
Silvio Giebl
936a1e63be Fixed css style
(cherry picked from commit 4d52a68745672407bfb258eff055fb06756aac0e)
2019-08-16 00:38:20 +02:00
Silvio Giebl
cc0b57727d Added search button and menu icon
(cherry picked from commit 468264941d08b00252a4f6f081bc2dff5920bffe)
2019-08-16 00:38:03 +02:00
Silvio Giebl
52bcb26ddd Display nav-list-expander on the right side
(cherry picked from commit 2d6e97e0cbfb8bdcf87a2e5ad19bd59fc8f5405d)
2019-08-15 23:41:44 +02:00
Silvio Giebl
e13a62b7b5 Fixed js browser incompatibility
(cherry picked from commit 9f3f38acf4e1ac40e3fb2b2f86018d4cba28dd07)
2019-08-15 23:41:38 +02:00
Silvio Giebl
a5842c0d7b Fixed js browser incompatibility
(cherry picked from commit 86ff2dac05412a6ff994968c2be6122a7fcf85f9)
2019-08-15 23:41:35 +02:00
Silvio Giebl
6bd43a1332 Fixed js browser incompatibility
(cherry picked from commit d39b7b3041d1bdb9f80ab7f5878e64a3b3b79b5d)
2019-08-15 23:41:33 +02:00
Silvio Giebl
8e6e3dddd3 Improved navigation for mobile: larger nav items
(cherry picked from commit 5dce2adc2871e6814dbf42a658e6b364f4dc6641)
2019-08-15 23:41:28 +02:00
Silvio Giebl
bf86c33fe1 Added feedback color variable for nav item/search result hover
(cherry picked from commit f25d76730b175fb680aa2770fb20a67fd858ffbb)
2019-08-15 23:41:13 +02:00
Silvio Giebl
8a3458bafd Fixed multi line nav items
(cherry picked from commit 2a8901ff953004a2fc7cebde86bae6575cec2924)
2019-08-15 23:39:07 +02:00
Silvio Giebl
0ebbe4bb4e Improved navigation: folding, vsual feedback, optimization for mobile
(cherry picked from commit db50f282bab1e98397cc7434a811b8b7da2fe6dc)
2019-08-15 23:38:58 +02:00
Silvio Giebl
0a8138a6e0 Improved navigation
(cherry picked from commit 6684f7c7faa15d6d59df35fbff9ea6666634d754)
2019-08-15 23:30:34 +02:00
Silvio Giebl
ec420a385b Removed hardcoded styling from layout, improved aux nav
(cherry picked from commit fd3c68cd1a39e059180c35c1d56ffa33ef4dfde4)
2019-08-15 23:18:02 +02:00
Silvio Giebl
721ca36d85 Cleaned ids and classes
(cherry picked from commit 2b153ed074811e735aaa58d57a3fcdf7838e17f5)
2019-08-15 23:05:32 +02:00
Silvio Giebl
183778067b Fixed missing closing div in default.html, formatting 2019-08-15 22:56:24 +02:00
Silvio Giebl
ee8b901bcb Simplified nav nesting
(cherry picked from commit eeb3f342b17a744d0c2b2f0360359fa3276f8abd)
2019-08-15 22:50:29 +02:00
Silvio Giebl
6a46a4797e Improved site header for logo
(cherry picked from commit 97d1c663ef566ffe20fb1ec217fd2d8c1a8a2382)
2019-08-15 22:01:51 +02:00
Silvio Giebl
89a331ee85 Improved site header for logo
(cherry picked from commit 468bf8368783309e69fdcaa91f7eb5b1e05d96aa)
2019-08-15 22:01:51 +02:00
Silvio Giebl
d4b79e2eac Improved site header for logo
(cherry picked from commit 2a5c38907488b998af75e9a1ef2499428b8f1a78)
2019-08-15 22:01:51 +02:00
Silvio Giebl
d549d37e6f Fixed missing new lines 2019-08-15 20:12:57 +02:00
Silvio Giebl
2febd256db Added .liquid suffix to included scss files
(cherry picked from commit 7fb79c2018b979fdf917f427ca5d3f2451f3265d)
2019-08-15 19:53:06 +02:00
Silvio Giebl
3995fbfc35 More customizable css
(cherry picked from commit 8aa0899facd01f689692fccdb338673f5e9a9fbd)
2019-08-15 19:50:49 +02:00
Silvio Giebl
6c569cbdc2 Fixed custom css
(cherry picked from commit bab3437a1feefc49213e1e787db0451491aca9b9)
2019-08-15 19:49:59 +02:00
Silvio Giebl
9e0bc86dbe Simplified css color schemes
(cherry picked from commit 52b0bced5d235d7557413e064f3841ea774d9063)
2019-08-15 19:49:54 +02:00
Silvio Giebl
5f0de692be Fixed css style 2019-08-15 18:44:10 +02:00
Silvio Giebl
da50250f47 Fixed custom css
(cherry picked from commit 7df9af5ab1f4b7f1c286d176a8b24be9d3ce8063)
2019-08-15 18:37:06 +02:00
Silvio Giebl
f61b836f6e Fixed stylesheet link
(cherry picked from commit ac42a41ae3e36b002df52882be296c01873c0e5b)
2019-08-15 18:35:59 +02:00
Silvio Giebl
cba53a6914 Make themes more customizable
(cherry picked from commit dffb2706a158784e2f3091f895a868e373683bc8)
2019-08-15 18:35:10 +02:00
Silvio Giebl
fdf4726320 Anchor headings are now displayed on hover, not only on heading hover,
Deduplicated anchor heading svg,
Anchor heading svg is now centered for heading
2019-08-15 14:18:40 +02:00
Manu
de37d60720 Recommend using index.md as parent page for sections
Using `index.md` as name for the parent page within a section allows lazy developers
to skip defining `permalink`. This is already working and this PR just updates the documentation.
2019-08-15 09:38:44 +08:00
Patrick Marsceill
418cf1d640 Merge pull request #175 from pmarsceill/v0.2.6-release
v0.2.6 release
2019-08-14 17:22:17 -04:00
Patrick Marsceill
13427409aa Bump version number 2019-08-14 17:01:36 -04:00
Patrick Marsceill
26c16ce57e Update CI badge to use Actions 2019-08-14 17:01:19 -04:00
Patrick Marsceill
d01f0e29db Make search on by default 2019-08-14 16:43:59 -04:00
Patrick Marsceill
dfc5d112e5 make anchors on by default 2019-08-14 16:12:31 -04:00
Patrick Marsceill
c5cb03d0ca Fix link cut-off 2019-08-14 14:59:46 -04:00
Patrick Marsceill
61a5a3b334 Reverting this back 2019-08-14 14:42:25 -04:00
Patrick Marsceill
2b3da2f75c Update _config.yml 2019-08-14 14:31:50 -04:00
Patrick Marsceill
e17ae1fc54 Update default.html 2019-08-14 14:25:14 -04:00
Patrick Marsceill
d37387d408 lh-tight for wrapping titles 2019-08-14 11:14:15 -04:00
Patrick Marsceill
8726625133 Merge pull request #178 from pmarsceill/dependabot/npm_and_yarn/primer/css-12.6.0
Bump @primer/css from 12.3.1 to 12.6.0
2019-08-14 11:10:20 -04:00
Patrick Marsceill
03a89b761a Merge pull request #160 from pmarsceill/dependabot/npm_and_yarn/lodash-4.17.15
[Security] Bump lodash from 4.17.11 to 4.17.15
2019-08-14 11:09:48 -04:00
Patrick Marsceill
f6a3126543 Merge pull request #149 from pmarsceill/dependabot/npm_and_yarn/stylelint-config-primer-7.0.1
Bump stylelint-config-primer from 7.0.0 to 7.0.1
2019-08-14 11:09:08 -04:00
Patrick Marsceill
f4bd41a27d Merge branch 'v0.2.6-release' into dependabot/npm_and_yarn/stylelint-config-primer-7.0.1 2019-08-14 11:07:19 -04:00
Patrick Marsceill
2db3f97395 Merge pull request #143 from pmarsceill/dependabot/npm_and_yarn/stylelint-10.1.0
Bump stylelint from 10.0.1 to 10.1.0
2019-08-14 11:06:27 -04:00
Patrick Marsceill
385e26a2d0 Merge pull request #176 from pmarsceill/improve-search
Search improvement branch
2019-08-14 11:05:21 -04:00
Patrick Marsceill
5ad439b53c Merge branch 'v0.2.6-release' into improve-search 2019-08-14 11:03:30 -04:00
Patrick Marsceill
c4586e1725 Merge pull request #179 from pmarsceill/content-footer
Content footer
2019-08-14 10:55:28 -04:00
Patrick Marsceill
15172af270 Merge branch 'v0.2.6-release' into content-footer 2019-08-14 10:53:10 -04:00
Patrick Marsceill
f2cec110ff Add footer content docs 2019-08-14 10:50:49 -04:00
Patrick Marsceill
1a2636350f Merge branch 'v0.2.6-release' into improve-search 2019-08-14 10:43:59 -04:00
Patrick Marsceill
225604723a Fix docs and custom scss 2019-08-14 10:40:19 -04:00
Silvio Giebl
fe41e18994 Fix js and also bump out page content line height 2019-08-14 10:39:49 -04:00
Patrick Marsceill
3eadd49ee7 Fix new namespace on event 2019-08-14 10:08:01 -04:00
Patrick Marsceill
b1072a3fca Bump line-height on content 2019-08-14 10:07:45 -04:00
Silvio Giebl
c227db4406 Moved custom.js to includes 2019-08-14 10:07:36 -04:00
Silvio Giebl
4a574a2ec2 Fixed custom js 2019-08-14 09:57:27 -04:00
dependabot-preview[bot]
8e5b0f23e6 Bump @primer/css from 12.3.1 to 12.6.0
Bumps [@primer/css](https://github.com/primer/css) from 12.3.1 to 12.6.0.
- [Release notes](https://github.com/primer/css/releases)
- [Changelog](https://github.com/primer/css/blob/master/CHANGELOG.md)
- [Commits](https://github.com/primer/css/compare/v12.3.1...v12.6.0)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2019-08-14 10:24:15 +00:00
Patrick Marsceill
5867dc078f Add rel path to title matches 2019-08-13 17:34:42 -04:00
Patrick Marsceill
e370654237 Add a lil more padding on last table row 2019-08-13 17:34:28 -04:00
Patrick Marsceill
d0325e948e Fix up search results display 2019-08-13 17:24:36 -04:00
Patrick Marsceill
2b2ebf6033 Lint and docs 2019-08-13 17:24:23 -04:00
Patrick Marsceill
7fa6307640 Header menu button and anchor links 2019-08-13 17:23:35 -04:00
Patrick Marsceill
9e45626337 Merge branch 'improve-search' of github.com:pmarsceill/just-the-docs into improve-search 2019-08-13 16:24:28 -04:00
Patrick Marsceill
15f1faae8a Anchor heading css 2019-08-13 16:23:38 -04:00
Patrick Marsceill
8d60dda67e Make heading anchor link icon 2019-08-13 16:22:40 -04:00
Patrick Marsceill
da9c187acc Merge branch 'master' into improve-search 2019-08-13 14:15:12 -04:00
Patrick Marsceill
8dbe56fe1f Merge pull request #152 from yavorg/master
Fixing some Rouge styles for better JavaScript readability
2019-08-13 11:30:04 -04:00
Patrick Marsceill
1bf2ed0cde Merge pull request #159 from julienduchesne/optimize-nav-generation
Optimized nav generation
2019-08-13 11:24:13 -04:00
Patrick Marsceill
30590fd6c9 Merge pull request #109 from daviddarnes/patch-1
Make sure `baseurl` is appended to the logo href
2019-08-13 11:22:06 -04:00
Patrick Marsceill
15a9b310b3 Merge pull request #139 from pmarsceill/fix-code-snip
Fix jekyll highlight tag styles
2019-08-13 11:13:20 -04:00
Patrick Marsceill
4f5930dbbe Merge pull request #155 from hallowf/update-analytics-to-gtag
Replaced old script for analytics with gtag
2019-08-13 11:12:35 -04:00
Patrick Marsceill
3ad99afb02 Merge branch 'v0.2.6-release' into update-analytics-to-gtag 2019-08-13 11:12:15 -04:00
Patrick Marsceill
efbc5c2a19 Merge pull request #162 from nergmada/google-analytics-patch
Modified the google analytics code to match the new tags used by GA
2019-08-13 11:09:51 -04:00
Patrick Marsceill
14a3ff5fc8 Add publishing workflow (#172)
Publish to RubyGems and GPR on release
2019-08-09 22:33:42 -04:00
Patrick Marsceill
529c789739 upgrade-to-new-actions (#170)
Added GH Actions CI and removed Travis.
2019-08-09 14:55:53 -04:00
Patrick Marsceill
b89b683f90 Add content footer 2019-08-06 15:56:29 -04:00
Adam Green
aa0d8f1d40 Modified the google analytics code to match the new tags used by GA 2019-07-24 09:35:13 -04:00
dependabot-preview[bot]
b6bfd436b9 [Security] Bump lodash from 4.17.11 to 4.17.15
Bumps [lodash](https://github.com/lodash/lodash) from 4.17.11 to 4.17.15. **This update includes security fixes.**
- [Release notes](https://github.com/lodash/lodash/releases)
- [Commits](https://github.com/lodash/lodash/compare/4.17.11...4.17.15)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2019-07-19 16:58:07 +00:00
Julien Duchesne
07982f681a Optimized nav generation
- Trimmed whitespace between html elements
  This reduced one of my files from 850KB to 115KB
- Do not sort the whole list of pages on every iteration
  This made build 3x faster
2019-07-18 15:52:11 -04:00
hallowf
2d1babc452 Replaced old script for analytics with gtag 2019-07-04 15:52:01 +01:00
jacobherrington
eabe7b2585 Change button copy on theme preview
This commit makes the dark mode preview feel a little more interactive
and it also pulls some duplicated code into one file so that people like
me aren't stumped when they are looking at the wrong page!
2019-06-21 18:19:49 -05:00
Yavor Georgiev
0108a9b254 Fixing some Rouge styles for better JavaScript readability 2019-06-21 15:29:54 -07:00
dependabot-preview[bot]
9682368eaf Bump stylelint-config-primer from 7.0.0 to 7.0.1
Bumps [stylelint-config-primer](https://github.com/primer/stylelint-config-primer) from 7.0.0 to 7.0.1.
- [Release notes](https://github.com/primer/stylelint-config-primer/releases)
- [Changelog](https://github.com/primer/stylelint-config-primer/blob/master/CHANGELOG.md)
- [Commits](https://github.com/primer/stylelint-config-primer/compare/v7.0.0...v7.0.1)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2019-06-21 10:19:59 +00:00
David Darnes
761245d487 Merge branch 'master' into patch-1 2019-06-17 17:43:05 +01:00
dependabot-preview[bot]
4821abeec4 Bump stylelint from 10.0.1 to 10.1.0
Bumps [stylelint](https://github.com/stylelint/stylelint) from 10.0.1 to 10.1.0.
- [Release notes](https://github.com/stylelint/stylelint/releases)
- [Changelog](https://github.com/stylelint/stylelint/blob/master/CHANGELOG.md)
- [Commits](https://github.com/stylelint/stylelint/compare/10.0.1...10.1.0)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2019-06-07 15:06:32 +00:00
Ben Goldhaber
c8a8ce3314 Fix trailing comma bug in search-data.json
If you exclude the last page in the site.html_pages through exclude_true you end up violating the assumption in the for loop that the last page won't have a trailing comma. This breaks the json data that is served to the front end.

I removed the forloop.last check and instead assign a temporary variable to check for the first non-excluded page, and then add the comma before the next non-excluded entry.
2019-06-04 18:02:56 -07:00
Patrick Marsceill
044281db38 fix jekyll highlight tag styles 2019-05-28 23:06:14 -04:00
Silvio Giebl
008809e00b Include custom js, added js namespace 2019-05-19 20:40:54 +02:00
Silvio Giebl
96653f6d36 Simplified search-data.json 2019-05-19 20:08:31 +02:00
Silvio Giebl
9495640378 Improved search preview 2019-05-19 17:21:20 +02:00
Silvio Giebl
447ba4f20c Added variables for background colors 2019-05-19 02:55:43 +02:00
Silvio Giebl
48a4a37977 js fixes 2019-05-19 02:55:43 +02:00
Silvio Giebl
6f225b0d28 Improved search navigation 2019-05-19 02:55:43 +02:00
Silvio Giebl
e64a6aa239 Updated lunr.js, added search navigation and preview/highlighting 2019-05-19 02:55:43 +02:00
Silvio Giebl
e9f016ac0f Improved responsiveness of sidebar 2019-05-19 02:55:43 +02:00
Silvio Giebl
8c603aac1e Improved layout, unified spacing/font-sizes/border-radius/box-shadow 2019-05-19 02:55:43 +02:00
Silvio Giebl
0142d2874b Enabled customization of html head 2019-05-19 02:55:43 +02:00
Silvio Giebl
94f2aaf964 Added table wrappers, fixed anchor headings 2019-05-19 02:55:43 +02:00
Silvio Giebl
03e2345833 Added anchor headings 2019-05-19 02:55:43 +02:00
Silvio Giebl
f4ee29d0c3 Fixed script tags 2019-05-19 02:55:43 +02:00
Silvio Giebl
b3f52fedad Added html compression 2019-05-19 02:55:43 +02:00
Patrick Marsceill
721484a26e Merge pull request #132 from pmarsceill/v0.2.5-release
v0.2.5 release branch
2019-05-13 17:31:22 -04:00
Patrick Marsceill
3d01578c7d Update main.workflow 2019-05-13 17:23:16 -04:00
Patrick Marsceill
9663d4cba3 try this 2019-05-13 17:16:01 -04:00
Patrick Marsceill
552bf46bc9 not sure what happened here 2019-05-13 17:07:00 -04:00
Patrick Marsceill
6c5d550fa5 update deps 2019-05-13 17:04:16 -04:00
Patrick Marsceill
0f2de675b6 wrong layout 2019-05-13 17:04:06 -04:00
Patrick Marsceill
38521bd845 Put that back, wont build on GH page without it 2019-05-13 16:57:56 -04:00
Patrick Marsceill
a4da666d2a Add new liting rule disables 2019-05-13 16:55:22 -04:00
Patrick Marsceill
f1dcbec0a9 Merge pull request #123 from pmarsceill/dependabot/npm_and_yarn/stylelint-config-primer-7.0.0
Bump stylelint-config-primer from 6.0.0 to 7.0.0
2019-05-13 16:44:48 -04:00
Patrick Marsceill
e6f6001960 Merge pull request #129 from pmarsceill/dependabot/npm_and_yarn/@primer/css-12.3.1
Bump @primer/css from 12.2.3 to 12.3.1
2019-05-13 16:44:24 -04:00
Patrick Marsceill
501bd0169c Merge branch 'v0.2.5-release' of github.com:pmarsceill/just-the-docs into v0.2.5-release 2019-05-13 16:42:40 -04:00
Patrick Marsceill
f06cf593ff bump versions 2019-05-13 16:42:29 -04:00
Patrick Marsceill
460e9ae236 No title if SEO is enbaled 2019-05-13 16:40:28 -04:00
Patrick Marsceill
4d3375a834 Favicon file 2019-05-13 16:40:14 -04:00
Patrick Marsceill
3a3c4a83fa Fix subpath to avoid double slash 2019-05-13 16:40:01 -04:00
Patrick Marsceill
0254d9961a Update main.workflow 2019-05-13 16:37:01 -04:00
dependabot[bot]
d2b3d57eb9 Bump @primer/css from 12.2.3 to 12.3.1
Bumps [@primer/css](https://github.com/primer/css) from 12.2.3 to 12.3.1.
- [Release notes](https://github.com/primer/css/releases)
- [Changelog](https://github.com/primer/css/blob/master/CHANGELOG.md)
- [Commits](https://github.com/primer/css/compare/v12.2.3...v12.3.1)

Signed-off-by: dependabot[bot] <support@dependabot.com>
2019-05-10 10:21:45 +00:00
dependabot[bot]
32401d05a3 Bump stylelint-config-primer from 6.0.0 to 7.0.0
Bumps [stylelint-config-primer](https://github.com/primer/stylelint-config-primer) from 6.0.0 to 7.0.0.
- [Release notes](https://github.com/primer/stylelint-config-primer/releases)
- [Changelog](https://github.com/primer/stylelint-config-primer/blob/master/CHANGELOG.md)
- [Commits](https://github.com/primer/stylelint-config-primer/compare/v6.0.0...v7.0.0)

Signed-off-by: dependabot[bot] <support@dependabot.com>
2019-05-01 10:21:16 +00:00
Patrick Marsceill
9a076b48ac Merge pull request #122 from pmarsceill/v0.2.4-release
v0.2.4 release branch
2019-04-30 18:17:36 -07:00
Patrick Marsceill
2c789d408c Merge branch 'master' into v0.2.4-release 2019-04-30 18:14:27 -07:00
Patrick Marsceill
4fb036ebac Update main.workflow 2019-04-30 18:14:13 -07:00
Patrick Marsceill
f255c07c7f update for latest stylint config 2019-04-30 18:00:56 -07:00
Patrick Marsceill
ce2d213dbe Merge pull request #105 from pmarsceill/dependabot/npm_and_yarn/stylelint-config-primer-6.0.0
Bump stylelint-config-primer from 3.0.1 to 6.0.0
2019-04-30 17:41:34 -07:00
Patrick Marsceill
95b76010c2 Merge branch 'v0.2.4-release' into dependabot/npm_and_yarn/stylelint-config-primer-6.0.0 2019-04-30 17:40:42 -07:00
Patrick Marsceill
ca0af1795a Merge pull request #115 from pmarsceill/dependabot/npm_and_yarn/stylelint-10.0.1
Bump stylelint from 9.10.1 to 10.0.1
2019-04-30 17:38:20 -07:00
Patrick Marsceill
f9e03e1248 Merge pull request #95 from gebeto/master
Add SEO and 'lang' param for `_config`
2019-04-30 17:35:22 -07:00
Patrick Marsceill
c83bdf853e Merge pull request #97 from montchr/montchr-50-sass-custom-import-order
Import custom Sass variable overrides before default variables are defined
2019-04-30 17:32:53 -07:00
Patrick Marsceill
af77e527d0 Merge pull request #102 from JoeNyland/patch-1
Remove unnecessary console.log()
2019-04-30 17:30:33 -07:00
Patrick Marsceill
151691eb09 Merge pull request #117 from gnarea/gh-pages-local
Explain how to use theme locally with GitHub Pages
2019-04-30 17:27:46 -07:00
Patrick Marsceill
4de1bdaf65 Update index.md 2019-04-30 20:24:46 -04:00
Gus Narea
afaa3ab225 Explain how to use theme locally with GitHub Pages 2019-04-17 23:41:04 +01:00
dependabot[bot]
e356659dbe Bump stylelint from 9.10.1 to 10.0.1
Bumps [stylelint](https://github.com/stylelint/stylelint) from 9.10.1 to 10.0.1.
- [Release notes](https://github.com/stylelint/stylelint/releases)
- [Changelog](https://github.com/stylelint/stylelint/blob/master/CHANGELOG.md)
- [Commits](https://github.com/stylelint/stylelint/compare/9.10.1...10.0.1)

Signed-off-by: dependabot[bot] <support@dependabot.com>
2019-04-16 10:24:11 +00:00
David Darnes
9fb4bcfdc2 Make sure baseurl is appended to the logo href 2019-04-03 10:32:05 +01:00
dependabot[bot]
0ec44bd474 Bump stylelint-config-primer from 3.0.1 to 6.0.0
Bumps [stylelint-config-primer](https://github.com/primer/stylelint-config-primer) from 3.0.1 to 6.0.0.
- [Release notes](https://github.com/primer/stylelint-config-primer/releases)
- [Changelog](https://github.com/primer/stylelint-config-primer/blob/master/CHANGELOG.md)
- [Commits](https://github.com/primer/stylelint-config-primer/commits/v6.0.0)

Signed-off-by: dependabot[bot] <support@dependabot.com>
2019-03-19 10:33:34 +00:00
Joe Nyland
839cf91428 Remove unnecessary console.log() 2019-03-15 08:20:21 +00:00
Stefano Borini
2328407405 Removed indentation 2019-03-09 18:02:35 +00:00
Stefano Borini
b82b1a86d3 Shorter version that I assume should work. 2019-03-09 18:00:37 +00:00
Stefano Borini
c520591234 Merge pull request #2 from stefanoborini/adding-summary-for-toc-2
Adding summary for toc - 2
2019-03-09 17:50:28 +00:00
Stefano Borini
0b0b2e8555 Separating the summary from the link 2019-03-09 17:45:05 +00:00
Stefano Borini
26766a5984 Merge pull request #1 from stefanoborini/adding-summary-for-toc
Adding summary for toc
2019-03-09 17:27:26 +00:00
Stefano Borini
eec213daa1 Renamed excerpt to summary 2019-03-09 17:19:41 +00:00
Stefano Borini
c796485d92 Adds the possibility to specify a brief summary of a child page 2019-03-09 17:18:28 +00:00
Chris Montgomery
5291de45c5 Import custom overrides Sass before variables are used 2019-03-03 23:01:10 -05:00
gebeto
92fb6d1908 add jekyll-seo-tag to dependency to fix bundle crash 2019-02-28 09:08:27 +02:00
gebeto
8597aa4cac bump version to 0.2.4 2019-02-28 08:29:06 +02:00
gebeto
0bfd125087 add dynamic html 'lang' attribute 2019-02-28 08:11:12 +02:00
gebeto
25b6455ed7 add seo 2019-02-28 08:10:48 +02:00
Patrick Marsceill
b44efbf1da Merge pull request #89 from pmarsceill/github-action-for-release
Add main.workflow
2019-02-13 15:42:18 -05:00
Patrick Marsceill
8aa5982cd5 Add main.workflow 2019-02-06 14:54:07 -05:00
Patrick Marsceill
20f21217ca Merge pull request #86 from pmarsceill/v0.2.3
v0.2.3 Release Branch
2019-02-02 15:54:40 -08:00
Patrick Marsceill
96c053bb63 Merge branch 'master' into v0.2.3 2019-02-02 15:45:59 -08:00
Patrick Marsceill
d9a5bd0a19 lint 2019-02-02 17:43:14 -06:00
Patrick Marsceill
0ac8ec23bf Support for nesting ul in ol and vice versa 2019-02-02 17:38:36 -06:00
Patrick Marsceill
c40eec1c2f Merge pull request #87 from pmarsceill/feature-request
Update issue templates
2019-02-02 15:06:32 -08:00
Patrick Marsceill
de98c2b51b Update issue templates 2019-02-02 15:06:18 -08:00
Patrick Marsceill
c70f012eee Merge pull request #76 from pmarsceill/pmarsceill-patch-1
Add issue templates
2019-02-02 15:05:00 -08:00
Patrick Marsceill
aee6d1fb8c Use analytics.js instead of tag manager 2019-02-02 13:59:41 -08:00
Patrick Marsceill
f5d6cf6222 Add site url to config 2019-02-02 13:59:20 -08:00
Patrick Marsceill
f3fc9d9dd3 Update copyright date 2019-02-02 12:32:56 -08:00
Patrick Marsceill
a8c282ae5a Add docs for GA tracking 2019-02-02 12:32:33 -08:00
Patrick Marsceill
e12408d07b Add hook for GA tracking 2019-02-02 12:32:04 -08:00
Patrick Marsceill
a44d3a8652 Bump version numbers and description 2019-02-02 11:59:34 -08:00
Patrick Marsceill
ad867e37c0 move js class top parent div to fix page offset 2019-02-02 11:52:31 -08:00
Patrick Marsceill
01b500b1b3 Dont unesape this or it wont read the content var 2019-02-02 11:46:46 -08:00
Patrick Marsceill
84f8f003ac Merge pull request #73 from pmarsceill/dependabot/npm_and_yarn/stylelint-9.10.1
Bump stylelint from 9.9.0 to 9.10.1
2019-02-02 11:35:25 -08:00
Patrick Marsceill
ab20833d17 Merge pull request #77 from woernfl/patch-1
Just fixing a typo in the layout example
2019-02-02 11:33:23 -08:00
Patrick Marsceill
b77d22cf2e Merge pull request #81 from ilivewithian/patch-1
Bug: Can now show single search result.
2019-02-02 11:31:37 -08:00
Patrick Marsceill
35d7864874 Merge pull request #84 from novelistparty/master
fix #80 - escape the single quotes in the string
2019-02-02 11:27:01 -08:00
Patrick Marsceill
c9e4284754 Merge pull request #65 from stephenedmondson/master
search-data path fix
2019-02-02 11:22:53 -08:00
John Boyle
da0762007d escape the single quotes in the string 2019-01-31 10:02:06 -08:00
Rob White
5b8ff78bb6 Bug: Can now show single search result. 2019-01-29 13:39:20 +00:00
Florian Woerner
04e81c7158 Just fixing a typo in the layout example 2019-01-26 16:28:26 +01:00
Patrick Marsceill
b7913ec5a5 Update bug_report.md 2019-01-25 16:11:12 -05:00
Patrick Marsceill
25250db5e0 Add issue templates 2019-01-25 16:08:27 -05:00
dependabot[bot]
75f0ef57e2 Bump stylelint from 9.9.0 to 9.10.1
Bumps [stylelint](https://github.com/stylelint/stylelint) from 9.9.0 to 9.10.1.
- [Release notes](https://github.com/stylelint/stylelint/releases)
- [Changelog](https://github.com/stylelint/stylelint/blob/master/CHANGELOG.md)
- [Commits](https://github.com/stylelint/stylelint/compare/9.9.0...9.10.1)

Signed-off-by: dependabot[bot] <support@dependabot.com>
2019-01-23 19:07:26 +00:00
Patrick Marsceill
eaafeee675 Merge pull request #74 from pmarsceill/v0.2.2
v0.2.2
2019-01-23 14:04:51 -05:00
Patrick Marsceill
10c0f95b40 Update just-the-docs.gemspec 2019-01-23 13:56:56 -05:00
Patrick Marsceill
8da9b82d66 Update package.json 2019-01-23 13:56:15 -05:00
Patrick Marsceill
b0e1c64a5a v0.2.2 release
v0.2.2 release branch
2019-01-23 13:54:12 -05:00
Patrick Marsceill
e1d226f192 Merge pull request #69 from bmann/patch-1
page layout also used out of the box by Jekyll
2019-01-23 13:51:26 -05:00
Patrick Marsceill
2de780bb4b Merge pull request #70 from EricFromCanada/improve-search
Improve search data generation
2019-01-23 13:19:08 -05:00
EricFromCanada
60c82cb518 Allow for ampersand in title or URL
Because `page.title` (and `page.url`) is already escaped and page titles served by lunrjs do not need escaping, ampersands need to be unescaped to display properly in search results.
2019-01-16 00:31:30 -05:00
EricFromCanada
9a4ea76957 Improve search content generator 2019-01-15 22:54:30 -05:00
EricFromCanada
793ea356c3 Use unless loop for comma
and mention `search_exclude`
2019-01-15 20:48:52 -05:00
EricFromCanada
71ba32e131 Additional text fixes 2019-01-15 20:48:48 -05:00
Boris Mann
37d54f5bf2 page layout also used out of the box by Jekyll
Suggesting page, since `about.md` uses it for new Jekyll installs as well.
2019-01-15 10:52:32 -08:00
Patrick Marsceill
ce947ae543 Merge pull request #67 from EricFromCanada/doc-cleanup
Documentation cleanup
2019-01-15 10:49:04 -05:00
EricFromCanada
2218e6e565 Fix links and syntax
For pages in utilities/, reorder `nav_order` to follow `parent`.
2019-01-14 14:43:33 -05:00
EricFromCanada
ae5bcfe361 Fix grammar and capitalization 2019-01-14 14:43:29 -05:00
EricFromCanada
ff49d02f83 Make spacing consistent 2019-01-14 14:43:16 -05:00
Stephen Edmondson
d7b1adb8c7 search-data path fix 2019-01-11 12:41:00 -06:00
Patrick Marsceill
b3fb5ebd87 Merge pull request #61 from pmarsceill/dependabot/bundler/bundler-tw-2.0.1
Update bundler requirement from ~> 1.17.1 to ~> 2.0.1
2019-01-07 10:44:05 -05:00
Patrick Marsceill
79a8cda356 Merge pull request #44 from pmarsceill/dependabot/npm_and_yarn/stylelint-config-primer-3.0.1
Bump stylelint-config-primer from 3.0.0 to 3.0.1
2019-01-07 10:43:34 -05:00
Patrick Marsceill
ae3f570370 Fix some styling bugs 2019-01-06 15:51:30 -05:00
Patrick Marsceill
f17700afe3 Better search index 2019-01-06 15:51:17 -05:00
Patrick Marsceill
269271a8d7 Add a page description 2019-01-06 15:50:57 -05:00
Patrick Marsceill
09cc61c25f Moar A11y updates 2019-01-06 15:50:31 -05:00
Patrick Marsceill
06c8acc06b Lol we forgot the body tag 2019-01-06 15:50:01 -05:00
Patrick Marsceill
a3ae6ad74e A11y updates 2019-01-06 15:49:26 -05:00
Patrick Marsceill
f264034999 If page has a description use that for meta data 2019-01-06 15:48:58 -05:00
dependabot[bot]
2b0ff701fa Update bundler requirement from ~> 1.17.1 to ~> 2.0.1
Updates the requirements on [bundler](https://github.com/bundler/bundler) to permit the latest version.
- [Release notes](https://github.com/bundler/bundler/releases)
- [Changelog](https://github.com/bundler/bundler/blob/v2.0.1/CHANGELOG.md)
- [Commits](https://github.com/bundler/bundler/commits/v2.0.1)

Signed-off-by: dependabot[bot] <support@dependabot.com>
2019-01-04 10:18:33 +00:00
Patrick Marsceill
4a9b4fd5b1 lint 2018-12-16 15:29:06 -05:00
Patrick Marsceill
d5d1ddbd92 Docs update 2018-12-16 15:27:25 -05:00
Patrick Marsceill
39828f0775 A nicer 404 2018-12-16 15:24:00 -05:00
Patrick Marsceill
954e8941bb Accidental reversal 2018-12-16 15:23:33 -05:00
Patrick Marsceill
20970ca9e6 Better code scrolling for touch 2018-12-16 15:23:18 -05:00
Patrick Marsceill
eaf1247911 Auto focus main content for keyboard scrolling 2018-12-16 15:22:51 -05:00
Patrick Marsceill
eb0a6c328f Allow pages to be excluded from search 2018-12-16 14:47:41 -05:00
Patrick Marsceill
ed33ab18ac Exclude package-lock.json from jekyll build 2018-12-16 14:29:35 -05:00
Patrick Marsceill
555dfae410 Make TOC on parent pages optional 2018-12-16 14:27:44 -05:00
Patrick Marsceill
309b238400 Merge pull request #51 from flut1/master
Fix charset for list item content in scss
2018-12-13 11:16:27 -05:00
Floris Bernard
2caefa4e9e Fix charset for list item content in scss 2018-12-12 14:33:02 +01:00
dependabot[bot]
e4dd35083a Bump stylelint-config-primer from 3.0.0 to 3.0.1
Bumps [stylelint-config-primer](https://github.com/primer/primer) from 3.0.0 to 3.0.1.
- [Release notes](https://github.com/primer/primer/releases)
- [Changelog](https://github.com/primer/primer/blob/master/CHANGELOG.md)
- [Commits](https://github.com/primer/primer/compare/v3.0.0...v3.0.1)

Signed-off-by: dependabot[bot] <support@dependabot.com>
2018-11-30 10:25:20 +00:00
Patrick Marsceill
80bbdb7be8 Merge pull request #43 from pmarsceill/v0.2.1
v0.2.1 release
2018-11-29 11:43:28 -05:00
Patrick Marsceill
c5a9be9298 Bump JTD version numbers 2018-11-29 11:33:43 -05:00
dependabot[bot]
5b9cde1dc4 Bump stylelint-config-primer from 2.2.11 to 3.0.0
Bumps [stylelint-config-primer](https://github.com/primer/primer) from 2.2.11 to 3.0.0.
- [Release notes](https://github.com/primer/primer/releases)
- [Changelog](https://github.com/primer/primer/blob/master/CHANGELOG.md)
- [Commits](https://github.com/primer/primer/commits/v3.0.0)

Signed-off-by: dependabot[bot] <support@dependabot.com>
2018-11-29 11:32:19 -05:00
Patrick Marsceill
1064d50f8c Merge branch 'dependabot/npm_and_yarn/stylelint-9.9.0' into v0.2.1 2018-11-29 11:28:25 -05:00
dependabot[bot]
b35b697dc2 Bump stylelint from 7.13.0 to 9.9.0
Bumps [stylelint](https://github.com/stylelint/stylelint) from 7.13.0 to 9.9.0.
- [Release notes](https://github.com/stylelint/stylelint/releases)
- [Changelog](https://github.com/stylelint/stylelint/blob/master/CHANGELOG.md)
- [Commits](https://github.com/stylelint/stylelint/compare/7.13.0...9.9.0)

Signed-off-by: dependabot[bot] <support@dependabot.com>
2018-11-29 16:19:16 +00:00
dependabot[bot]
f6003ec47d [Security] Bump lodash from 4.17.4 to 4.17.11
Bumps [lodash](https://github.com/lodash/lodash) from 4.17.4 to 4.17.11. **This update includes security fixes.**
- [Release notes](https://github.com/lodash/lodash/releases)
- [Changelog](https://github.com/lodash/lodash/blob/master/CHANGELOG)
- [Commits](https://github.com/lodash/lodash/compare/4.17.4...4.17.11)

Signed-off-by: dependabot[bot] <support@dependabot.com>
2018-11-29 11:09:46 -05:00
Patrick Marsceill
dc47cec4aa Merge pull request #29 from folbert/aux-link-documentation-fix
Indented the title for aux_link
2018-11-26 11:29:59 -05:00
Patrick Marsceill
6b213c2da0 Additional ident 2018-11-26 11:26:44 -05:00
Björn Folbert
860207d13c Indented the title for aux_link
The indent is required for the aux links to work.
2018-11-24 00:21:57 +01:00
Patrick Marsceill
21990474d0 Merge pull request #23 from pmarsceill/v0.2.0
v0.2.0 release
2018-11-19 16:34:46 -05:00
Patrick Marsceill
cd55ce0089 Bumb version numbers 2018-11-19 16:33:25 -05:00
Patrick Marsceill
c20129c32c update docs for nav / page strucutre 2018-11-19 16:26:22 -05:00
Patrick Marsceill
dac6e45451 Update docs 2018-11-19 13:50:54 -05:00
Patrick Marsceill
3ecef3be5c jk 2018-11-19 13:37:49 -05:00
Patrick Marsceill
74b468058a Better breadcrumb alignment 2018-11-19 13:29:17 -05:00
Patrick Marsceill
960d347f68 Support 3 levels of pages 2018-11-19 13:28:59 -05:00
Patrick Marsceill
3573db5d34 Merge pull request #24 from pmarsceill/dark-mode
Dark mode
2018-11-19 10:32:12 -05:00
Patrick Marsceill
dc29db592f Update bundler version 2018-11-19 10:29:30 -05:00
Patrick Marsceill
805eadb4bb exclude dark mode manifest 2018-11-18 11:09:18 -05:00
Patrick Marsceill
f0bb38e1b8 Clean up colors and docs 2018-11-18 11:07:45 -05:00
Patrick Marsceill
b52f66a2ee Turn off dark by default 2018-11-18 11:06:59 -05:00
Patrick Marsceill
100b7277b3 Merge branch 'v0.2.0' of github.com:pmarsceill/just-the-docs into dark-mode 2018-11-17 16:25:58 -05:00
Patrick Marsceill
28bafabd72 lint 2018-11-17 16:25:26 -05:00
Patrick Marsceill
559e210503 Lint 2018-11-16 15:04:31 -05:00
Patrick Marsceill
4814fbce64 Content cleanup 2018-11-16 14:55:20 -05:00
Patrick Marsceill
2568b05fe7 Don't break links in body 2018-11-16 14:54:46 -05:00
Patrick Marsceill
7c24af0745 Add remote-theme docs 2018-11-16 14:37:28 -05:00
Patrick Marsceill
410085dd28 Content cleanup 2018-11-16 14:37:00 -05:00
Patrick Marsceill
bfce0f57d3 Fix bug on code snippets causing double padding. 2018-11-16 14:36:26 -05:00
Patrick Marsceill
379a976387 Add docs for nav exclude 2018-11-16 13:57:49 -05:00
Patrick Marsceill
6540493df2 Add condition for nav exclude 2018-11-16 13:57:32 -05:00
Patrick Marsceill
6ecde7eeec Remove this as it was taken out in 0.1.6 2018-11-16 13:41:26 -05:00
Patrick Marsceill
8f6f4b761a Merge branch 'master' of github.com:pmarsceill/just-the-docs into dark-mode 2018-11-16 12:40:35 -05:00
Patrick Marsceill
fa40528acd Merge pull request #20 from pmarsceill/v0.1.6
v0.1.6 release
2018-11-16 12:01:17 -05:00
Patrick Marsceill
0a5edea9d8 Merge pull request #19 from pmarsceill/task-lists
Task lists
2018-11-16 11:54:02 -05:00
Patrick Marsceill
32b708cb58 whitespace 2018-11-16 11:49:29 -05:00
Patrick Marsceill
b98cac8620 Add new configuration docs 2018-11-16 11:47:46 -05:00
Patrick Marsceill
c6ca6f61ab Update docs for search config 2018-11-16 11:47:30 -05:00
Patrick Marsceill
e41c1701a5 Bump nav order for new docs 2018-11-16 11:47:14 -05:00
Patrick Marsceill
d11e332dc6 Create condition for no search and add config/css 2018-11-16 11:46:43 -05:00
Patrick Marsceill
45eea0efb6 Add docs for lists 2018-11-16 10:57:07 -05:00
Patrick Marsceill
3730de18ea Add support for task lists 2018-11-16 10:56:50 -05:00
Patrick Marsceill
4b8e051303 Merge pull request #18 from pmarsceill/pull-in-normalize
Fix normalize dependency
2018-11-16 10:34:41 -05:00
Patrick Marsceill
3418332411 Forgot the slash 😬 2018-11-16 10:28:47 -05:00
Patrick Marsceill
bde21167f4 Move normalize folder to vendor 2018-11-16 10:25:45 -05:00
Patrick Marsceill
5ac39f75a1 move this to vendor so stylelint shuts up 2018-11-16 10:25:18 -05:00
Patrick Marsceill
1ef94683df package lock 2018-11-15 16:18:48 -05:00
Patrick Marsceill
35c98605d7 Bump versions 2018-11-15 16:18:19 -05:00
Patrick Marsceill
11a4269d1c Ignore normalize.scss 2018-11-15 16:18:07 -05:00
Patrick Marsceill
2f7d0f18a5 Remove node_modules files 2018-11-15 16:17:52 -05:00
Patrick Marsceill
8968860b4b Ignore node modules 2018-11-15 16:17:29 -05:00
Patrick Marsceill
aa5a4e529c Linting rule 2018-11-15 15:59:23 -05:00
Patrick Marsceill
a0251b32d1 update linting rules 2018-11-15 15:56:00 -05:00
Patrick Marsceill
8d144f1530 fix style bug 2018-11-15 15:51:10 -05:00
Patrick Marsceill
af3e9f07c7 No longer need this build process 2018-11-15 15:49:41 -05:00
Patrick Marsceill
aa4ec995cd Remove this as normalize is now in the _sass dir 2018-11-15 15:49:14 -05:00
Patrick Marsceill
657ce6b750 add-in-normalize 2018-11-15 15:35:46 -05:00
Patrick Marsceill
ee4759c772 Rip out hard-coded color 2018-11-15 15:13:16 -05:00
Patrick Marsceill
3acf927eb7 Add dark mode theme 2018-11-15 15:13:02 -05:00
Patrick Marsceill
b7db5e73a3 Bump version and deps 2018-11-15 15:12:33 -05:00
Patrick Marsceill
9c70c7f081 Convert colors to vars 2018-11-15 15:12:12 -05:00
Patrick Marsceill
d5ef35c5a4 Merge pull request #14 from joesb/patch-1
Search documentation - snippet is missing `relUrl`
2018-11-15 14:53:25 -05:00
Joe Baker
aa9a68b1be Search documentation - snippet is missing relUrl
The code snippet on the search documentation is missing the `relUrl` parameter in each search result, and the `url` parameter is not an absolute URL.
This updates to match the formatted output of `search.rake`
2018-11-06 16:50:32 +00:00
Patrick Marsceill
94d640b80e Update README.md 2018-10-26 11:31:38 -04:00
Patrick Marsceill
f92fd09a12 Update README.md 2018-10-26 11:27:56 -04:00
Patrick Marsceill
d8a90f70c1 Update README.md 2018-10-26 11:05:46 -04:00
Patrick Marsceill
11ee5e7762 Update README.md 2018-10-26 11:04:36 -04:00
Patrick Marsceill
74693a0b2a Merge pull request #13 from pmarsceill/add-ci
Add CI for testing
2018-10-25 12:43:05 -04:00
Patrick Marsceill
6400e79e02 Update README.md 2018-10-25 11:22:11 -04:00
Patrick Marsceill
6a6efba27a fix linting / rules 2018-10-25 11:17:10 -04:00
Patrick Marsceill
d554236ba3 Update .travis.yml 2018-10-25 11:00:40 -04:00
Patrick Marsceill
6d14c454f1 Update package.json 2018-10-25 10:54:17 -04:00
Patrick Marsceill
9d51b4601c Update .travis.yml 2018-10-25 10:53:28 -04:00
Patrick Marsceill
62fc067441 Update .travis.yml 2018-10-25 10:53:03 -04:00
Patrick Marsceill
ea61589b12 Add travis yaml 2018-10-25 10:48:35 -04:00
Patrick Marsceill
89f9c5f38c Merge pull request #12 from jakebresnehan/patch-1
Update README.md
2018-10-25 10:41:21 -04:00
Jake Bresnehan
caf5311feb Update README.md 2018-10-25 18:40:36 +11:00
Patrick Marsceill
3a32d20f18 Merge pull request #11 from pmarsceill/rake-mkdir
rake search:init fails if dirs don't exist
2018-10-24 16:45:43 -04:00
Patrick Marsceill
651ed922b0 Just the Docs build packaging cleanup 2018-10-24 16:39:13 -04:00
Patrick Marsceill
64ed5ef369 Just the Docs build packaging 2018-10-24 16:39:13 -04:00
Patrick Marsceill
82e1873460 bump version number 2018-10-24 16:39:03 -04:00
Patrick Marsceill
46782d9352 Rake fails when dirs dont exist 2018-10-24 16:34:11 -04:00
Patrick Marsceill
d558234885 Merge pull request #10 from pmarsceill/rake-runtime
Rake runtime
2018-10-24 14:25:11 -04:00
4259 changed files with 12101 additions and 400872 deletions

38
.github/ISSUE_TEMPLATE/bug_report.md vendored Normal file
View File

@@ -0,0 +1,38 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: bug
assignees: ''
---
**Describe the bug**
A clear and concise description of what the bug is.
**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
**Expected behavior**
A clear and concise description of what you expected to happen.
**Screenshots**
If applicable, add screenshots to help explain your problem.
**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]
**Smartphone (please complete the following information):**
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]
**Additional context**
Add any other context about the problem here.

5
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View File

@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Ask a question
url: https://github.com/pmarsceill/just-the-docs/discussions
about: Ask questions and discuss with other community members

View File

@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: enhancement
assignees: ''
---
**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
**Describe the solution you'd like**
A clear and concise description of what you want to happen.
**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.
**Additional context**
Add any other context or screenshots about the feature request here.

35
.github/release-drafter.yml vendored Normal file
View File

@@ -0,0 +1,35 @@
references:
- v+
- master
name-template: 'v$RESOLVED_VERSION 🌈'
tag-template: 'v$RESOLVED_VERSION'
categories:
- title: '🚀 Features'
labels:
- 'feature'
- 'enhancement'
- title: '🐛 Bug Fixes'
labels:
- 'fix'
- 'bugfix'
- 'bug'
- title: '🧰 Maintenance'
label:
- 'chore'
- 'dependencies'
change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
version-resolver:
major:
labels:
- 'next-major-release'
minor:
labels:
- 'next-minor-release'
patch:
labels:
- 'patch'
default: minor
template: |
## Changes
$CHANGES

45
.github/workflows/ci-master.yml vendored Normal file
View File

@@ -0,0 +1,45 @@
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

44
.github/workflows/ci.yml vendored Normal file
View File

@@ -0,0 +1,44 @@
on: [pull_request]
name: CI
jobs:
jekyll-latest:
name: Build Jekyll site (latest)
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: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"
assets:
name: 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

39
.github/workflows/publish.yml vendored Normal file
View File

@@ -0,0 +1,39 @@
name: Publish Gem
on: [release]
jobs:
build:
name: Build + Publish
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- name: Set up Ruby 2.6
uses: actions/setup-ruby@v1
with:
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
gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
env:
GEM_HOST_API_KEY: ${{secrets.GPR_AUTH_TOKEN}}
OWNER: pmarsceill
- name: Publish to RubyGems
run: |
mkdir -p $HOME/.gem
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 push *.gem
env:
GEM_HOST_API_KEY: ${{secrets.RUBYGEMS_AUTH_TOKEN}}

3
.gitignore vendored
View File

@@ -1,5 +1,8 @@
*.gem
.bundle
.ruby-version
.jekyll-cache
.sass-cache
_site
Gemfile.lock
node_modules

9
.prettierignore Normal file
View File

@@ -0,0 +1,9 @@
package.json
package-lock.json
_site
assets/css/just-the-docs-default.scss
assets/css/just-the-docs-light.scss
assets/css/just-the-docs-dark.scss
assets/js/vendor/lunr.min.js
assets/js/search-data.json
assets/js/just-the-docs.js

8
.prettierrc Normal file
View File

@@ -0,0 +1,8 @@
{
"endOfLine": "lf",
"semi": false,
"singleQuote": false,
"tabWidth": 2,
"trailingComma": "es5"
}

View File

@@ -1,5 +1,13 @@
{
"extends": [
"stylelint-config-primer"
]
"ignoreFiles": [
"assets/css/just-the-docs-default.scss",
"assets/css/just-the-docs-light.scss",
"assets/css/just-the-docs-dark.scss",
"_sass/vendor/**/*.scss"
],
"extends": ["stylelint-config-primer", "stylelint-config-prettier"],
"plugins": ["stylelint-prettier"],
"rules": {
"prettier/prettier": true
}
}

11
404.html Normal file
View File

@@ -0,0 +1,11 @@
---
layout: default
title: 404
permalink: /404
nav_exclude: true
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>

13
Dockerfile Normal file
View File

@@ -0,0 +1,13 @@
FROM ruby:2.6
ENV LC_ALL C.UTF-8
ENV LANG en_US.UTF-8
ENV LANGUAGE en_US.UTF-8
WORKDIR /usr/src/app
COPY Gemfile just-the-docs.gemspec ./
RUN gem install bundler && bundle install
EXPOSE 4000

View File

@@ -1,10 +1,16 @@
# Just the Docs
A nice looking, high customizable, responsive Jekyll theme for documention with built-in search. Easily hosted on GitHub pages.
<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>
</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>
<br><br><br>
</p>
![jtd](https://user-images.githubusercontent.com/896475/47384541-89053c80-d6d5-11e8-98dc-dba16e192de9.gif)
## Installation
Add this line to your Jekyll site's Gemfile:
@@ -27,6 +33,10 @@ Or install it yourself as:
$ gem install just-the-docs
Alternatively, you can run it inside Docker while developing your site
$ docker-compose up
## Usage
[View the documentation](https://pmarsceill.github.io/just-the-docs/) for usage information.
@@ -35,24 +45,28 @@ Or install it yourself as:
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.
### Submitting code changes:
- Open a [Pull Request](https://github.com/pmarsceill/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/).
### Design and development principles of this theme:
1. As few dependencies as possible
2. No build script needed
3. First class mobile experience
4. Make the content shine
## Development
To set up your environment to develop this theme, run `bundle install`.
Your theme is setup 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.
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.
### When your changes are ready:
- Open a [Pull Request](https://github.com/pmarsceill/just-the-docs/pulls)
- Await code review
- Bump the version number in `just-the-docs.gemspec`
- Run `script/build` to package the gem
- Run `gem push just-the-docs-<version>.gem` to publish the gem to Rubygems.org
## License
The theme is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

View File

@@ -13,20 +13,112 @@
# 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
title: Just the Docs (v0.3.3)
description: A Jekyll theme for documentation
baseurl: "/just-the-docs/" # the subpath of your site, e.g. /blog
# url: "" # the base hostname & protocol for your site, e.g. http://example.com
sass:
# Load dependancies
load_paths:
- node_modules/
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
permalink: pretty
exclude: ["node_modules/", "*.gemspec", "*.gem", "Gemfile", "Gemfile.lock", "package.json", "script/", "LICENSE.txt", "lib/", "bin/", "README.md", "Rakefile"]
exclude: ["node_modules/", "*.gemspec", "*.gem", "Gemfile", "Gemfile.lock", "package.json", "package-lock.json", "script/", "LICENSE.txt", "lib/", "bin/", "README.md", "Rakefile"
, "docs/tests/"
]
# Regression tests
# By default, the pages in /docs/tests are excluded when the ste is built.
# To include them, comment-out the relevant line above.
# Uncommenting the following line doesn't work - see https://github.com/jekyll/jekyll/issues/4791
# include: ["docs/tests/"]
# Set a path/url to a logo that will be displayed instead of the title
#logo: "/assets/images/just-the-docs.png"
# Enable or disable the site search
# Supports true (default) or false
search_enabled: true
search:
# Split pages into sections that can be searched individually
# Supports 1 - 6, default: 2
heading_level: 2
# Maximum amount of previews per search result
# Default: 3
previews: 2
# Maximum amount of words to display before a matched word in the preview
# Default: 5
preview_words_before: 3
# Maximum amount of words to display after a matched word in the preview
# Default: 10
preview_words_after: 3
# Set the search token separator
# Default: /[\s\-/]+/
# Example: enable support for hyphenated search words
tokenizer_separator: /[\s/]+/
# Display the relative url in search results
# Supports true (default) or false
rel_url: true
# Enable or disable the search button that appears in the bottom right corner of every page
# Supports true or false (default)
button: false
# 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"
# Makes Aux links open in a new tab. Default is false
aux_links_new_tab: false
# Sort order for navigation links
# nav_sort: case_insensitive # default, equivalent to nil
nav_sort: case_sensitive # Capital letters sorted before lowercase
# Footer content
# appears at the bottom of every page's main content
# Back to top link
back_to_top: true
back_to_top_text: "Back to top"
footer_content: "Copyright &copy; 2017-2020 Patrick Marsceill. Distributed by an <a href=\"https://github.com/pmarsceill/just-the-docs/tree/master/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
last_edit_time_format: "%b %e %Y at %I:%M %p" # uses ruby's time format: https://ruby-doc.org/stdlib-2.7.0/libdoc/time/rdoc/Time.html
# 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_source: docs # the source that your files originate from
gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately
# Color scheme currently only supports "dark", "light"/nil (default), or a custom scheme that you define
color_scheme: nil
# Google Analytics Tracking (optional)
# e.g, UA-1234567-89
ga_tracking: UA-2709176-10
ga_tracking_anonymize_ip: true # Use GDPR compliant Google Analytics settings (true/nil by default)
plugins:
- jekyll-seo-tag
kramdown:
syntax_highlighter_opts:
block:
line_numbers: false
compress_html:
clippings: all
comments: all
endings: all
startings: []
blanklines: false
profile: false
# ignore:
# envs: all

View File

@@ -0,0 +1 @@
@import "./custom/custom";

View File

@@ -0,0 +1,7 @@
{% if site.logo %}
$logo: "{{ site.logo | absolute_url }}";
{% endif %}
@import "./support/support";
@import "./color_schemes/{{ include.color_scheme }}";
@import "./modules";
{% include css/custom.scss.liquid %}

View File

@@ -0,0 +1,65 @@
{%- comment -%}
This file can be used to fix the HTML produced by Jekyll for highlighted
code with line numbers.
It works with `{% highlight some_language linenos %}...{% endhighlight %}`
and with the Kramdown option to add line numbers to fenced code.
The implementation was derived from the workaround provided by
Dmitry Hrabrov (DeXP) at
https://github.com/penibelst/jekyll-compress-html/issues/71#issuecomment-188144901
EXPLANATION
The HTML produced by Rouge highlighting with lie numbers is of the form
`code table`. Jekyll (<= 4.1.1) always wraps the highlighted HTML
with `pre`. This wrapping is not only unnecessary, but also transforms
the conforming HTML produced by Rouge to non-conforming HTML, which
results in HTML validation error reports.
The fix removes the outer `pre` tags whenever they contain the pattern
`<table class="rouge-table">`.
Apart from avoiding HTML validation errors, the fix allows the use of
the [Jekyll layout for compressing HTML](http://jch.penibelst.de),
which relies on `pre` tags not being nested, according to
https://github.com/penibelst/jekyll-compress-html/issues/71#issuecomment-172069842
USAGE
(Any names can be used for `some_var` and `some_language`.)
{% capture some_var %}
{% highlight some_language linenos %}
Some code
{% endhighlight %}
{% endcapture %}
{% include fix_linenos.html code=some_var %}
For code fences:
{% capture some_var %}
```some_language
Some code
```
{% endcapture %}
{% assign some_var = some_var | markdownify %}
{% include fix_linenos.html code=some_var %}
CAVEATS
The above does not work when `Some code` happens to contain the matched string
`<table class="rouge-table">`.
The use of this file overwrites the variable `fix_linenos_code` with `nil`.
{%- endcomment -%}
{% assign fix_linenos_code = include.code %}
{% if fix_linenos_code contains '<table class="rouge-table">' %}
{% assign fix_linenos_code = fix_linenos_code | replace: '<pre class="highlight">', '<pre>' %}
{% assign fix_linenos_code = fix_linenos_code | replace: "<pre><code", "<code" %}
{% assign fix_linenos_code = fix_linenos_code | replace: "</code></pre>", "</code>" %}
{% endif %}
{{ fix_linenos_code }}
{% assign fix_linenos_code = nil %}

View File

@@ -0,0 +1,3 @@
{%- if site.footer_content -%}
<p class="text-small text-grey-dk-100 mb-0">{{ site.footer_content }}</p>
{%- endif -%}

View File

@@ -2,10 +2,39 @@
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=Edge">
{% unless site.plugins contains "jekyll-seo-tag" %}
<title>{{ page.title }} - {{ site.title }}</title>
<link rel="stylesheet" href="{{ "/assets/css/just-the-docs.css" | absolute_url }}">
<script type="text/javascript" src="{{ "/assets/js/vendor/lunr.min.js" | absolute_url }}"></script>
<script type="text/javascript" src="{{ "/assets/js/just-the-docs.js" | absolute_url }}"></script>
{% if page.description %}
<meta name="Description" content="{{ page.description }}">
{% endif %}
{% endunless %}
<link rel="shortcut icon" href="{{ 'favicon.ico' | relative_url }}" type="image/x-icon">
<link rel="stylesheet" href="{{ '/assets/css/just-the-docs-default.css' | relative_url }}">
{% if site.ga_tracking != nil %}
<script async src="https://www.googletagmanager.com/gtag/js?id={{ site.ga_tracking }}"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', '{{ site.ga_tracking }}'{% unless site.ga_tracking_anonymize_ip == nil %}, { 'anonymize_ip': true }{% endunless %});
</script>
{% endif %}
{% if site.search_enabled != false %}
<script type="text/javascript" src="{{ '/assets/js/vendor/lunr.min.js' | relative_url }}"></script>
{% endif %}
<script type="text/javascript" src="{{ '/assets/js/just-the-docs.js' | relative_url }}"></script>
<meta name="viewport" content="width=device-width, initial-scale=1">
{% seo %}
{% include head_custom.html %}
</head>

View File

@@ -1,24 +1,99 @@
<nav>
<ul class="navigation-list">
{% assign pages_list = site.html_pages | sort:"nav_order" %}
{% for node in pages_list %}
<li class="navigation-list-item{% if page.url == node.url %} active{% endif %} js-side-nav-item">
{% if node.parent == nil or node.has_children == true %}
<a href="{{ node.url | absolute_url }}" class="navigation-list-link{% if page.url == node.url or (page.parent != nil and page.parent == node.parent) %} active{% endif %}">{{ node.title }}</a>
{% if (node.has_children == true and node.parent == page.parent) %}
{% assign children_list = site.html_pages | sort:"nav_order" %}
<ul class="navigation-list-child-list">
{% for child in children_list %}
{% if child.parent == node.parent and child.title != node.title %}
<li class="navigation-list-item {% if page.url == child.url %} active{% endif %}">
<a href="{{ child.url | absolute_url }}" class="navigation-list-link{% if page.url == child.url %} active{% endif %}">{{ child.title }}</a>
<ul class="nav-list">
{%- assign titled_pages = include.pages
| where_exp:"item", "item.title != nil" -%}
{%- comment -%}
The values of `title` and `nav_order` can be numbers or strings.
Jekyll gives build failures when sorting on mixtures of different types,
so numbers and strings need to be sorted separately.
Here, numbers are sorted by their values, and come before all strings.
An omitted `nav_order` value is equivalent to the page's `title` value
(except that a numerical `title` value is treated as a string).
The case-sensitivity of string sorting is determined by `site.nav_sort`.
{%- endcomment -%}
{%- assign string_ordered_pages = titled_pages
| where_exp:"item", "item.nav_order == nil" -%}
{%- assign nav_ordered_pages = titled_pages
| where_exp:"item", "item.nav_order != nil" -%}
{%- comment -%}
The nav_ordered_pages have to be added to number_ordered_pages and
string_ordered_pages, depending on the nav_order value.
The first character of the jsonify result is `"` only for strings.
{%- endcomment -%}
{%- assign nav_ordered_groups = nav_ordered_pages
| group_by_exp:"item", "item.nav_order | jsonify | slice: 0" -%}
{%- assign number_ordered_pages = "" | split:"X" -%}
{%- for group in nav_ordered_groups -%}
{%- if group.name == '"' -%}
{%- assign string_ordered_pages = string_ordered_pages | concat: group.items -%}
{%- else -%}
{%- assign number_ordered_pages = number_ordered_pages | concat: group.items -%}
{%- endif -%}
{%- endfor -%}
{%- assign sorted_number_ordered_pages = number_ordered_pages | sort:"nav_order" -%}
{%- comment -%}
The string_ordered_pages have to be sorted by nav_order, and otherwise title
(where appending the empty string to a numeric title converts it to a string).
After grouping them by those values, the groups are sorted, then the items
of each group are concatenated.
{%- endcomment -%}
{%- assign string_ordered_groups = string_ordered_pages
| group_by_exp:"item", "item.nav_order | default: item.title | append:''" -%}
{%- if site.nav_sort == 'case_insensitive' -%}
{%- assign sorted_string_ordered_groups = string_ordered_groups | sort_natural:"name" -%}
{%- else -%}
{%- assign sorted_string_ordered_groups = string_ordered_groups | sort:"name" -%}
{%- endif -%}
{%- assign sorted_string_ordered_pages = "" | split:"X" -%}
{%- for group in sorted_string_ordered_groups -%}
{%- assign sorted_string_ordered_pages = sorted_string_ordered_pages | concat: group.items -%}
{%- endfor -%}
{%- assign pages_list = sorted_number_ordered_pages | concat: sorted_string_ordered_pages -%}
{%- for node in pages_list -%}
{%- if node.parent == nil -%}
{%- unless node.nav_exclude -%}
<li class="nav-list-item{% if page.url == node.url or page.parent == node.title or page.grand_parent == node.title %} active{% endif %}">
{%- if node.has_children -%}
<a href="#" class="nav-list-expander"><svg viewBox="0 0 24 24"><use xlink:href="#svg-arrow-right"></use></svg></a>
{%- endif -%}
<a href="{{ node.url | absolute_url }}" class="nav-list-link{% if page.url == node.url %} active{% endif %}">{{ node.title }}</a>
{%- if node.has_children -%}
{%- assign children_list = pages_list | where: "parent", node.title -%}
<ul class="nav-list ">
{%- for child in children_list -%}
{%- unless child.nav_exclude -%}
<li class="nav-list-item {% if page.url == child.url or page.parent == child.title %} active{% endif %}">
{%- if child.has_children -%}
<a href="#" class="nav-list-expander"><svg viewBox="0 0 24 24"><use xlink:href="#svg-arrow-right"></use></svg></a>
{%- endif -%}
<a href="{{ child.url | absolute_url }}" class="nav-list-link{% if page.url == child.url %} active{% endif %}">{{ child.title }}</a>
{%- if child.has_children -%}
{%- assign grand_children_list = pages_list | where: "parent", child.title | where: "grand_parent", node.title -%}
<ul class="nav-list">
{%- for grand_child in grand_children_list -%}
{%- unless grand_child.nav_exclude -%}
<li class="nav-list-item {% if page.url == grand_child.url %} active{% endif %}">
<a href="{{ grand_child.url | absolute_url }}" class="nav-list-link{% if page.url == grand_child.url %} active{% endif %}">{{ grand_child.title }}</a>
</li>
{% endif %}
{% endfor %}
{%- endunless -%}
{%- endfor -%}
</ul>
{% endif %}
{% endif %}
{%- endif -%}
</li>
{% endfor %}
{%- endunless -%}
{%- endfor -%}
</ul>
</nav>
{%- endif -%}
</li>
{%- endunless -%}
{%- endif -%}
{%- endfor -%}
</ul>

5
_includes/title.html Normal file
View File

@@ -0,0 +1,5 @@
{% if site.logo %}
<div class="site-logo"></div>
{% else %}
{{ site.title }}
{% endif %}

144
_includes/vendor/anchor_headings.html vendored Executable file
View File

@@ -0,0 +1,144 @@
{% capture headingsWorkspace %}
{% comment %}
Copyright (c) 2018 Vladimir "allejo" Jimenez
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
{% endcomment %}
{% comment %}
Version 1.0.7
https://github.com/allejo/jekyll-anchor-headings
"Be the pull request you wish to see in the world." ~Ben Balter
Usage:
{% include anchor_headings.html html=content anchorBody="#" %}
Parameters:
* html (string) - the HTML of compiled markdown generated by kramdown in Jekyll
Optional Parameters:
* beforeHeading (bool) : false - Set to true if the anchor should be placed _before_ the heading's content
* anchorAttrs (string) : '' - Any custom HTML attributes that will be added to the `<a>` tag; you may NOT use `href`, `class` or `title`;
the `%heading%` and `%html_id%` placeholders are available
* anchorBody (string) : '' - The content that will be placed inside the anchor; the `%heading%` placeholder is available
* anchorClass (string) : '' - The class(es) that will be used for each anchor. Separate multiple classes with a space
* anchorTitle (string) : '' - The `title` attribute that will be used for anchors
* h_min (int) : 1 - The minimum header level to build an anchor for; any header lower than this value will be ignored
* h_max (int) : 6 - The maximum header level to build an anchor for; any header greater than this value will be ignored
* bodyPrefix (string) : '' - Anything that should be inserted inside of the heading tag _before_ its anchor and content
* bodySuffix (string) : '' - Anything that should be inserted inside of the heading tag _after_ its anchor and content
Output:
The original HTML with the addition of anchors inside of all of the h1-h6 headings.
{% endcomment %}
{% assign minHeader = include.h_min | default: 1 %}
{% assign maxHeader = include.h_max | default: 6 %}
{% assign beforeHeading = include.beforeHeading %}
{% assign nodes = include.html | split: '<h' %}
{% capture edited_headings %}{% endcapture %}
{% for _node in nodes %}
{% capture node %}{{ _node | strip }}{% endcapture %}
{% if node == "" %}
{% continue %}
{% endif %}
{% assign nextChar = node | replace: '"', '' | strip | slice: 0, 1 %}
{% assign headerLevel = nextChar | times: 1 %}
<!-- If the level is cast to 0, it means it's not a h1-h6 tag, so let's see if we need to fix it -->
{% if headerLevel == 0 %}
<!-- Split up the node based on closing angle brackets and get the first one. -->
{% assign firstChunk = node | split: '>' | first %}
<!-- If the first chunk does NOT contain a '<', that means we've broken another HTML tag that starts with 'h' -->
{% unless firstChunk contains '<' %}
{% capture node %}<h{{ node }}{% endcapture %}
{% endunless %}
{% capture edited_headings %}{{ edited_headings }}{{ node }}{% endcapture %}
{% continue %}
{% endif %}
{% capture _closingTag %}</h{{ headerLevel }}>{% endcapture %}
{% assign _workspace = node | split: _closingTag %}
{% assign _idWorkspace = _workspace[0] | split: 'id="' %}
{% assign _idWorkspace = _idWorkspace[1] | split: '"' %}
{% assign html_id = _idWorkspace[0] %}
{% capture _hAttrToStrip %}{{ _workspace[0] | split: '>' | first }}>{% endcapture %}
{% assign header = _workspace[0] | replace: _hAttrToStrip, '' %}
<!-- Build the anchor to inject for our heading -->
{% capture anchor %}{% endcapture %}
{% if html_id and headerLevel >= minHeader and headerLevel <= maxHeader %}
{% capture anchor %}href="#{{ html_id }}"{% endcapture %}
{% if include.anchorClass %}
{% capture anchor %}{{ anchor }} class="{{ include.anchorClass }}"{% endcapture %}
{% endif %}
{% if include.anchorTitle %}
{% capture anchor %}{{ anchor }} title="{{ include.anchorTitle | replace: '%heading%', header }}"{% endcapture %}
{% endif %}
{% if include.anchorAttrs %}
{% capture anchor %}{{ anchor }} {{ include.anchorAttrs | replace: '%heading%', header | replace: '%html_id%', html_id }}{% endcapture %}
{% endif %}
{% capture anchor %}<a {{ anchor }}>{{ include.anchorBody | replace: '%heading%', header | default: '' }}</a>{% endcapture %}
<!-- In order to prevent adding extra space after a heading, we'll let the 'anchor' value contain it -->
{% if beforeHeading %}
{% capture anchor %}{{ anchor }} {% endcapture %}
{% else %}
{% capture anchor %} {{ anchor }}{% endcapture %}
{% endif %}
{% endif %}
{% capture new_heading %}
<h{{ _hAttrToStrip }}
{{ include.bodyPrefix }}
{% if beforeHeading %}
{{ anchor }}{{ header }}
{% else %}
{{ header }}{{ anchor }}
{% endif %}
{{ include.bodySuffix }}
</h{{ headerLevel }}>
{% endcapture %}
<!--
If we have content after the `</hX>` tag, then we'll want to append that here so we don't lost any content.
-->
{% assign chunkCount = _workspace | size %}
{% if chunkCount > 1 %}
{% capture new_heading %}{{ new_heading }}{{ _workspace | last }}{% endcapture %}
{% endif %}
{% capture edited_headings %}{{ edited_headings }}{{ new_heading }}{% endcapture %}
{% endfor %}
{% endcapture %}{% assign headingsWorkspace = '' %}{{ edited_headings | strip }}

View File

@@ -1,68 +1,202 @@
---
layout: table_wrappers
---
<!DOCTYPE html>
<html lang="en-us">
<html lang="{{ site.lang | default: 'en-US' }}">
{% include head.html %}
<body>
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
<symbol id="svg-link" viewBox="0 0 24 24">
<title>Link</title>
<svg xmlns="http://www.w3.org/2000/svg" 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-link">
<path d="M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.72 1.71"></path><path d="M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71"></path>
</svg>
</symbol>
<symbol id="svg-search" viewBox="0 0 24 24">
<title>Search</title>
<svg xmlns="http://www.w3.org/2000/svg" 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-search">
<circle cx="11" cy="11" r="8"></circle><line x1="21" y1="21" x2="16.65" y2="16.65"></line>
</svg>
</symbol>
<symbol id="svg-menu" viewBox="0 0 24 24">
<title>Menu</title>
<svg xmlns="http://www.w3.org/2000/svg" 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-menu">
<line x1="3" y1="12" x2="21" y2="12"></line><line x1="3" y1="6" x2="21" y2="6"></line><line x1="3" y1="18" x2="21" y2="18"></line>
</svg>
</symbol>
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
<title>Expand</title>
<svg xmlns="http://www.w3.org/2000/svg" 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-chevron-right">
<polyline points="9 18 15 12 9 6"></polyline>
</svg>
</symbol>
<symbol id="svg-doc" viewBox="0 0 24 24">
<title>Document</title>
<svg xmlns="http://www.w3.org/2000/svg" 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-file">
<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>
</svg>
<div class="page-wrap">
<div class="side-bar">
<a href="{{ site.url }}{{ site.baseurl }}" class="site-title fs-6 text-grey-dk-300 lh-tight">{{ site.title }}</a>
<span class="fs-3"><button class="js-main-nav-trigger navigation-list-toggle btn btn-outline" type="button" data-text-toggle="Hide">Menu</button></span>
<div class="navigation main-nav js-main-nav">
{% include nav.html %}
<div class="site-header">
<a href="{{ '/' | absolute_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>
<footer role="contentinfo" class="site-footer">
<p class="text-small text-grey-dk-000 mb-0">This site uses <a href="https://github.com/pmarsceill/just-the-docs">Just the Docs</a>, a documentation theme for Jekyll.</p>
<nav role="navigation" aria-label="Main" id="site-nav" class="site-nav">
{% if site.just_the_docs.collections %}
{% assign collections_size = site.just_the_docs.collections | size %}
{% for collection_entry in site.just_the_docs.collections %}
{% assign collection_key = collection_entry[0] %}
{% assign collection_value = collection_entry[1] %}
{% assign collection = site[collection_key] %}
{% if collection_value.nav_exclude != true %}
{% if collections_size > 1 %}
<div class="nav-category">{{ collection_value.name }}</div>
{% endif %}
{% include nav.html pages=collection %}
{% endif %}
{% endfor %}
{% else %}
{% include nav.html pages=site.html_pages %}
{% endif %}
</nav>
<footer class="site-footer">
This site uses <a href="https://github.com/pmarsceill/just-the-docs">Just the Docs</a>, a documentation theme for Jekyll.
</footer>
</div>
<div class="main-content-wrap">
<div class="page-header">
<div class="main-content pb-0">
<div class="search js-search">
<div class="main" id="top">
<div id="main-header" class="main-header">
{% if site.search_enabled != false %}
<div class="search">
<div class="search-input-wrap">
<input type="text" class="js-search-input search-input" placeholder="Search {{ site.title }}" aria-label="Search {{ site.title }}" autocomplete="off">
<svg width="14" height="14" viewBox="0 0 28 28" xmlns="http://www.w3.org/2000/svg" class="search-icon"><title>Search</title><g fill-rule="nonzero"><path d="M17.332 20.735c-5.537 0-10-4.6-10-10.247 0-5.646 4.463-10.247 10-10.247 5.536 0 10 4.601 10 10.247s-4.464 10.247-10 10.247zm0-4c3.3 0 6-2.783 6-6.247 0-3.463-2.7-6.247-6-6.247s-6 2.784-6 6.247c0 3.464 2.7 6.247 6 6.247z"/><path d="M11.672 13.791L.192 25.271 3.02 28.1 14.5 16.62z"/></g></svg>
<input type="text" id="search-input" class="search-input" tabindex="0" placeholder="Search {{ site.title }}" aria-label="Search {{ site.title }}" 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 class="js-search-results search-results-wrap"></div>
<div id="search-results" class="search-results"></div>
</div>
{% if site.aux_links != nil %}
<ul class="list-style-none text-small mt-md-2 pb-4 pb-md-0 js-aux-nav aux-nav">
{% endif %}
{% include header_custom.html %}
{% if site.aux_links %}
<nav aria-label="Auxiliary" class="aux-nav">
<ul class="aux-nav-list">
{% for link in site.aux_links %}
<li class="d-inline-block my-0{% unless forloop.last %} mr-2{% endunless %}"><a href="{{ link.last }}">{{ link.first }}</a></li>
<li class="aux-nav-list-item">
<a href="{{ link.last }}" class="site-button"
{% if site.aux_links_new_tab %}
target="_blank" rel="noopener noreferrer"
{% endif %}
>
{{ link.first }}
</a>
</li>
{% endfor %}
</ul>
</nav>
{% endif %}
</div>
</div>
<div class="main-content">
<div id="main-content-wrap" class="main-content-wrap">
{% unless page.url == "/" %}
{% if page.parent != nil and page.parent != page.title %}
<nav class="breadcrumb-nav">
{% 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">
<li class="breadcrumb-nav-list-item"><a href="{{ site.url }}{{ site.baseurl }}/{{ page.parent | slugify }}">{{ page.parent }}</a></li>
{% if page.grand_parent %}
<li class="breadcrumb-nav-list-item"><a href="{{ first_level_url }}">{{ page.grand_parent }}</a></li>
<li class="breadcrumb-nav-list-item"><a href="{{ second_level_url }}">{{ page.parent }}</a></li>
{% else %}
<li class="breadcrumb-nav-list-item"><a href="{{ first_level_url }}">{{ page.parent }}</a></li>
{% endif %}
<li class="breadcrumb-nav-list-item"><span>{{ page.title }}</span></li>
</ol>
</nav>
{% endif %}
{% endunless %}
<div class="page-content">
<div id="main-content" class="main-content" role="main">
{% if site.heading_anchors != false %}
{% include vendor/anchor_headings.html html=content beforeHeading="true" anchorBody="<svg viewBox=\"0 0 16 16\" aria-hidden=\"true\"><use xlink:href=\"#svg-link\"></use></svg>" anchorClass="anchor-heading" anchorAttrs="aria-labelledby=\"%html_id%\"" %}
{% else %}
{{ content }}
{% endif %}
{% if page.has_children == true %}
{% if page.has_children == true and page.has_toc != false %}
<hr>
<h2 class="text-delta">Table of contents</h2>
{% assign children_list = site.pages | sort:"nav_order" %}
<ul>
{%- assign children_list = pages_list | where: "parent", page.title | where: "grand_parent", page.parent -%}
{% for child in children_list %}
{% if child.parent == page.title and child.title != page.title %}
<li>
<a href="{{ child.url | absolute_url }}">{{ child.title }}</a>
<a href="{{ child.url | absolute_url }}">{{ child.title }}</a>{% if child.summary %} - {{ child.summary }}{% endif %}
</li>
{% endif %}
{% endfor %}
</ul>
{% endif %}
{% capture footer_custom %}
{%- include footer_custom.html -%}
{% endcapture %}
{% if footer_custom != "" or site.last_edit_timestamp or site.gh_edit_link %}
<hr>
<footer>
{% if site.back_to_top %}
<p><a href="#top" id="back-to-top">{{ site.back_to_top_text }}</a></p>
{% endif %}
{{ footer_custom }}
{% if site.last_edit_timestamp or site.gh_edit_link %}
<div class="d-flex mt-2">
{% if site.last_edit_timestamp and site.last_edit_time_format and page.last_modified_date %}
<p class="text-small text-grey-dk-000 mb-0 mr-2">
Page last modified: <span class="d-inline-block">{{ page.last_modified_date | date: site.last_edit_time_format }}</span>.
</p>
{% endif %}
{% if
site.gh_edit_link and
site.gh_edit_link_text and
site.gh_edit_repository and
site.gh_edit_branch and
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>
</p>
{% endif %}
</div>
{% endif %}
</footer>
{% endif %}
</div>
</div>
{% if site.search_enabled != false %}
{% if site.search.button %}
<a href="#" id="search-button" class="search-button">
<svg viewBox="0 0 24 24" class="icon"><use xlink:href="#svg-search"></use></svg>
</a>
{% endif %}
<div class="search-overlay"></div>
{% endif %}
</div>
</div>
</body>
</html>

5
_layouts/page.html Normal file
View File

@@ -0,0 +1,5 @@
---
layout: default
---
{{ content }}

View File

@@ -0,0 +1,7 @@
---
layout: vendor/compress
---
{% assign content_ = content | replace: '<table', '<div class="table-wrapper"><table' %}
{% assign content_ = content_ | replace: '</table>', '</table></div>' %}
{{ content_ }}

10
_layouts/vendor/compress.html vendored Normal file
View File

@@ -0,0 +1,10 @@
---
# Jekyll layout that compresses HTML
# v3.1.0
# http://jch.penibelst.de/
# © 20142015 Anatol Broder
# MIT License
---
{% capture _LINE_FEED %}
{% endcapture %}{% if site.compress_html.ignore.envs contains jekyll.environment or site.compress_html.ignore.envs == "all" %}{{ content }}{% else %}{% capture _content %}{{ content }}{% endcapture %}{% assign _profile = site.compress_html.profile %}{% if site.compress_html.endings == "all" %}{% assign _endings = "html head body li dt dd optgroup option colgroup caption thead tbody tfoot tr td th" | split: " " %}{% else %}{% assign _endings = site.compress_html.endings %}{% endif %}{% for _element in _endings %}{% capture _end %}</{{ _element }}>{% endcapture %}{% assign _content = _content | remove: _end %}{% endfor %}{% if _profile and _endings %}{% assign _profile_endings = _content | size | plus: 1 %}{% endif %}{% for _element in site.compress_html.startings %}{% capture _start %}<{{ _element }}>{% endcapture %}{% assign _content = _content | remove: _start %}{% endfor %}{% if _profile and site.compress_html.startings %}{% assign _profile_startings = _content | size | plus: 1 %}{% endif %}{% if site.compress_html.comments == "all" %}{% assign _comments = "<!-- -->" | split: " " %}{% else %}{% assign _comments = site.compress_html.comments %}{% endif %}{% if _comments.size == 2 %}{% capture _comment_befores %}.{{ _content }}{% endcapture %}{% assign _comment_befores = _comment_befores | split: _comments.first %}{% for _comment_before in _comment_befores %}{% if forloop.first %}{% continue %}{% endif %}{% capture _comment_outside %}{% if _carry %}{{ _comments.first }}{% endif %}{{ _comment_before }}{% endcapture %}{% capture _comment %}{% unless _carry %}{{ _comments.first }}{% endunless %}{{ _comment_outside | split: _comments.last | first }}{% if _comment_outside contains _comments.last %}{{ _comments.last }}{% assign _carry = false %}{% else %}{% assign _carry = true %}{% endif %}{% endcapture %}{% assign _content = _content | remove_first: _comment %}{% endfor %}{% if _profile %}{% assign _profile_comments = _content | size | plus: 1 %}{% endif %}{% endif %}{% assign _pre_befores = _content | split: "<pre" %}{% assign _content = "" %}{% for _pre_before in _pre_befores %}{% assign _pres = _pre_before | split: "</pre>" %}{% assign _pres_after = "" %}{% if _pres.size != 0 %}{% if site.compress_html.blanklines %}{% assign _lines = _pres.last | split: _LINE_FEED %}{% capture _pres_after %}{% for _line in _lines %}{% assign _trimmed = _line | split: " " | join: " " %}{% if _trimmed != empty or forloop.last %}{% unless forloop.first %}{{ _LINE_FEED }}{% endunless %}{{ _line }}{% endif %}{% endfor %}{% endcapture %}{% else %}{% assign _pres_after = _pres.last | split: " " | join: " " %}{% endif %}{% endif %}{% capture _content %}{{ _content }}{% if _pre_before contains "</pre>" %}<pre{{ _pres.first }}</pre>{% endif %}{% unless _pre_before contains "</pre>" and _pres.size == 1 %}{{ _pres_after }}{% endunless %}{% endcapture %}{% endfor %}{% if _profile %}{% assign _profile_collapse = _content | size | plus: 1 %}{% endif %}{% if site.compress_html.clippings == "all" %}{% assign _clippings = "html head title base link meta style body article section nav aside h1 h2 h3 h4 h5 h6 hgroup header footer address p hr blockquote ol ul li dl dt dd figure figcaption main div table caption colgroup col tbody thead tfoot tr td th" | split: " " %}{% else %}{% assign _clippings = site.compress_html.clippings %}{% endif %}{% for _element in _clippings %}{% assign _edges = " <e;<e; </e>;</e>;</e> ;</e>" | replace: "e", _element | split: ";" %}{% assign _content = _content | replace: _edges[0], _edges[1] | replace: _edges[2], _edges[3] | replace: _edges[4], _edges[5] %}{% endfor %}{% if _profile and _clippings %}{% assign _profile_clippings = _content | size | plus: 1 %}{% endif %}{{ _content }}{% if _profile %} <table id="compress_html_profile_{{ site.time | date: "%Y%m%d" }}" class="compress_html_profile"> <thead> <tr> <td>Step <td>Bytes <tbody> <tr> <td>raw <td>{{ content | size }}{% if _profile_endings %} <tr> <td>endings <td>{{ _profile_endings }}{% endif %}{% if _profile_startings %} <tr> <td>startings <td>{{ _profile_startings }}{% endif %}{% if _profile_comments %} <tr> <td>comments <td>{{ _profile_comments }}{% endif %}{% if _profile_collapse %} <tr> <td>collapse <td>{{ _profile_collapse }}{% endif %}{% if _profile_clippings %} <tr> <td>clippings <td>{{ _profile_clippings }}{% endif %} </table>{% endif %}{% endif %}

View File

@@ -1,14 +1,20 @@
//
// Base element style overrides
//
// stylelint-disable selector-no-type
// stylelint-disable selector-no-type, selector-max-type
* {
box-sizing: border-box;
}
::selection {
color: $white;
background: $link-color;
}
html {
@include fs-4;
scroll-behavior: smooth;
}
body {
@@ -16,27 +22,21 @@ body {
font-size: inherit;
line-height: $body-line-height;
color: $body-text-color;
background-color: $body-background-color;
}
p,
h1,
h2,
h3,
h4,
h5,
h6,
ol,
ul,
dl,
pre,
address,
blockquote,
dl,
table,
div,
fieldset,
form,
hr,
noscript,
table {
form,
fieldset,
noscript .table-wrapper {
margin-top: 0;
}
@@ -46,14 +46,15 @@ h3,
h4,
h5,
h6 {
margin-top: 1.2em;
margin-bottom: 0.8em;
margin-top: 0;
margin-bottom: 1em;
font-weight: 500;
line-height: $body-heading-line-height;
color: $body-heading-color;
}
p {
margin-top: 1em;
margin-bottom: 1em;
}
@@ -64,25 +65,28 @@ a {
a:not([class]) {
text-decoration: none;
background-image: linear-gradient($grey-lt-100 0%, $grey-lt-100 100%);
background-image: linear-gradient($border-color 0%, $border-color 100%);
background-repeat: repeat-x;
background-position: 0 100%;
background-size: 1px 1px;
&:hover {
background-image: linear-gradient(rgba($link-color, 0.45) 0%, rgba($link-color, 0.45) 100%);
background-image: linear-gradient(
rgba($link-color, 0.45) 0%,
rgba($link-color, 0.45) 100%
);
background-size: 1px 1px;
}
}
code {
font-family: $mono-font-family;
font-size: 12px;
font-size: 0.75em;
line-height: $body-line-height;
}
figure {
figure,
pre {
margin: 0;
}
@@ -99,6 +103,6 @@ hr {
height: 1px;
padding: 0;
margin: $sp-6 0;
background-color: $grey-lt-100;
background-color: $border-color;
border: 0;
}

View File

@@ -15,13 +15,13 @@
font-size: inherit;
font-weight: 500;
line-height: 1.5;
color: $purple-200;
color: $link-color;
text-decoration: none;
vertical-align: baseline;
cursor: pointer;
background-color: #f7f7f7;
background-color: $base-button-color;
border-width: 0;
border-radius: 3px;
border-radius: $border-radius;
box-shadow: 0 1px 2px rgba(0, 0, 0, 0.12), 0 3px 10px rgba(0, 0, 0, 0.08);
appearance: none;
@@ -38,7 +38,7 @@
&:hover,
&.zeroclipboard-is-hover {
color: $purple-300;
color: darken($link-color, 2%);
}
&:hover,
@@ -46,13 +46,13 @@
&.zeroclipboard-is-hover,
&.zeroclipboard-is-active {
text-decoration: none;
background-color: #f4f4f4;
background-color: darken($base-button-color, 1%);
}
&:active,
&.selected,
&.zeroclipboard-is-active {
background-color: #ededed;
background-color: darken($base-button-color, 3%);
background-image: none;
box-shadow: inset 0 2px 4px rgba(0, 0, 0, 0.15);
}
@@ -75,7 +75,7 @@
}
.btn-outline {
color: $blue-100;
color: $link-color;
background: transparent;
box-shadow: inset 0 0 0 2px $grey-lt-300;
@@ -83,7 +83,7 @@
&:active,
&.zeroclipboard-is-hover,
&.zeroclipboard-is-active {
color: $grey-dk-100;
color: darken($link-color, 4%);
text-decoration: none;
background-color: transparent;
box-shadow: inset 0 0 0 3px $grey-lt-300;
@@ -101,6 +101,10 @@
}
}
.btn-primary {
@include btn-color($white, $btn-primary-color);
}
.btn-purple {
@include btn-color($white, $purple-100);
}

View File

@@ -1,101 +1,320 @@
//
// Code and syntax highlighting
//
// stylelint-disable selector-no-qualifying-type, declaration-block-semicolon-newline-after,declaration-block-single-line-max-declarations, selector-no-type
// stylelint-disable selector-no-qualifying-type, declaration-block-semicolon-newline-after,declaration-block-single-line-max-declarations, selector-no-type, selector-max-type
code {
padding: 0.2em 0.15em;
font-weight: 400;
background-color: $grey-lt-000;
background-color: $code-background-color;
border: $border $border-color;
border-radius: $border-radius;
}
.highlight {
padding: $sp-3;
margin-bottom: 0;
background-color: $grey-lt-000;
// Avoid appearance of dark border around visited code links in Safari
a:visited code {
border-color: $border-color;
}
// Content structure for highlighted code blocks using fences or Liquid
//
// ```[LANG]...```, no kramdown line_numbers:
// div.[language-LANG.]highlighter-rouge > div.highlight > pre.highlight > code
//
// ```[LANG]...```, kramdown line_numbers = true:
// div.[language-LANG.]highlighter-rouge > div.highlight > pre.highlight > code
// > div.table-wrapper > table.rouge-table > tbody > tr
// > td.rouge-gutter.gl > pre.lineno
// | td.rouge-code > pre
//
// {% highlight LANG %}...{% endhighlight %}:
// figure.highlight > pre > code.language-LANG
//
// {% highlight LANG linenos %}...{% endhighlight %}:
// figure.highlight > pre > code.language-LANG
// > div.table-wrapper > table.rouge-table > tbody > tr
// > td.gutter.gl > pre.lineno
// | td.code > pre
//
// fix_linenos removes the outermost pre when it encloses table.rouge-table
//
// See docs/index-test.md for some tests.
//
// No kramdown line_numbers: fences and Liquid highlighting look the same.
// Kramdown line_numbers = true: fences have a wider gutter than with Liquid?
// ```[LANG]...```
div.highlighter-rouge {
padding: $sp-3;
margin-top: 0;
margin-bottom: $sp-3;
overflow-x: auto;
background-color: $code-background-color;
border-radius: $border-radius;
box-shadow: none;
-webkit-overflow-scrolling: touch;
div.highlight,
pre.highlight,
code {
padding: 0;
margin: 0;
border: 0;
}
}
.highlighter-rouge {
// {% highlight LANG %}...{% endhighlight %},
// {% highlight LANG linenos %}...{% endhighlight %}:
figure.highlight {
padding: $sp-3;
margin-top: 0;
margin-bottom: $sp-3;
overflow: hidden;
background-color: $code-background-color;
border-radius: $border-radius;
box-shadow: none;
-webkit-overflow-scrolling: touch;
pre,
code {
padding: 0;
margin: 0;
border: 0;
}
}
.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: #93a1a1; } // 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: #93a1a1; } // 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 //
// ```[LANG]...```, kramdown line_numbers = true,
// {% highlight LANG linenos %}...{% endhighlight %}:
.highlight .table-wrapper {
padding: 0;
margin: 0;
border: 0;
box-shadow: none;
td,
pre {
@include fs-2;
min-width: 0;
padding: 0;
background-color: $code-background-color;
border: 0;
}
td.gl {
padding-right: $sp-3;
}
pre {
margin: 0;
line-height: 2;
}
}
.highlight .c {
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)
@@ -104,7 +323,7 @@ code {
.code-example {
padding: $sp-3;
margin-bottom: $sp-3;
overflow: scroll;
overflow: auto;
border: 1px solid $border-color;
border-radius: $border-radius;

View File

@@ -0,0 +1,17 @@
$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%);

View File

View File

@@ -1,25 +1,51 @@
@charset "UTF-8";
//
// Styles for rendered markdown in the .main-content container
//
// stylelint-disable selector-no-type, max-nesting-depth, selector-max-compound-selectors
// stylelint-disable selector-no-type, max-nesting-depth, selector-max-compound-selectors, selector-max-type
.main-content {
line-height: $content-line-height;
ol,
ul,
dl,
pre,
address,
blockquote,
.table-wrapper {
margin-top: 0.5em;
}
a {
overflow: hidden;
text-overflow: ellipsis;
white-space: nowrap;
}
.page-content {
ul,
ol {
padding-left: 1.5em;
}
li {
.highlight {
margin-top: $sp-1;
}
}
ol {
list-style-type: none;
counter-reset: step-counter;
li {
> li {
position: relative;
&::before {
position: absolute;
top: 0.2em;
left: -1.5em;
left: -1.6em;
color: $grey-dk-000;
content: counter(step-counter);
counter-increment: step-counter;
@@ -46,16 +72,33 @@
ul {
list-style: none;
li {
> li {
&::before {
position: absolute;
margin-left: -1.5em;
margin-left: -1.4em;
color: $grey-dk-000;
content: "";
}
}
}
.task-list {
padding-left: 0;
}
.task-list-item {
display: flex;
align-items: center;
&::before {
content: "";
}
}
.task-list-item-checkbox {
margin-right: 0.6em;
}
hr + * {
margin-top: 0;
}
@@ -66,7 +109,7 @@
dl {
display: grid;
grid-template-columns: max-content 1fr;
grid-template: auto / 10em 1fr;
}
dt,
@@ -75,15 +118,114 @@
}
dt {
grid-column: 1;
font-weight: 500;
text-align: right;
&::after {
content: ":";
}
}
dd {
grid-column: 2;
margin-bottom: 0;
margin-left: 1em;
font-weight: 500;
blockquote,
div,
dl,
dt,
h1,
h2,
h3,
h4,
h5,
h6,
li,
ol,
p,
pre,
table,
ul,
.table-wrapper {
&:first-child {
margin-top: 0;
}
}
}
dd,
ol,
ul {
dl:first-child {
dt:first-child,
dd:nth-child(2) {
margin-top: 0;
}
}
}
.anchor-heading {
position: absolute;
right: -$sp-4;
width: $sp-5;
height: 100%;
padding-right: $sp-1;
padding-left: $sp-1;
overflow: visible;
@include mq(md) {
right: auto;
left: -$sp-5;
}
svg {
display: inline-block;
width: 100%;
height: 100%;
color: $link-color;
visibility: hidden;
}
}
.anchor-heading:hover,
h1:hover > .anchor-heading,
h2:hover > .anchor-heading,
h3:hover > .anchor-heading,
h4:hover > .anchor-heading,
h5:hover > .anchor-heading,
h6:hover > .anchor-heading {
svg {
visibility: visible;
}
}
summary {
cursor: pointer;
}
h1,
h2,
h3,
h4,
h5,
h6 {
position: relative;
margin-top: 1.5em;
margin-bottom: 0.25em;
&:first-child {
margin-top: $sp-2;
}
+ table,
+ .table-wrapper,
+ .code-example,
+ .highlighter-rouge {
margin-top: 1em;
}
+ p {
margin-top: 0;
}
}
}

View File

@@ -1,112 +0,0 @@
// //
// // Typography
// //
//
// $body-font-family: -apple-system, BlinkMacSystemFont, "helvetica neue", helvetica, roboto, noto, "segoe ui", arial, sans-serif;
// $mono-font-family: "SFMono-Regular", Menlo, Consolas, Monospace;
// $root-font-size: 16px; // Base font-size for rems
// $body-line-height: 1.4;
// $body-heading-line-height: 1.15;
//
// //
// // Colors
// //
//
// $white: #fff;
//
// $grey-dk-000: #959396;
// $grey-dk-100: #5c5962;
// $grey-dk-200: #44434d;
// $grey-dk-300: #27262b;
//
// $grey-lt-000: #f5f6fa;
// $grey-lt-100: #eeebee;
// $grey-lt-200: #ecebed;
// $grey-lt-300: #e6e1e8;
//
// $purple-000: #7253ed;
// $purple-100: #5e41d0;
// $purple-200: #4e26af;
// $purple-300: #381885;
//
// $blue-000: #2c84fa;
// $blue-100: #2869e6;
// $blue-200: #264caf;
// $blue-300: #183385;
//
// $green-000: #41d693;
// $green-100: #11b584;
// $green-200: #009c7b;
// $green-300: #026e57;
//
// $body-text-color: $grey-dk-100;
// $body-heading-color: $grey-dk-300;
// $link-color: $purple-000;
//
// //
// // Media queries in pixels
// //
//
// $media-queries: (
// xs: 320px,
// sm: 500px,
// md: 740px,
// lg: 1120px,
// xl: 1400px
// );
//
// //
// // Spacing
// //
//
// $spacing-unit: 1rem; // 1rem == 16px
//
// $spacers: (
// sp-0: 0,
// sp-1: $spacing-unit * 0.25,
// sp-2: $spacing-unit * 0.5,
// sp-3: $spacing-unit * 0.75,
// sp-4: $spacing-unit,
// sp-5: $spacing-unit * 1.5,
// sp-6: $spacing-unit * 2,
// sp-7: $spacing-unit * 2.5,
// sp-8: $spacing-unit * 3,
// sp-9: $spacing-unit * 3.5,
// sp-10: $spacing-unit * 4
// );
//
// $sp-1: map-get($spacers, sp-1); // 0.25 rem == 4px
// $sp-2: map-get($spacers, sp-2); // 0.5 rem == 8px
// $sp-3: map-get($spacers, sp-3); // 0.75 rem == 12px
// $sp-4: map-get($spacers, sp-4); // 1 rem == 16px
// $sp-5: map-get($spacers, sp-5); // 1.5 rem == 24px
// $sp-6: map-get($spacers, sp-6); // 2 rem == 32px
// $sp-7: map-get($spacers, sp-7); // 2.5 rem == 40px
// $sp-8: map-get($spacers, sp-8); // 3 rem == 48px
// $sp-9: map-get($spacers, sp-9); // 4 rem == 48px
// $sp-10: map-get($spacers, sp-10); // 4.5 rem == 48px
//
// //
// // Borders
// //
//
// $border: 1px solid;
// $border-radius: 4px;
// $border-color: $grey-lt-100;
//
// //
// // Grid system
// //
//
// $gutter-spacing: $sp-6;
// $gutter-spacing-sm: $sp-4;
// $nav-width: 232px;
// $content-width: 800px;
//
// $media-queries: (
// xs: 320px,
// sm: 500px,
// md: 740px,
// lg: 800px,
// xl: 1316px
// );

View File

@@ -6,16 +6,17 @@
.label-blue {
display: inline-block;
padding-top: 0.16em;
padding-right: 0.42em;
padding-right: 0.56em;
padding-bottom: 0.16em;
padding-left: 0.42em;
margin-right: $sp-1;
margin-left: $sp-1;
padding-left: 0.56em;
margin-right: $sp-2;
margin-left: $sp-2;
color: $white;
text-transform: uppercase;
vertical-align: middle;
background-color: $blue-100;
text-transform: uppercase;
@include fs-2;
border-radius: 12px;
}
.label-green {

View File

@@ -2,34 +2,17 @@
// The basic two column layout
//
.page-wrap {
@include mq(md) {
position: absolute;
top: 0;
left: 0;
display: flex;
width: 100%;
height: 100%;
overflow-x: hidden;
overflow-y: hidden;
}
}
.side-bar {
z-index: 100;
z-index: 0;
display: flex;
flex-wrap: wrap;
padding-top: $gutter-spacing-sm;
padding-bottom: $gutter-spacing-sm;
background-color: $grey-lt-000;
background-color: $sidebar-color;
@include mq(md) {
flex-wrap: nowrap;
position: absolute;
width: $nav-width + 16px;
position: fixed;
width: $nav-width-md;
height: 100%;
padding-top: $gutter-spacing * 2;
padding-bottom: 0;
flex-direction: column;
border-right: $border $border-color;
align-items: flex-end;
@@ -41,83 +24,155 @@
}
}
.main-content-wrap {
@include mq(md) {
position: absolute;
top: 0;
left: 0;
width: 100%;
height: 100%;
min-height: 600px;
-webkit-overflow-scrolling: touch;
overflow-x: hidden;
overflow-y: scroll;
}
}
.main-content {
padding-top: $gutter-spacing-sm;
@include container;
.main {
@include mq(md) {
position: relative;
max-width: $content-width;
padding-top: $gutter-spacing;
padding-bottom: $gutter-spacing;
padding-left: $gutter-spacing * 1.5;
margin-left: $nav-width;
margin-left: $nav-width-md;
}
@include mq(lg) {
padding-left: $gutter-spacing;
margin-left: calc((100% - #{$nav-width + $content-width}) / 2 + #{$nav-width});
margin-left: calc(
(100% - #{$nav-width + $content-width}) / 2 + #{$nav-width}
);
}
}
.page-header {
background-color: $grey-lt-000;
.main-content-wrap {
@include container;
padding-top: $gutter-spacing-sm;
padding-bottom: $gutter-spacing-sm;
@include mq(md) {
background-color: $white;
border-bottom: $border $border-color;
padding-top: $gutter-spacing;
padding-bottom: $gutter-spacing;
}
}
.main-content {
padding-top: 0;
.main-header {
z-index: 0;
display: none;
background-color: $sidebar-color;
@include mq(md) {
display: flex;
justify-content: space-between;
padding-top: $sp-4;
height: $header-height;
background-color: $body-background-color;
border-bottom: $border $border-color;
}
&.nav-open {
display: block;
@include mq(md) {
display: flex;
}
}
}
.navigation,
.site-title,
.site-nav,
.site-header,
.site-footer {
@include container;
width: 100%;
@include mq(lg) {
width: $nav-width + 32px;
width: $nav-width;
}
}
.navigation {
.site-nav {
display: none;
&.nav-open {
display: block;
}
@include mq(md) {
display: block;
padding-top: $sp-8;
padding-bottom: $gutter-spacing-sm;
overflow-y: auto;
flex: 1 1 auto;
}
}
.site-header {
display: flex;
min-height: $header-height;
align-items: center;
@include mq(md) {
height: $header-height;
max-height: $header-height;
border-bottom: $border $border-color;
}
}
.site-title {
@include container;
flex-grow: 1;
display: flex;
height: 100%;
align-items: center;
padding-top: $sp-3;
padding-bottom: $sp-3;
color: $body-heading-color;
@include fs-6;
@include mq(md) {
padding-top: $sp-2;
padding-bottom: $sp-2;
}
}
@if variable-exists(logo) {
.site-logo {
width: 100%;
height: 100%;
background-image: url($logo);
background-repeat: no-repeat;
background-position: left center;
background-size: contain;
}
}
.site-button {
display: flex;
height: 100%;
padding: $gutter-spacing-sm;
align-items: center;
}
@include mq(md) {
.site-header .site-button {
display: none;
}
}
.site-title:hover {
background-image: linear-gradient(
-90deg,
rgba($feedback-color, 1) 0%,
rgba($feedback-color, 0.8) 80%,
rgba($feedback-color, 0) 100%
);
}
.site-button:hover {
background-image: linear-gradient(
-90deg,
rgba($feedback-color, 1) 0%,
rgba($feedback-color, 0.8) 100%
);
}
// stylelint-disable selector-max-type
body {
position: relative;
padding-bottom: $sp-10;
overflow-y: scroll;
@include mq(md) {
position: static;
@@ -125,16 +180,26 @@ body {
}
}
// stylelint-enable selector-max-type
.site-footer {
@include container;
position: absolute;
bottom: 0;
left: 0;
padding-top: $sp-4;
padding-bottom: $sp-4;
color: $grey-dk-000;
@include fs-2;
@include mq(md) {
position: static;
align-self: flex-end;
justify-self: end;
background-color: $grey-lt-000;
}
}
.icon {
width: $sp-5;
height: $sp-5;
color: $link-color;
}

20
_sass/modules.scss Normal file
View File

@@ -0,0 +1,20 @@
//
// Import external dependencies
//
@import "./vendor/normalize.scss/normalize.scss";
//
// Modules
//
@import "./base";
@import "./layout";
@import "./content";
@import "./navigation";
@import "./typography";
@import "./labels";
@import "./buttons";
@import "./search";
@import "./tables";
@import "./code";
@import "./utilities/utilities";
@import "./print";

View File

@@ -1,106 +1,194 @@
//
// Main nav, breadcrumb, etc...
//
// stylelint-disable selector-no-type, max-nesting-depth, selector-max-compound-selectors, selector-max-type, selector-max-specificity
.site-title {
display: block;
flex: 1 1 auto;
background-color: $grey-lt-000;
@include mq(md) {
position: absolute;
top: 0;
right: 0;
height: 60px;
padding-top: $sp-4;
z-index: 101;
box-shadow: inset 0 -1px 0 $border-color;
}
}
.navigation-list {
.nav-list {
padding: 0;
margin-top: $sp-4;
margin-top: 0;
margin-bottom: 0;
list-style: none;
@include mq(md) {
margin-top: 0;
}
}
.navigation-list-child-list {
padding-left: $sp-3;
list-style: none;
.navigation-list-link {
color: $grey-dk-100;
}
.navigation-list-item {
&::before {
position: absolute;
margin-top: 0.3em;
margin-left: -0.8em;
color: $grey-dk-000;
content: "- ";
}
&.active {
&::before {
color: $grey-dk-100;
}
}
}
}
.navigation-list-item {
.nav-list-item {
@include fs-4;
position: relative;
margin: 0;
@include mq(md) {
@include fs-3;
}
}
.navigation-list-link {
.nav-list-link {
display: block;
min-height: $nav-list-item-height-sm;
padding-top: $sp-1;
padding-bottom: $sp-1;
line-height: #{$nav-list-item-height-sm - 2 * $sp-1};
@if $nav-list-expander-right {
padding-right: $nav-list-item-height-sm;
padding-left: $gutter-spacing-sm;
} @else {
padding-right: $gutter-spacing-sm;
padding-left: $nav-list-item-height-sm;
}
@include mq(md) {
min-height: $nav-list-item-height;
line-height: #{$nav-list-item-height - 2 * $sp-1};
@if $nav-list-expander-right {
padding-right: $nav-list-item-height;
padding-left: $gutter-spacing;
} @else {
padding-right: $gutter-spacing;
padding-left: $nav-list-item-height;
}
}
&.active {
font-weight: 600;
color: $grey-dk-200;
text-decoration: none;
}
}
// Small screen nav
.main-nav,
.aux-nav {
display: none;
&.nav-open {
display: block;
&:hover,
&.active {
background-image: linear-gradient(
-90deg,
rgba($feedback-color, 1) 0%,
rgba($feedback-color, 0.8) 80%,
rgba($feedback-color, 0) 100%
);
}
@include mq(md) {
display: block;
}
}
.navigation-list-toggle {
.nav-list-expander {
position: absolute;
right: $sp-4;
@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};
padding-right: #{$nav-list-item-height-sm / 4};
padding-bottom: #{$nav-list-item-height-sm / 4};
padding-left: #{$nav-list-item-height-sm / 4};
color: $link-color;
@include mq(md) {
display: none !important;
width: $nav-list-item-height;
height: $nav-list-item-height;
padding-top: #{$nav-list-item-height / 4};
padding-right: #{$nav-list-item-height / 4};
padding-bottom: #{$nav-list-item-height / 4};
padding-left: #{$nav-list-item-height / 4};
}
&:hover {
background-image: linear-gradient(
-90deg,
rgba($feedback-color, 1) 0%,
rgba($feedback-color, 0.8) 100%
);
}
@if $nav-list-expander-right {
svg {
transform: rotate(90deg);
}
}
}
> .nav-list {
display: none;
padding-left: $sp-3;
list-style: none;
.nav-list-item {
position: relative;
.nav-list-link {
color: $nav-child-link-color;
}
.nav-list-expander {
color: $nav-child-link-color;
}
}
}
&.active {
> .nav-list-expander svg {
@if $nav-list-expander-right {
transform: rotate(-90deg);
} @else {
transform: rotate(90deg);
}
}
> .nav-list {
display: block;
}
}
}
}
.nav-category {
padding-top: $sp-2;
padding-right: $gutter-spacing-sm;
padding-bottom: $sp-2;
padding-left: $gutter-spacing-sm;
font-weight: 600;
text-align: end;
text-transform: uppercase;
border-bottom: $border $border-color;
@include fs-2;
@include mq(md) {
padding-right: $gutter-spacing;
padding-left: $gutter-spacing;
margin-top: $gutter-spacing-sm;
text-align: start;
&:first-child {
margin-top: 0;
}
}
}
// Aux nav
.aux-nav {
height: 100%;
overflow-x: auto;
@include fs-2;
.aux-nav-list {
display: flex;
height: 100%;
padding: 0;
margin: 0;
list-style: none;
}
.aux-nav-list-item {
display: inline-block;
height: 100%;
padding: 0;
margin: 0;
}
@include mq(md) {
padding-right: $gutter-spacing-sm;
}
}
// Breadcrumb nav
.breadcrumb-nav {
@include mq(md) {
margin-top: -$sp-4;
}
}
.breadcrumb-nav-list {
padding-left: 0;
margin-bottom: $sp-3;

40
_sass/print.scss Normal file
View File

@@ -0,0 +1,40 @@
// stylelint-disable selector-max-specificity, selector-max-id, selector-max-type, selector-no-qualifying-type, primer/no-override,
@media print {
.site-footer,
.site-button,
#edit-this-page,
#back-to-top,
.site-nav,
.main-header {
display: none !important;
}
.side-bar {
width: 100%;
height: auto;
border-right: 0 !important;
}
.site-header {
border-bottom: 1px solid $border-color;
}
.site-title {
font-size: $root-font-size !important;
font-weight: 700 !important;
}
.text-small {
font-size: 8pt !important;
}
pre.highlight {
border: 1px solid $border-color;
}
.main {
max-width: none;
margin-left: 0;
}
}

View File

@@ -4,94 +4,122 @@
.search {
position: relative;
z-index: 99;
display: none;
z-index: 2;
flex-grow: 1;
height: $sp-10;
padding: $sp-2;
margin-bottom: $sp-3;
background-color: $white;
border-radius: 3px;
box-shadow: 0 1px 2px rgba(0, 0, 0, 0.07), 0 3px 10px rgba(0, 0, 0, 0.05);
transition: padding linear #{$transition-duration / 2};
@include mq(md) {
display: block;
padding-top: $sp-1;
padding-right: 0;
padding-bottom: $sp-4;
padding-left: 0;
margin-bottom: 0;
background-color: transparent;
box-shadow: none;
}
&.nav-open {
display: block;
}
}
.search-results-wrap {
display: none;
&.active {
position: absolute;
top: $sp-1;
z-index: 100;
display: block;
width: 300px;
margin-top: $gutter-spacing;
background: $white;
box-shadow: 0 1px 3px rgba(0, 0, 0, 0.07), 0 4px 14px rgba(0, 0, 0, 0.05);
position: relative !important;
width: auto !important;
height: 100% !important;
padding: 0;
transition: none;
}
}
.search-input-wrap {
display: flex;
background-color: $white;
position: relative;
z-index: 1;
height: $sp-8;
overflow: hidden;
border-radius: $border-radius;
box-shadow: 0 1px 2px rgba(0, 0, 0, 0.12), 0 3px 10px rgba(0, 0, 0, 0.08);
transition: height linear #{$transition-duration / 2};
@include mq(md) {
position: absolute;
width: 100%;
max-width: $search-results-width;
height: 100% !important;
border-radius: 0;
box-shadow: none;
transition: width ease $transition-duration;
}
}
.search-input {
position: absolute;
width: 100%;
padding-top: $sp-1;
padding-bottom: $sp-1;
height: 100%;
padding-top: $sp-2;
padding-right: $gutter-spacing-sm;
padding-bottom: $sp-2;
padding-left: #{$gutter-spacing-sm + $sp-5};
font-size: 16px;
background-color: $search-background-color;
border-top: 0;
border-right: 0;
border-bottom: 0;
border-left: 0;
order: 2;
border-radius: 0;
@include mq(md) {
padding-top: $gutter-spacing-sm;
padding-bottom: $gutter-spacing-sm;
padding-left: #{$gutter-spacing + $sp-5};
font-size: 14px;
background-color: $body-background-color;
transition: padding-left linear #{$transition-duration / 2};
}
&:focus {
outline: 0;
box-shadow: none;
+ .search-icon {
fill: $purple-000;
+ .search-label .search-icon {
color: $link-color;
}
}
@include fs-5;
@include mq(sm) {
@include fs-3;
}
@include mq(md) {
@include fs-2;
}
}
.search-icon {
.search-label {
position: absolute;
display: flex;
height: 100%;
padding-left: $gutter-spacing-sm;
@include mq(md) {
padding-left: $gutter-spacing;
transition: padding-left linear #{$transition-duration / 2};
}
.search-icon {
width: #{$sp-4 * 1.2};
height: #{$sp-4 * 1.2};
align-self: center;
margin-right: $sp-2;
fill: $grey-dk-000;
order: 1;
color: $grey-dk-000;
}
}
.search-results {
position: absolute;
left: 0;
display: none;
width: 100%;
max-height: calc(100% - #{$sp-10});
overflow-y: auto;
background-color: $search-background-color;
border-bottom-right-radius: $border-radius;
border-bottom-left-radius: $border-radius;
box-shadow: 0 1px 2px rgba(0, 0, 0, 0.12), 0 3px 10px rgba(0, 0, 0, 0.08);
@include mq(md) {
top: 100%;
width: $search-results-width;
max-height: calc(100vh - 200%) !important;
}
}
.search-results-list {
padding-left: 0;
margin-top: $sp-1;
margin-bottom: $sp-1;
list-style: none;
@include fs-4;
@include mq(md) {
@include fs-3;
}
}
.search-results-list-item {
@@ -99,14 +127,197 @@
margin: 0;
}
.search-results-link {
.search-result {
display: block;
padding-top: $sp-1;
padding-right: $sp-3;
padding-bottom: $sp-1;
padding-left: $sp-3;
&:hover {
background-color: $grey-lt-000;
&:hover,
&.active {
background-color: $feedback-color;
}
}
.search-result-title {
display: block;
padding-top: $sp-2;
padding-bottom: $sp-2;
@include mq(sm) {
display: inline-block;
width: 40%;
padding-right: $sp-2;
vertical-align: top;
}
}
.search-result-doc {
display: flex;
align-items: center;
word-wrap: break-word;
&.search-result-doc-parent {
opacity: 0.5;
@include fs-3;
@include mq(md) {
@include fs-2;
}
}
.search-result-icon {
width: $sp-4;
height: $sp-4;
margin-right: $sp-2;
color: $link-color;
flex-shrink: 0;
}
.search-result-doc-title {
overflow: auto;
}
}
.search-result-section {
margin-left: #{$sp-4 + $sp-2};
word-wrap: break-word;
}
.search-result-rel-url {
display: block;
margin-left: #{$sp-4 + $sp-2};
overflow: hidden;
color: $search-result-preview-color;
text-overflow: ellipsis;
white-space: nowrap;
@include fs-1;
}
.search-result-previews {
display: block;
padding-top: $sp-2;
padding-bottom: $sp-2;
padding-left: $sp-4;
margin-left: $sp-2;
color: $search-result-preview-color;
word-wrap: break-word;
border-left: $border;
border-left-color: $border-color;
@include fs-2;
@include mq(sm) {
display: inline-block;
width: 60%;
padding-left: $sp-2;
margin-left: 0;
vertical-align: top;
}
}
.search-result-preview + .search-result-preview {
margin-top: $sp-1;
}
.search-result-highlight {
font-weight: bold;
}
.search-no-result {
padding-top: $sp-2;
padding-right: $sp-3;
padding-bottom: $sp-2;
padding-left: $sp-3;
@include fs-3;
}
.search-button {
position: fixed;
right: $sp-4;
bottom: $sp-4;
display: flex;
width: $sp-9;
height: $sp-9;
background-color: $search-background-color;
border: 1px solid rgba($link-color, 0.3);
border-radius: #{$sp-9 / 2};
box-shadow: 0 1px 2px rgba(0, 0, 0, 0.12), 0 3px 10px rgba(0, 0, 0, 0.08);
align-items: center;
justify-content: center;
}
.search-overlay {
position: fixed;
top: 0;
left: 0;
z-index: 1;
width: 0;
height: 0;
background-color: rgba(0, 0, 0, 0.3);
opacity: 0;
transition: opacity ease $transition-duration, width 0s $transition-duration,
height 0s $transition-duration;
}
.search-active {
.search {
position: fixed;
top: 0;
left: 0;
width: 100%;
height: 100%;
padding: 0;
}
.search-input-wrap {
height: $sp-10;
border-radius: 0;
@include mq(md) {
width: $search-results-width;
box-shadow: 0 1px 2px rgba(0, 0, 0, 0.12), 0 3px 10px rgba(0, 0, 0, 0.08);
}
}
.search-input {
background-color: $search-background-color;
@include mq(md) {
padding-left: 2.3rem;
}
}
.search-label {
@include mq(md) {
padding-left: 0.6rem;
}
}
.search-results {
display: block;
}
.search-overlay {
width: 100%;
height: 100%;
opacity: 1;
transition: opacity ease $transition-duration, width 0s, height 0s;
}
@include mq(md) {
.main {
position: fixed;
right: 0;
left: 0;
}
}
.main-header {
padding-top: $sp-10;
@include mq(md) {
padding-top: 0;
}
}
}

View File

@@ -1,10 +1,9 @@
@function rem($size, $unit:"") {
@function rem($size, $unit: "") {
$remSize: $size / $root-font-size;
@if ($unit == false) {
@return #{$remSize};
}
@else {
} @else {
@return #{$remSize}rem;
}
}

View File

@@ -2,11 +2,31 @@
// Typography
//
$body-font-family: -apple-system, BlinkMacSystemFont, "helvetica neue", helvetica, roboto, noto, "segoe ui", arial, sans-serif !default;
$body-font-family: system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI",
Roboto, "Helvetica Neue", Arial, sans-serif !default;
$mono-font-family: "SFMono-Regular", Menlo, Consolas, Monospace !default;
$root-font-size: 16px !default; // Base font-size for rems
$body-line-height: 1.4 !default;
$body-heading-line-height: 1.15 !default !default;
$content-line-height: 1.6 !default;
$body-heading-line-height: 1.25 !default;
//
// Font size
// `-sm` suffix is the size at the small (and above) media query
//
$font-size-1: 9px !default;
$font-size-1-sm: 10px !default;
$font-size-2: 11px !default; //h4 - uppercased!, h6 not uppercased, text-small
$font-size-3: 12px !default; //h5
$font-size-4: 14px !default;
$font-size-5: 16px !default; //h3
$font-size-6: 18px !default; //h2
$font-size-7: 24px !default;
$font-size-8: 32px !default; //h1
$font-size-9: 36px !default;
$font-size-10: 42px !default;
$font-size-10-sm: 48px !default;
//
// Colors
@@ -17,6 +37,7 @@ $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;
@@ -49,21 +70,20 @@ $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;
$nav-child-link-color: $grey-dk-100 !default;
$link-color: $purple-000 !default;
//
// Media queries in pixels
//
$media-queries: (
xs: 320px,
sm: 500px,
md: 740px,
lg: 1120px,
xl: 1400px
) !default;
$btn-primary-color: $purple-100 !default;
$base-button-color: #f7f7f7 !default;
//
// Spacing
@@ -82,7 +102,7 @@ $spacers: (
sp-7: $spacing-unit * 2.5,
sp-8: $spacing-unit * 3,
sp-9: $spacing-unit * 3.5,
sp-10: $spacing-unit * 4
sp-10: $spacing-unit * 4,
) !default;
$sp-1: map-get($spacers, sp-1) !default; // 0.25 rem == 4px
@@ -93,8 +113,8 @@ $sp-5: map-get($spacers, sp-5) !default; // 1.5 rem == 24px
$sp-6: map-get($spacers, sp-6) !default; // 2 rem == 32px
$sp-7: map-get($spacers, sp-7) !default; // 2.5 rem == 40px
$sp-8: map-get($spacers, sp-8) !default; // 3 rem == 48px
$sp-9: map-get($spacers, sp-9) !default; // 4 rem == 48px
$sp-10: map-get($spacers, sp-10) !default; // 4.5 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
@@ -110,13 +130,24 @@ $border-color: $grey-lt-100 !default;
$gutter-spacing: $sp-6 !default;
$gutter-spacing-sm: $sp-4 !default;
$nav-width: 232px !default;
$nav-width: 264px !default;
$nav-width-md: 248px !default;
$nav-list-item-height: $sp-6 !default;
$nav-list-item-height-sm: $sp-8 !default;
$nav-list-expander-right: true;
$content-width: 800px !default;
$header-height: 60px !default;
$search-results-width: $content-width - $nav-width !default;
$transition-duration: 400ms;
//
// Media queries in pixels
//
$media-queries: (
xs: 320px,
sm: 500px,
md: 740px,
lg: 800px,
xl: 1316px
md: $content-width,
lg: $content-width + $nav-width,
xl: 1400px,
) !default;

View File

@@ -24,11 +24,11 @@
// Responsive container
@mixin container {
padding-left: $gutter-spacing-sm;
padding-right: $gutter-spacing-sm;
padding-left: $gutter-spacing-sm;
@include mq(md) {
padding-left: $gutter-spacing;
padding-right: $gutter-spacing;
padding-left: $gutter-spacing;
}
}

View File

@@ -1,81 +1,84 @@
// Font size
@mixin fs-1 {
font-size: 9px !important;
font-size: $font-size-1 !important;
@include mq(sm) {
font-size: 10px !important;
font-size: $font-size-1-sm !important;
}
}
@mixin fs-2 {
font-size: 11px !important;
font-size: $font-size-2 !important;
@include mq(sm) {
font-size: 12px !important;
font-size: $font-size-3 !important;
}
}
@mixin fs-3 {
font-size: 12px !important;
font-size: $font-size-3 !important;
@include mq(sm) {
font-size: 14px !important;
font-size: $font-size-4 !important;
}
}
@mixin fs-4 {
font-size: 14px !important;
font-size: $font-size-4 !important;
@include mq(sm) {
font-size: 16px !important;
font-size: $font-size-5 !important;
}
}
@mixin fs-5 {
font-size: 16px !important;
font-size: $font-size-5 !important;
@include mq(sm) {
font-size: 18px !important;
font-size: $font-size-6 !important;
}
}
@mixin fs-6 {
font-size: 18px !important;
font-size: $font-size-6 !important;
@include mq(sm) {
font-size: 24px !important;
font-size: $font-size-7 !important;
line-height: $body-heading-line-height;
}
}
@mixin fs-7 {
font-size: 24px !important;
font-size: $font-size-7 !important;
line-height: $body-heading-line-height;
@include mq(sm) {
font-size: 32px !important;
font-size: $font-size-8 !important;
}
}
@mixin fs-8 {
font-size: 32px !important;
font-size: $font-size-8 !important;
line-height: $body-heading-line-height;
@include mq(sm) {
font-size: 36px !important;
font-size: $font-size-9 !important;
}
}
@mixin fs-9 {
font-size: 36px !important;
font-size: $font-size-9 !important;
line-height: $body-heading-line-height;
@include mq(sm) {
font-size: 42px !important;
font-size: $font-size-10 !important;
}
}
@mixin fs-10 {
font-size: 42px !important;
font-size: $font-size-10 !important;
line-height: $body-heading-line-height;
@include mq(sm) {
font-size: 48px !important;
font-size: $font-size-10-sm !important;
}
}

View File

@@ -1,20 +1,22 @@
//
// Tables
//
// stylelint-disable max-nesting-depth, selector-no-type
// stylelint-disable max-nesting-depth, selector-no-type, selector-max-type
table {
.table-wrapper {
display: block;
width: 100%;
max-width: 100%;
margin-bottom: $sp-5;
overflow-x: auto;
border-collapse: separate;
box-shadow: 0 1px 3px rgba(0, 0, 0, 0.07), 0 4px 14px rgba(0, 0, 0, 0.05);
border-radius: $border-radius;
box-shadow: 0 1px 2px rgba(0, 0, 0, 0.12), 0 3px 10px rgba(0, 0, 0, 0.08);
}
@include mq(sm) {
table {
display: table;
}
min-width: 100%;
border-collapse: separate;
}
th,
@@ -25,7 +27,8 @@ td {
padding-right: $sp-3;
padding-bottom: $sp-2;
padding-left: $sp-3;
border-bottom: $border $grey-lt-000;
background-color: $table-background-color;
border-bottom: $border rgba($border-color, 0.5);
border-left: $border $border-color;
&:first-of-type {
@@ -33,38 +36,16 @@ td {
}
}
thead,
tbody:first-child {
tr {
&:first-of-type {
th,
td {
&:first-of-type {
border-top-left-radius: $border-radius;
}
&:last-of-type {
border-top-right-radius: $border-radius;
}
}
}
}
}
tbody {
tr {
&:last-of-type {
th,
td {
border-bottom: 0;
&:first-of-type {
border-bottom-left-radius: $border-radius;
}
&:last-of-type {
border-bottom-right-radius: $border-radius;
}
td {
padding-bottom: $sp-3;
}
}
}
@@ -72,6 +53,6 @@ tbody {
thead {
th {
border-bottom: 1px solid $border-color;
border-bottom: $border $border-color;
}
}

View File

@@ -1,7 +1,7 @@
//
// Typography
//
// stylelint-disable primer/selector-no-utility, selector-no-type
// stylelint-disable primer/selector-no-utility, primer/no-override, selector-no-type, selector-max-type
h1,
.text-alpha {
@@ -22,11 +22,15 @@ h3,
h4,
.text-delta {
@include fs-2;
font-weight: 300;
font-weight: 400;
text-transform: uppercase;
letter-spacing: 0.1em;
}
h4 code {
text-transform: none;
}
h5,
.text-epsilon {
@include fs-3;
@@ -39,12 +43,6 @@ h6,
color: $grey-dk-200;
}
li {
.highlight {
margin-top: $sp-2;
}
}
.text-small {
@include fs-2;
}
@@ -53,6 +51,14 @@ li {
font-family: $mono-font-family !important;
}
.text-left {
text-align: left !important;
}
.text-center {
text-align: center !important;
}
.text-right {
text-align: right !important;
}

View File

@@ -16,6 +16,10 @@
color: $grey-dk-200 !important;
}
.text-grey-dk-250 {
color: $grey-dk-250 !important;
}
.text-grey-dk-300 {
color: $grey-dk-300 !important;
}
@@ -130,6 +134,10 @@
background-color: $grey-dk-200 !important;
}
.bg-grey-dk-250 {
background-color: $grey-dk-250 !important;
}
.bg-grey-dk-300 {
background-color: $grey-dk-300 !important;
}

View File

@@ -1,15 +1,25 @@
// stylelint-disable primer/selector-no-utility
// 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; }
.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;
}
@each $media-query in map-keys($media-queries) {
@for $i from 1 through length($spacers) {
@@ -18,21 +28,68 @@
$scale: #{$i - 1};
// .d-sm-block, .d-md-none, .d-lg-inline
.d-#{$media-query}-block { display: block !important; }
.d-#{$media-query}-flex { display: flex !important; }
.d-#{$media-query}-inline { display: inline !important; }
.d-#{$media-query}-inline-block { display: inline-block !important; }
.d-#{$media-query}-none { display: none !important; }
.d-#{$media-query}-block {
display: block !important;
}
.d-#{$media-query}-flex {
display: flex !important;
}
.d-#{$media-query}-inline {
display: inline !important;
}
.d-#{$media-query}-inline-block {
display: inline-block !important;
}
.d-#{$media-query}-none {
display: none !important;
}
}
}
}
// Horizontal alignment
.float-left {
float: left !important;
}
.float-right {
float: right !important;
}
.flex-justify-start {
justify-content: flex-start !important;
}
.flex-justify-end {
justify-content: flex-end !important;
}
.flex-justify-between {
justify-content: space-between !important;
}
.flex-justify-around {
justify-content: space-around !important;
}
// Vertical alignment
.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; }
.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;
}

View File

@@ -2,10 +2,16 @@
// Utility classes for lists
//
// stylelint-disable primer/selector-no-utility
// stylelint-disable primer/selector-no-utility, primer/no-override, selector-max-type
.list-style-none {
padding: 0 !important;
margin: 0 !important;
list-style: none !important;
li {
&::before {
display: none !important;
}
}
}

View File

@@ -3,20 +3,35 @@
//
// scss-lint:disable SpaceAfterPropertyName
// stylelint-disable block-opening-brace-space-after, block-opening-brace-space-before, primer/selector-no-utility
// stylelint-disable block-opening-brace-space-after, block-opening-brace-space-before, primer/selector-no-utility, primer/no-override
// Margin spacer utilities
.mx-auto {
margin-right: auto !important;
margin-left: auto !important;
}
@for $i from 1 through length($spacers) {
$size: #{map-get($spacers, sp-#{$i - 1})};
$scale: #{$i - 1};
// .m-0, .m-1, .m-2...
.m-#{$scale} { margin: #{$size} !important; }
.mt-#{$scale} { margin-top: #{$size} !important; }
.mr-#{$scale} { margin-right: #{$size} !important; }
.mb-#{$scale} { margin-bottom: #{$size} !important; }
.ml-#{$scale} { margin-left: #{$size} !important; }
.m-#{$scale} {
margin: #{$size} !important;
}
.mt-#{$scale} {
margin-top: #{$size} !important;
}
.mr-#{$scale} {
margin-right: #{$size} !important;
}
.mb-#{$scale} {
margin-bottom: #{$size} !important;
}
.ml-#{$scale} {
margin-left: #{$size} !important;
}
.mx-#{$scale} {
margin-right: #{$size} !important;
@@ -32,11 +47,10 @@
margin-right: -#{$size} !important;
margin-left: -#{$size} !important;
}
}
.mx-auto {
.mx-#{$scale}-auto {
margin-right: auto !important;
margin-left: auto !important;
}
}
@each $media-query in map-keys($media-queries) {
@@ -46,11 +60,21 @@
$scale: #{$i - 1};
// .m-sm-0, .m-md-1, .m-lg-2...
.m-#{$media-query}-#{$scale} { margin: #{$size} !important; }
.mt-#{$media-query}-#{$scale} { margin-top: #{$size} !important; }
.mr-#{$media-query}-#{$scale} { margin-right: #{$size} !important; }
.mb-#{$media-query}-#{$scale} { margin-bottom: #{$size} !important; }
.ml-#{$media-query}-#{$scale} { margin-left: #{$size} !important; }
.m-#{$media-query}-#{$scale} {
margin: #{$size} !important;
}
.mt-#{$media-query}-#{$scale} {
margin-top: #{$size} !important;
}
.mr-#{$media-query}-#{$scale} {
margin-right: #{$size} !important;
}
.mb-#{$media-query}-#{$scale} {
margin-bottom: #{$size} !important;
}
.ml-#{$media-query}-#{$scale} {
margin-left: #{$size} !important;
}
.mx-#{$media-query}-#{$scale} {
margin-right: #{$size} !important;
@@ -77,11 +101,21 @@
$scale: #{$i - 1};
// .p-0, .p-1, .p-2...
.p-#{$scale} { padding: #{$size} !important; }
.pt-#{$scale} { padding-top: #{$size} !important; }
.pr-#{$scale} { padding-right: #{$size} !important; }
.pb-#{$scale} { padding-bottom: #{$size} !important; }
.pl-#{$scale} { padding-left: #{$size} !important; }
.p-#{$scale} {
padding: #{$size} !important;
}
.pt-#{$scale} {
padding-top: #{$size} !important;
}
.pr-#{$scale} {
padding-right: #{$size} !important;
}
.pb-#{$scale} {
padding-bottom: #{$size} !important;
}
.pl-#{$scale} {
padding-left: #{$size} !important;
}
.px-#{$scale} {
padding-right: #{$size} !important;
@@ -101,11 +135,21 @@
$scale: #{$i - 1};
// .p-sm-0, .p-md-1, .p-lg-2...
.p-#{$media-query}-#{$scale} { padding: #{$size} !important; }
.pt-#{$media-query}-#{$scale} { padding-top: #{$size} !important; }
.pr-#{$media-query}-#{$scale} { padding-right: #{$size} !important; }
.pb-#{$media-query}-#{$scale} { padding-bottom: #{$size} !important; }
.pl-#{$media-query}-#{$scale} { padding-left: #{$size} !important; }
.p-#{$media-query}-#{$scale} {
padding: #{$size} !important;
}
.pt-#{$media-query}-#{$scale} {
padding-top: #{$size} !important;
}
.pr-#{$media-query}-#{$scale} {
padding-right: #{$size} !important;
}
.pb-#{$media-query}-#{$scale} {
padding-bottom: #{$size} !important;
}
.pl-#{$media-query}-#{$scale} {
padding-left: #{$size} !important;
}
.px-#{$media-query}-#{$scale} {
padding-right: #{$size} !important;

View File

@@ -2,7 +2,7 @@
// Utility classes for typography
//
// stylelint-disable primer/selector-no-utility
// stylelint-disable primer/selector-no-utility, primer/no-override
.fs-1 {
@include fs-1;

7
_sass/vendor/normalize.scss/README.md vendored Normal file
View File

@@ -0,0 +1,7 @@
# normalize.scss
Normalize.scss is an SCSS copy of [normalize.css](http://necolas.github.io/normalize.css), a customisable CSS file that makes browsers render all elements more consistently and in line with modern standards.
The [normalize.scss fork](https://github.com/guerrero/normalize.scss) of [normalize.css](http://necolas.github.io/normalize.css) was archived in 2014, and has not been updated since v0.1.0.
[View the normalize.css test file](http://necolas.github.io/normalize.css/latest/test.html)

View File

@@ -0,0 +1,349 @@
/*! normalize.css v8.0.1 | MIT License | github.com/necolas/normalize.css */
/* Document
========================================================================== */
/**
* 1. Correct the line height in all browsers.
* 2. Prevent adjustments of font size after orientation changes in iOS.
*/
html {
line-height: 1.15; /* 1 */
-webkit-text-size-adjust: 100%; /* 2 */
}
/* Sections
========================================================================== */
/**
* Remove the margin in all browsers.
*/
body {
margin: 0;
}
/**
* Render the `main` element consistently in IE.
*/
main {
display: block;
}
/**
* Correct the font size and margin on `h1` elements within `section` and
* `article` contexts in Chrome, Firefox, and Safari.
*/
h1 {
font-size: 2em;
margin: 0.67em 0;
}
/* Grouping content
========================================================================== */
/**
* 1. Add the correct box sizing in Firefox.
* 2. Show the overflow in Edge and IE.
*/
hr {
box-sizing: content-box; /* 1 */
height: 0; /* 1 */
overflow: visible; /* 2 */
}
/**
* 1. Correct the inheritance and scaling of font size in all browsers.
* 2. Correct the odd `em` font sizing in all browsers.
*/
pre {
font-family: monospace, monospace; /* 1 */
font-size: 1em; /* 2 */
}
/* Text-level semantics
========================================================================== */
/**
* Remove the gray background on active links in IE 10.
*/
a {
background-color: transparent;
}
/**
* 1. Remove the bottom border in Chrome 57-
* 2. Add the correct text decoration in Chrome, Edge, IE, Opera, and Safari.
*/
abbr[title] {
border-bottom: none; /* 1 */
text-decoration: underline; /* 2 */
text-decoration: underline dotted; /* 2 */
}
/**
* Add the correct font weight in Chrome, Edge, and Safari.
*/
b,
strong {
font-weight: bolder;
}
/**
* 1. Correct the inheritance and scaling of font size in all browsers.
* 2. Correct the odd `em` font sizing in all browsers.
*/
code,
kbd,
samp {
font-family: monospace, monospace; /* 1 */
font-size: 1em; /* 2 */
}
/**
* Add the correct font size in all browsers.
*/
small {
font-size: 80%;
}
/**
* Prevent `sub` and `sup` elements from affecting the line height in
* all browsers.
*/
sub,
sup {
font-size: 75%;
line-height: 0;
position: relative;
vertical-align: baseline;
}
sub {
bottom: -0.25em;
}
sup {
top: -0.5em;
}
/* Embedded content
========================================================================== */
/**
* Remove the border on images inside links in IE 10.
*/
img {
border-style: none;
}
/* Forms
========================================================================== */
/**
* 1. Change the font styles in all browsers.
* 2. Remove the margin in Firefox and Safari.
*/
button,
input,
optgroup,
select,
textarea {
font-family: inherit; /* 1 */
font-size: 100%; /* 1 */
line-height: 1.15; /* 1 */
margin: 0; /* 2 */
}
/**
* Show the overflow in IE.
* 1. Show the overflow in Edge.
*/
button,
input { /* 1 */
overflow: visible;
}
/**
* Remove the inheritance of text transform in Edge, Firefox, and IE.
* 1. Remove the inheritance of text transform in Firefox.
*/
button,
select { /* 1 */
text-transform: none;
}
/**
* Correct the inability to style clickable types in iOS and Safari.
*/
button,
[type="button"],
[type="reset"],
[type="submit"] {
-webkit-appearance: button;
}
/**
* Remove the inner border and padding in Firefox.
*/
button::-moz-focus-inner,
[type="button"]::-moz-focus-inner,
[type="reset"]::-moz-focus-inner,
[type="submit"]::-moz-focus-inner {
border-style: none;
padding: 0;
}
/**
* Restore the focus styles unset by the previous rule.
*/
button:-moz-focusring,
[type="button"]:-moz-focusring,
[type="reset"]:-moz-focusring,
[type="submit"]:-moz-focusring {
outline: 1px dotted ButtonText;
}
/**
* Correct the padding in Firefox.
*/
fieldset {
padding: 0.35em 0.75em 0.625em;
}
/**
* 1. Correct the text wrapping in Edge and IE.
* 2. Correct the color inheritance from `fieldset` elements in IE.
* 3. Remove the padding so developers are not caught out when they zero out
* `fieldset` elements in all browsers.
*/
legend {
box-sizing: border-box; /* 1 */
color: inherit; /* 2 */
display: table; /* 1 */
max-width: 100%; /* 1 */
padding: 0; /* 3 */
white-space: normal; /* 1 */
}
/**
* Add the correct vertical alignment in Chrome, Firefox, and Opera.
*/
progress {
vertical-align: baseline;
}
/**
* Remove the default vertical scrollbar in IE 10+.
*/
textarea {
overflow: auto;
}
/**
* 1. Add the correct box sizing in IE 10.
* 2. Remove the padding in IE 10.
*/
[type="checkbox"],
[type="radio"] {
box-sizing: border-box; /* 1 */
padding: 0; /* 2 */
}
/**
* Correct the cursor style of increment and decrement buttons in Chrome.
*/
[type="number"]::-webkit-inner-spin-button,
[type="number"]::-webkit-outer-spin-button {
height: auto;
}
/**
* 1. Correct the odd appearance in Chrome and Safari.
* 2. Correct the outline style in Safari.
*/
[type="search"] {
-webkit-appearance: textfield; /* 1 */
outline-offset: -2px; /* 2 */
}
/**
* Remove the inner padding in Chrome and Safari on macOS.
*/
[type="search"]::-webkit-search-decoration {
-webkit-appearance: none;
}
/**
* 1. Correct the inability to style clickable types in iOS and Safari.
* 2. Change font properties to `inherit` in Safari.
*/
::-webkit-file-upload-button {
-webkit-appearance: button; /* 1 */
font: inherit; /* 2 */
}
/* Interactive
========================================================================== */
/*
* Add the correct display in Edge, IE 10+, and Firefox.
*/
details {
display: block;
}
/*
* Add the correct display in all browsers.
*/
summary {
display: list-item;
}
/* Misc
========================================================================== */
/**
* Add the correct display in IE 10+.
*/
template {
display: none;
}
/**
* Add the correct display in IE 10.
*/
[hidden] {
display: none;
}

View File

@@ -0,0 +1,3 @@
---
---
{% include css/just-the-docs.scss.liquid color_scheme="dark" %}

View File

@@ -0,0 +1,8 @@
---
---
{% if site.color_scheme and site.color_scheme != "nil" %}
{% assign color_scheme = site.color_scheme %}
{% else %}
{% assign color_scheme = "light" %}
{% endif %}
{% include css/just-the-docs.scss.liquid color_scheme=color_scheme %}

View File

@@ -0,0 +1,3 @@
---
---
{% include css/just-the-docs.scss.liquid color_scheme="light" %}

View File

@@ -1,33 +0,0 @@
---
# this ensures Jekyll reads the file to be transformed into CSS later
# only Main files contain this front matter, not partials.
---
//
// Import dependancies
//
@import "./normalize.scss/normalize.scss";
//
// Import Just the docs scss
//
// Support
@import "./support/support";
// Custom overrides
@import "./custom/custom";
// Modules
@import "./base";
@import "./layout";
@import "./content";
@import "./navigation";
@import "./typography";
@import "./labels";
@import "./buttons";
@import "./search";
@import "./tables";
@import "./code";
@import "./utilities/utilities";

View File

@@ -1,168 +1,471 @@
---
---
(function (jtd, undefined) {
// Event handling
function addEvent(el, type, handler) {
jtd.addEvent = function(el, type, handler) {
if (el.attachEvent) el.attachEvent('on'+type, handler); else el.addEventListener(type, handler);
}
function removeEvent(el, type, handler) {
jtd.removeEvent = function(el, type, handler) {
if (el.detachEvent) el.detachEvent('on'+type, handler); else el.removeEventListener(type, handler);
}
jtd.onReady = function(ready) {
// in case the document is already rendered
if (document.readyState!='loading') ready();
// modern browsers
else if (document.addEventListener) document.addEventListener('DOMContentLoaded', ready);
// IE <= 8
else document.attachEvent('onreadystatechange', function(){
if (document.readyState=='complete') ready();
});
}
// Show/hide mobile menu
function toggleNav(){
const nav = document.querySelector('.js-main-nav');
const auxNav = document.querySelector('.js-aux-nav');
const navTrigger = document.querySelector('.js-main-nav-trigger');
const search = document.querySelector('.js-search');
function initNav() {
jtd.addEvent(document, 'click', function(e){
var target = e.target;
while (target && !(target.classList && target.classList.contains('nav-list-expander'))) {
target = target.parentNode;
}
if (target) {
e.preventDefault();
target.parentNode.classList.toggle('active');
}
});
addEvent(navTrigger, 'click', function(){
var text = navTrigger.innerText;
var textToggle = navTrigger.getAttribute('data-text-toggle');
const siteNav = document.getElementById('site-nav');
const mainHeader = document.getElementById('main-header');
const menuButton = document.getElementById('menu-button');
nav.classList.toggle('nav-open');
auxNav.classList.toggle('nav-open');
navTrigger.classList.toggle('nav-open');
search.classList.toggle('nav-open');
navTrigger.innerText = textToggle;
navTrigger.setAttribute('data-text-toggle', text);
textToggle = text;
})
jtd.addEvent(menuButton, 'click', function(e){
e.preventDefault();
if (menuButton.classList.toggle('nav-open')) {
siteNav.classList.add('nav-open');
mainHeader.classList.add('nav-open');
} else {
siteNav.classList.remove('nav-open');
mainHeader.classList.remove('nav-open');
}
});
{%- if site.search_enabled != false and site.search.button %}
const searchInput = document.getElementById('search-input');
const searchButton = document.getElementById('search-button');
jtd.addEvent(searchButton, 'click', function(e){
e.preventDefault();
mainHeader.classList.add('nav-open');
searchInput.focus();
});
{%- endif %}
}
{%- if site.search_enabled != false %}
// Site search
function initSearch() {
var index = lunr(function () {
this.ref('id');
this.field('title', { boost: 20 });
this.field('content', { boost: 10 });
this.field('url');
});
// Get the generated search_data.json file so lunr.js can search it locally.
sc = document.getElementsByTagName("script");
source = '';
for(idx = 0; idx < sc.length; idx++)
{
s = sc.item(idx);
if(s.src && s.src.match(/just-the-docs\.js$/))
{ source = s.src; }
}
jsPath = source.replace('just-the-docs.js', '');
jsonPath = jsPath + '/search-data.json';
var request = new XMLHttpRequest();
request.open('GET', jsonPath, true);
request.open('GET', '{{ "assets/js/search-data.json" | absolute_url }}', true);
request.onload = function() {
request.onload = function(){
if (request.status >= 200 && request.status < 400) {
// Success!
var data = JSON.parse(request.responseText);
var keys = Object.keys(data);
var docs = JSON.parse(request.responseText);
for(var i in data) {
index.add({
id: data[i].id,
title: data[i].title,
content: data[i].content,
url: data[i].url
lunr.tokenizer.separator = {{ site.search.tokenizer_separator | default: site.search_tokenizer_separator | default: "/[\s\-/]+/" }}
var index = lunr(function(){
this.ref('id');
this.field('title', { boost: 200 });
this.field('content', { boost: 2 });
{%- if site.search.rel_url != false %}
this.field('relUrl');
{%- endif %}
this.metadataWhitelist = ['position']
for (var i in docs) {
this.add({
id: i,
title: docs[i].title,
content: docs[i].content,
{%- if site.search.rel_url != false %}
relUrl: docs[i].relUrl
{%- endif %}
});
}
searchResults(data);
});
searchLoaded(index, docs);
} else {
// We reached our target server, but it returned an error
console.log('Error loading ajax request. Request status:' + request.status);
}
};
request.onerror = function() {
// There was a connection error of some sort
request.onerror = function(){
console.log('There was a connection error');
};
request.send();
function searchResults(dataStore) {
var searchInput = document.querySelector('.js-search-input');
var searchResults = document.querySelector('.js-search-results');
var store = dataStore;
function hideResults() {
searchResults.innerHTML = '';
searchResults.classList.remove('active');
}
addEvent(searchInput, 'keyup', function(e){
var query = this.value;
searchResults.innerHTML = '';
searchResults.classList.remove('active');
if (query === '') {
hideResults();
} else {
var results = index.search(query);
if (results.length > 1) {
searchResults.classList.add('active');
var resultsList = document.createElement('ul');
searchResults.appendChild(resultsList);
for (var i in results) {
var resultsListItem = document.createElement('li');
var resultsLink = document.createElement('a');
var resultsUrlDesc = document.createElement('span');
var resultsUrl = store[results[i].ref].url;
var resultsRelUrl = store[results[i].ref].relUrl;
var resultsTitle = store[results[i].ref].title;
resultsLink.setAttribute('href', resultsUrl);
resultsLink.innerText = resultsTitle;
resultsUrlDesc.innerText = resultsRelUrl;
resultsList.classList.add('search-results-list');
resultsListItem.classList.add('search-results-list-item');
resultsLink.classList.add('search-results-link');
resultsUrlDesc.classList.add('fs-2','text-grey-dk-000','d-block');
resultsList.appendChild(resultsListItem);
resultsListItem.appendChild(resultsLink);
resultsLink.appendChild(resultsUrlDesc);
}
}
// When esc key is pressed, hide the results and clear the field
if (e.keyCode == 27) {
hideResults();
searchInput.value = '';
}
}
});
addEvent(searchInput, 'blur', function(){
setTimeout(function(){ hideResults() }, 300);
});
}
}
function searchLoaded(index, docs) {
var index = index;
var docs = docs;
var searchInput = document.getElementById('search-input');
var searchResults = document.getElementById('search-results');
var mainHeader = document.getElementById('main-header');
var currentInput;
var currentSearchIndex = 0;
function showSearch() {
document.documentElement.classList.add('search-active');
}
function hideSearch() {
document.documentElement.classList.remove('search-active');
}
function update() {
currentSearchIndex++;
var input = searchInput.value;
if (input === '') {
hideSearch();
} else {
showSearch();
// scroll search input into view, workaround for iOS Safari
window.scroll(0, -1);
setTimeout(function(){ window.scroll(0, 0); }, 0);
}
if (input === currentInput) {
return;
}
currentInput = input;
searchResults.innerHTML = '';
if (input === '') {
return;
}
var results = index.query(function (query) {
var tokens = lunr.tokenizer(input)
query.term(tokens, {
boost: 10
});
query.term(tokens, {
wildcard: lunr.Query.wildcard.TRAILING
});
});
if ((results.length == 0) && (input.length > 2)) {
var tokens = lunr.tokenizer(input).filter(function(token, i) {
return token.str.length < 20;
})
if (tokens.length > 0) {
results = index.query(function (query) {
query.term(tokens, {
editDistance: Math.round(Math.sqrt(input.length / 2 - 1))
});
});
}
}
if (results.length == 0) {
var noResultsDiv = document.createElement('div');
noResultsDiv.classList.add('search-no-result');
noResultsDiv.innerText = 'No results found';
searchResults.appendChild(noResultsDiv);
} else {
var resultsList = document.createElement('ul');
resultsList.classList.add('search-results-list');
searchResults.appendChild(resultsList);
addResults(resultsList, results, 0, 10, 100, currentSearchIndex);
}
function addResults(resultsList, results, start, batchSize, batchMillis, searchIndex) {
if (searchIndex != currentSearchIndex) {
return;
}
for (var i = start; i < (start + batchSize); i++) {
if (i == results.length) {
return;
}
addResult(resultsList, results[i]);
}
setTimeout(function() {
addResults(resultsList, results, start + batchSize, batchSize, batchMillis, searchIndex);
}, batchMillis);
}
function addResult(resultsList, result) {
var doc = docs[result.ref];
var resultsListItem = document.createElement('li');
resultsListItem.classList.add('search-results-list-item');
resultsList.appendChild(resultsListItem);
var resultLink = document.createElement('a');
resultLink.classList.add('search-result');
resultLink.setAttribute('href', doc.url);
resultsListItem.appendChild(resultLink);
var resultTitle = document.createElement('div');
resultTitle.classList.add('search-result-title');
resultLink.appendChild(resultTitle);
var resultDoc = document.createElement('div');
resultDoc.classList.add('search-result-doc');
resultDoc.innerHTML = '<svg viewBox="0 0 24 24" class="search-result-icon"><use xlink:href="#svg-doc"></use></svg>';
resultTitle.appendChild(resultDoc);
var resultDocTitle = document.createElement('div');
resultDocTitle.classList.add('search-result-doc-title');
resultDocTitle.innerHTML = doc.doc;
resultDoc.appendChild(resultDocTitle);
var resultDocOrSection = resultDocTitle;
if (doc.doc != doc.title) {
resultDoc.classList.add('search-result-doc-parent');
var resultSection = document.createElement('div');
resultSection.classList.add('search-result-section');
resultSection.innerHTML = doc.title;
resultTitle.appendChild(resultSection);
resultDocOrSection = resultSection;
}
var metadata = result.matchData.metadata;
var titlePositions = [];
var contentPositions = [];
for (var j in metadata) {
var meta = metadata[j];
if (meta.title) {
var positions = meta.title.position;
for (var k in positions) {
titlePositions.push(positions[k]);
}
}
if (meta.content) {
var positions = meta.content.position;
for (var k in positions) {
var position = positions[k];
var previewStart = position[0];
var previewEnd = position[0] + position[1];
var ellipsesBefore = true;
var ellipsesAfter = true;
for (var k = 0; k < {{ site.search.preview_words_before | default: 5 }}; k++) {
var nextSpace = doc.content.lastIndexOf(' ', previewStart - 2);
var nextDot = doc.content.lastIndexOf('. ', previewStart - 2);
if ((nextDot >= 0) && (nextDot > nextSpace)) {
previewStart = nextDot + 1;
ellipsesBefore = false;
break;
}
if (nextSpace < 0) {
previewStart = 0;
ellipsesBefore = false;
break;
}
previewStart = nextSpace + 1;
}
for (var k = 0; k < {{ site.search.preview_words_after | default: 10 }}; k++) {
var nextSpace = doc.content.indexOf(' ', previewEnd + 1);
var nextDot = doc.content.indexOf('. ', previewEnd + 1);
if ((nextDot >= 0) && (nextDot < nextSpace)) {
previewEnd = nextDot;
ellipsesAfter = false;
break;
}
if (nextSpace < 0) {
previewEnd = doc.content.length;
ellipsesAfter = false;
break;
}
previewEnd = nextSpace;
}
contentPositions.push({
highlight: position,
previewStart: previewStart, previewEnd: previewEnd,
ellipsesBefore: ellipsesBefore, ellipsesAfter: ellipsesAfter
});
}
}
}
if (titlePositions.length > 0) {
titlePositions.sort(function(p1, p2){ return p1[0] - p2[0] });
resultDocOrSection.innerHTML = '';
addHighlightedText(resultDocOrSection, doc.title, 0, doc.title.length, titlePositions);
}
if (contentPositions.length > 0) {
contentPositions.sort(function(p1, p2){ return p1.highlight[0] - p2.highlight[0] });
var contentPosition = contentPositions[0];
var previewPosition = {
highlight: [contentPosition.highlight],
previewStart: contentPosition.previewStart, previewEnd: contentPosition.previewEnd,
ellipsesBefore: contentPosition.ellipsesBefore, ellipsesAfter: contentPosition.ellipsesAfter
};
var previewPositions = [previewPosition];
for (var j = 1; j < contentPositions.length; j++) {
contentPosition = contentPositions[j];
if (previewPosition.previewEnd < contentPosition.previewStart) {
previewPosition = {
highlight: [contentPosition.highlight],
previewStart: contentPosition.previewStart, previewEnd: contentPosition.previewEnd,
ellipsesBefore: contentPosition.ellipsesBefore, ellipsesAfter: contentPosition.ellipsesAfter
}
previewPositions.push(previewPosition);
} else {
previewPosition.highlight.push(contentPosition.highlight);
previewPosition.previewEnd = contentPosition.previewEnd;
previewPosition.ellipsesAfter = contentPosition.ellipsesAfter;
}
}
var resultPreviews = document.createElement('div');
resultPreviews.classList.add('search-result-previews');
resultLink.appendChild(resultPreviews);
var content = doc.content;
for (var j = 0; j < Math.min(previewPositions.length, {{ site.search.previews | default: 3 }}); j++) {
var position = previewPositions[j];
var resultPreview = document.createElement('div');
resultPreview.classList.add('search-result-preview');
resultPreviews.appendChild(resultPreview);
if (position.ellipsesBefore) {
resultPreview.appendChild(document.createTextNode('... '));
}
addHighlightedText(resultPreview, content, position.previewStart, position.previewEnd, position.highlight);
if (position.ellipsesAfter) {
resultPreview.appendChild(document.createTextNode(' ...'));
}
}
}
{%- if site.search.rel_url != false %}
var resultRelUrl = document.createElement('span');
resultRelUrl.classList.add('search-result-rel-url');
resultRelUrl.innerText = doc.relUrl;
resultTitle.appendChild(resultRelUrl);
{%- endif %}
}
function addHighlightedText(parent, text, start, end, positions) {
var index = start;
for (var i in positions) {
var position = positions[i];
var span = document.createElement('span');
span.innerHTML = text.substring(index, position[0]);
parent.appendChild(span);
index = position[0] + position[1];
var highlight = document.createElement('span');
highlight.classList.add('search-result-highlight');
highlight.innerHTML = text.substring(position[0], index);
parent.appendChild(highlight);
}
var span = document.createElement('span');
span.innerHTML = text.substring(index, end);
parent.appendChild(span);
}
}
jtd.addEvent(searchInput, 'focus', function(){
setTimeout(update, 0);
});
jtd.addEvent(searchInput, 'keyup', function(e){
switch (e.keyCode) {
case 27: // When esc key is pressed, hide the results and clear the field
searchInput.value = '';
break;
case 38: // arrow up
case 40: // arrow down
case 13: // enter
e.preventDefault();
return;
}
update();
});
jtd.addEvent(searchInput, 'keydown', function(e){
switch (e.keyCode) {
case 38: // arrow up
e.preventDefault();
var active = document.querySelector('.search-result.active');
if (active) {
active.classList.remove('active');
if (active.parentElement.previousSibling) {
var previous = active.parentElement.previousSibling.querySelector('.search-result');
previous.classList.add('active');
}
}
return;
case 40: // arrow down
e.preventDefault();
var active = document.querySelector('.search-result.active');
if (active) {
if (active.parentElement.nextSibling) {
var next = active.parentElement.nextSibling.querySelector('.search-result');
active.classList.remove('active');
next.classList.add('active');
}
} else {
var next = document.querySelector('.search-result');
if (next) {
next.classList.add('active');
}
}
return;
case 13: // enter
e.preventDefault();
var active = document.querySelector('.search-result.active');
if (active) {
active.click();
} else {
var first = document.querySelector('.search-result');
if (first) {
first.click();
}
}
return;
}
});
jtd.addEvent(document, 'click', function(e){
if (e.target != searchInput) {
hideSearch();
}
});
}
{%- endif %}
// Switch theme
jtd.getTheme = function() {
var cssFileHref = document.querySelector('[rel="stylesheet"]').getAttribute('href');
return cssFileHref.substring(cssFileHref.lastIndexOf('-') + 1, cssFileHref.length - 4);
}
jtd.setTheme = function(theme) {
var cssFile = document.querySelector('[rel="stylesheet"]');
cssFile.setAttribute('href', '{{ "assets/css/just-the-docs-" | absolute_url }}' + theme + '.css');
}
// Document ready
function ready(){
toggleNav();
jtd.onReady(function(){
initNav();
{%- if site.search_enabled != false %}
initSearch();
}
// in case the document is already rendered
if (document.readyState!='loading') ready();
// modern browsers
else if (document.addEventListener) document.addEventListener('DOMContentLoaded', ready);
// IE <= 8
else document.attachEvent('onreadystatechange', function(){
if (document.readyState=='complete') ready();
{%- endif %}
});
})(window.jtd = window.jtd || {});
{% include js/custom.js %}

View File

@@ -1,12 +0,0 @@
---
---
{
{% for page in site.html_pages %}"{{ forloop.index0 }}": {
"id": "{{ forloop.index0 }}",
"title": "{{ page.title | xml_escape }}",
"content": "{{ page.content | markdownify | strip_html | xml_escape | remove: 'Table of contents' | strip_newlines | replace: '\', ' ' }}",
"url": "{{ page.url | absolute_url | xml_escape }}",
"relUrl": "{{ page.url | xml_escape }}"
}{% if forloop.last %}{% else %},
{% endif %}{% endfor %}
}

File diff suppressed because one or more lines are too long

View File

@@ -0,0 +1,72 @@
---
permalink: /assets/js/search-data.json
---
{
{%- assign i = 0 -%}
{%- assign pages_array = '' | split: '' -%}
{%- assign pages_array = pages_array | push: site.html_pages -%}
{%- if site.just_the_docs.collections -%}
{%- for collection_entry in site.just_the_docs.collections -%}
{%- assign collection_key = collection_entry[0] -%}
{%- assign collection_value = collection_entry[1] -%}
{%- assign collection = site[collection_key] -%}
{%- if collection_value.search_exclude != true -%}
{%- assign pages_array = pages_array | push: collection -%}
{%- endif -%}
{%- endfor -%}
{%- endif -%}
{%- for pages in pages_array -%}
{%- for page in pages -%}
{%- if page.title and page.search_exclude != true -%}
{%- assign page_content = page.content -%}
{%- assign heading_level = site.search.heading_level | default: 2 -%}
{%- for j in (2..heading_level) -%}
{%- assign tag = '<h' | append: j -%}
{%- assign closing_tag = '</h' | append: j -%}
{%- assign page_content = page_content | replace: tag, '<h1' | replace: closing_tag, '</h1' -%}
{%- endfor -%}
{%- assign parts = page_content | split: '<h1' -%}
{%- assign title_found = false -%}
{%- for part in parts offset: 1 -%}
{%- assign titleAndContent = part | split: '</h1>' -%}
{%- assign title = titleAndContent[0] | replace_first: '>', '<h1>' | split: '<h1>' -%}
{%- assign title = title[1] | strip_html -%}
{%- assign content = titleAndContent[1] -%}
{%- assign url = page.url -%}
{%- if title == page.title and parts[0] == '' -%}
{%- assign title_found = true -%}
{%- else -%}
{%- assign id = titleAndContent[0] -%}
{%- assign id = id | split: 'id="' -%}
{%- if id.size == 2 -%}
{%- assign id = id[1] -%}
{%- assign id = id | split: '"' -%}
{%- assign id = id[0] -%}
{%- capture url -%}{{ url | append: '#' | append: id }}{%- endcapture -%}
{%- endif -%}
{%- endif -%}
{%- unless i == 0 -%},{%- endunless -%}
"{{ i }}": {
"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 }}",
"relUrl": "{{ url }}"
}
{%- assign i = i | plus: 1 -%}
{%- endfor -%}
{%- unless title_found -%}
{%- unless i == 0 -%},{%- endunless -%}
"{{ i }}": {
"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 }}",
"relUrl": "{{ page.url }}"
}
{%- assign i = i | plus: 1 -%}
{%- endunless -%}
{%- endif -%}
{%- endfor -%}
{%- endfor %}
}

View File

@@ -1,7 +1,7 @@
#!/usr/bin/env ruby
gem_dir = File.expand_path("..",File.dirname(__FILE__))
$LOAD_PATH.unshift gem_dir# Look in gem directory for resources first.
$LOAD_PATH.unshift gem_dir # Look in gem directory for resources first.
exec_type = ARGV[0]
if exec_type == 'rake' then

14
docker-compose.yml Normal file
View File

@@ -0,0 +1,14 @@
version: "3.5"
services:
jekyll:
build:
context: ./
ports:
- 4000:4000
volumes:
- .:/usr/src/app
stdin_open: true
tty: true
command: bundle exec jekyll serve -H 0.0.0.0 -t

198
docs/configuration.md Normal file
View File

@@ -0,0 +1,198 @@
---
layout: default
title: Configuration
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.
{: .fs-6 .fw-300 }
## Table of contents
{: .no_toc .text-delta }
1. TOC
{:toc}
---
View this site's [_config.yml](https://github.com/pmarsceill/just-the-docs/tree/master/_config.yml) file as an example.
## Site logo
```yaml
# Set a path/url to a logo that will be displayed instead of the title
logo: "/assets/images/just-the-docs.png"
```
## Search
```yaml
# Enable or disable the site search
# Supports true (default) or false
search_enabled: true
search:
# Split pages into sections that can be searched individually
# Supports 1 - 6, default: 2
heading_level: 2
# Maximum amount of previews per search result
# Default: 3
previews: 3
# Maximum amount of words to display before a matched word in the preview
# Default: 5
preview_words_before: 5
# Maximum amount of words to display after a matched word in the preview
# Default: 10
preview_words_after: 10
# Set the search token separator
# Default: /[\s\-/]+/
# Example: enable support for hyphenated search words
tokenizer_separator: /[\s/]+/
# Display the relative url in search results
# Supports true (default) or false
rel_url: true
# Enable or disable the search button that appears in the bottom right corner of every page
# Supports true or false (default)
button: false
```
## Aux links
```yaml
# Aux links for the upper right navigation
aux_links:
"Just the Docs on GitHub":
- "//github.com/pmarsceill/just-the-docs"
# Makes Aux links open in a new tab. Default is false
aux_links_new_tab: false
```
## Heading anchor links
```yaml
# Heading anchor links appear on hover over h1-h6 tags in page content
# allowing users to deep link to a particular heading on a page.
#
# Supports true (default) or false
heading_anchors: true
```
## Footer content
```yaml
# Footer content
# 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 &copy; 2017-2020 Patrick Marsceill. Distributed by an <a href=\"https://github.com/pmarsceill/just-the-docs/tree/master/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
last_edit_time_format: "%b %e %Y at %I:%M %p" # uses ruby's time format: https://ruby-doc.org/stdlib-2.7.0/libdoc/time/rdoc/Time.html
# 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_source: docs # the source that your files originate from
gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately
```
_note: `footer_content` is deprecated, but still supported. For a better experience we have moved this into an include called `_includes/footer_custom.html` which will allow for robust markup / liquid-based content._
- the "page last modified" data will only display if a page has a key called `last_modified_date`, formatted in some readable date format
- `last_edit_time_format` uses Ruby's DateTime formatter; see examples and more information [at this link.](https://apidock.com/ruby/DateTime/strftime)
- `gh_edit_repository` is the URL of the project's GitHub repository
- `gh_edit_branch` is the branch that the docs site is served from; defaults to `master`
- `gh_edit_source` is the source directory that your project files are stored in (should be the same as [site.source](https://jekyllrb.com/docs/configuration/options/))
- `gh_edit_view_mode` is `"tree"` by default, which brings the user to the github page; switch to `"edit"` to bring the user directly into editing mode
## Color scheme
```yaml
# Color scheme supports "light" (default) and "dark"
color_scheme: dark
```
<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>
See [Customization]({{ site.baseurl }}{% link docs/customization.md %}) for more information.
## Google Analytics
```yaml
# Google Analytics Tracking (optional)
# e.g, UA-1234567-89
ga_tracking: UA-5555555-55
ga_tracking_anonymize_ip: true # Use GDPR compliant Google Analytics settings (true by default)
```
## Document collections
By default, the navigation and search include normal [pages](https://jekyllrb.com/docs/pages/).
Instead, you can also use [Jekyll collections](https://jekyllrb.com/docs/collections/) which group documents semantically together.
For example, put all your documentation files in the `_docs` folder and create the `docs` collection:
```yaml
# Define Jekyll collections
collections:
# Define a collection named "docs", its documents reside in the "_docs" directory
docs:
permalink: "/:collection/:path/"
output: true
just_the_docs:
# Define which collections are used in just-the-docs
collections:
# Reference the "docs" collection
docs:
# Give the collection a name
name: Documentation
# Exclude the collection from the navigation
# Supports true or false (default)
nav_exclude: false
# Exclude the collection from the search
# Supports true or false (default)
search_exclude: false
```
You can reference multiple collections.
This creates categories in the navigation with the configured names.
```yaml
collections:
docs:
permalink: "/:collection/:path/"
output: true
tutorials:
permalink: "/:collection/:path/"
output: true
just_the_docs:
collections:
docs:
name: Documentation
tutorials:
name: Tutorials
```

View File

@@ -1,11 +1,11 @@
---
layout: default
title: Customization
nav_order: 5
nav_order: 6
---
# Customization
{:.no_toc}
{: .no_toc }
## Table of contents
{: .no_toc .text-delta }
@@ -15,30 +15,101 @@ nav_order: 5
---
## Visual customization
## Color schemes
{: .d-inline-block }
To customize your sites aesthetic, open `_sass/custom/custom.scss` in your editor to see if there is a variable that you can override. Most styles like fonts, colors, spacing, etc.. are derived from these variables. To override a specific variable, uncomment out its line and change its value.
New
{: .label .label-green }
For example, to change the link color from the purple default to blue, open `_sass/custom/custom.css` and find the link color variable on line `44`. Uncomment it out, and change it's value to our `$blue-000` variable, or another shade of your choosing.
Just the Docs supports two color schemes: light (default), and dark.
To enable a color scheme, set the `color_scheme` parameter in your site's `_config.yml` file:
#### Example
{: .no_toc }
```yaml
# Color scheme supports "light" (default) and "dark"
color_scheme: dark
```
<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>
## Custom schemes
### 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)
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.
For example, to change the link color from the purple default to blue, include the following inside your scheme file:
#### Example
{: .no_toc }
```scss
// ...
//
// $body-text-color: $grey-dk-100;
// $body-heading-color: $grey-dk-300;
$link-color: $blue-000;
//
// ...
```
_Note:_ Editing the variables directly in `_sass/support/variables.scss` is not recommended and can cause other dependancies to fail.
_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
## Themes
{: .d-inline-block :}
To use the custom color scheme, only set the `color_scheme` parameter in your site's `_config.yml` file:
```yaml
color_scheme: foo
```
Coming soon
{: .label .label-yellow :}
### Switchable custom scheme
Hard at work on a dark theme, and more.
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:`
{% raw %}
---
---
{% include css/just-the-docs.scss.liquid color_scheme="foo" %}
{% endraw %}
This allows you to switch the scheme via the following javascript.
```js
jtd.setTheme('foo');
```
## Override and completely custom styles
For styles that aren't defined as variables, you may want to modify specific CSS classes.
Additionally, you may want to add completely custom CSS specific to your content.
To do this, put your styles in the file `_sass/custom/custom.scss`.
This will allow for all overrides to be kept in a single file, and for any upstream changes to still be applied.
For example, if you'd like to add your own styles for printing a page, you could add the following styles.
#### Example
{: .no_toc }
```scss
// Print-only styles.
@media print {
.side-bar, .page-header { display: none; }
.main-content { max-width: auto; margin: 1em;}
}
```

View File

@@ -39,7 +39,7 @@ GitHubPages::Dependencies.gems.each do |gem, version|
end
```
#### [](#header-4)Header 4
#### [](#header-4)Header 4 `with code not transformed`
* This is an unordered list following a header.
* This is an unordered list following a header.
@@ -94,6 +94,30 @@ end
- level 2 item
- level 1 item
### Nesting an ol in ul in an ol
- level 1 item (ul)
1. level 2 item (ol)
1. level 2 item (ol)
- level 3 item (ul)
- level 3 item (ul)
- level 1 item (ul)
1. level 2 item (ol)
1. level 2 item (ol)
- level 3 item (ul)
- level 3 item (ul)
1. level 4 item (ol)
1. level 4 item (ol)
- level 3 item (ul)
- level 3 item (ul)
- level 1 item (ul)
### And a task list
- [ ] Hello, this is a TODO item
- [ ] Hello, this is another TODO item
- [x] Goodbye, this item is done
### Small image
![](https://assets-cdn.github.com/images/icons/emoji/octocat.png)
@@ -116,6 +140,37 @@ end
<dd>Green</dd>
</dl>
#### Multiple description terms and values
Term
: Brief description of Term
Longer Term
: Longer description of Term,
possibly more than one line
Term
: First description of Term,
possibly more than one line
: Second description of Term,
possibly more than one line
Term1
Term2
: Single description of Term1 and Term2,
possibly more than one line
Term1
Term2
: First description of Term1 and Term2,
possibly more than one line
: Second description of Term1 and Term2,
possibly more than one line
### More code
```
Long, single-line code blocks should not wrap. They should horizontally scroll if they are too long. This line should be long enough to demonstrate this.
```

View File

@@ -1,31 +1,37 @@
---
layout: default
title: Navigation Structure
nav_order: 4
nav_order: 5
---
# Navigation Structure
{: .no_toc }
## Table of contents
{: .no_toc .text-delta }
<details open markdown="block">
<summary>
Table of contents
</summary>
{: .text-delta }
1. TOC
{:toc}
</details>
---
## Main navigation
The main navigation for your Just the Docs site is on the left side of the page at large screens and on the top (behind a tap) on small screens. The main navigation can be structured to accommodate a multi-level menu system (parent pages with children).
The main navigation for your Just the Docs site is on the left side of the page at large screens and on the top (behind a tap) on small screens. The main navigation can be structured to accommodate a multi-level menu system (pages with children and grandchildren).
### Top level pages
By default, all pages will appear as top level pages in the main nav unless a parent page is defined (see [Pages with Children](#pages-with-children)).
By default, all pages will appear as top level pages in the main nav.
---
### Ordering pages
## Ordering pages
To specify a page order, use the `nav_order` variable in your pages' YAML front matter.
To specify a page order, you can use the `nav_order` parameter in your pages' YAML front matter.
#### Example
{: .no_toc }
```yaml
---
@@ -35,9 +41,40 @@ nav_order: 4
---
```
### Pages with children
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.
Sometimes you will want to create a page with many children (a section). To accomplish this you need to a few things. First, it is recommended that you keep pages that are related in a directory together... For example, in these docs, we keep all of the written documentation in the `./docs` directory and each of the sections in subdirectories like `./docs/ui-components` and `./docs/utilities`. This gives is an organization like:
The parameter values can be numbers (integers, floats) and/or strings. When you omit `nav_order` parameters, they default to the titles of the pages, which are ordered alphabetically. Pages with numerical `nav_order` parameters always come before those with strings or default `nav_order` parameters. If you want to make the page order independent of the page titles, you can set explicit `nav_order` parameters on all pages.
By default, all Capital letters come before all lowercase letters; you can add `nav_sort: case_insensitive` in the configuration file to ignore the case. Enclosing strings in quotation marks is optional.
> *Note for users of previous versions:* `nav_sort: case_insensitive` previously affected the ordering of numerical `nav_order` parameters: e.g., `10` came before `2`. Also, all pages with explicit `nav_order` parameters previously came before all pages with default parameters. Both were potentially confusing, and they have now been eliminated.
---
## Excluding pages
For specific pages that you do not wish to include in the main navigation, e.g. a 404 page or a landing page, use the `nav_exclude: true` parameter in the YAML front matter for that page.
#### Example
{: .no_toc }
```yaml
---
layout: default
title: 404
nav_exclude: true
---
```
The `nav_exclude` parameter does not affect the [auto-generating list of child pages](#auto-generating-table-of-contents), which you can use to access pages excluded from the main navigation.
Pages with no `title` are automatically excluded from the navigation.
---
## Pages with children
Sometimes you will want to create a page with many children (a section). First, it is recommended that you keep pages that are related in a directory together... For example, in these docs, we keep all of the written documentation in the `./docs` directory and each of the sections in subdirectories like `./docs/ui-components` and `./docs/utilities`. This gives us an organization like:
```
+-- ..
@@ -45,7 +82,7 @@ Sometimes you will want to create a page with many children (a section). To acco
|
|-- docs
| |-- ui-components
| | |-- ui-components.md (parent page)
| | |-- index.md (parent page)
| | |-- buttons.md
| | |-- code.md
| | |-- labels.md
@@ -53,7 +90,7 @@ Sometimes you will want to create a page with many children (a section). To acco
| | +-- typography.md
| |
| |-- utilities
| | |-- utilities.md (parent page)
| | |-- index.md (parent page)
| | |-- color.md
| | |-- layout.md
| | |-- responsive-modifiers.md
@@ -66,51 +103,127 @@ Sometimes you will want to create a page with many children (a section). To acco
+-- ..
```
On the parent pages, add 3 YAML front matter variables:
- `has_children: true` (tells us that this a parent page)
- `parent: ` set this to the title of the parent page (in this case, it's this page's title)
- `permalink: ` set this to the directory that the contains the pages
On the parent pages, add this YAML front matter parameter:
- `has_children: true` (tells us that this is a parent page)
#### Example
{: .no_toc }
```yaml
---
layout: default
title: UI Components
nav_order: 2
has_children: true
parent: UI Components
permalink: /ui-components
---
```
Here we're setting up the UI Components landing page that is available at `/ui-components`, has children and is ordered second in the main nav.
Here we're setting up the UI Components landing page that is available at `/docs/ui-components`, which has children and is ordered second in the main nav.
### Child pages
{: .text-gamma }
On child pages, simply set the `parent:` YAML front matter to whatever the parent's page title is and set a nav order (this number is now scoped within the section).
#### Example
{: .no_toc }
```yaml
---
layout: default
title: Buttons
parent: UI Components
nav_order: 2
---
```
The Buttons page appears a child of UI Components and appears second in the UI Components section.
The Buttons page appears as a child of UI Components and appears second in the UI Components section.
### 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.
#### Example
{: .no_toc }
```yaml
---
layout: default
title: UI Components
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.
1. Add the `has_children` attribute to the child
1. Add the `parent` and `grand_parent` attribute to the grandchild
#### Example
{: .no_toc }
```yaml
---
layout: default
title: Buttons
parent: UI Components
nav_order: 2
has_children: true
---
```
```yaml
---
layout: default
title: Buttons Child Page
parent: Buttons
grand_parent: UI Components
nav_order: 1
---
```
This would create the following navigation structure:
```
+-- ..
|
|-- UI Components
| |-- ..
| |
| |-- Buttons
| | |-- Button Child Page
| |
| |-- ..
|
+-- ..
```
---
## Breadcrumbs
## Auxiliary Links
Breadcrumbs are auto generated based on the parent/child structure and the directory structure for the site. In order for breadcrumbs to work correctly for pages children, the URL structure must be the slugified version of the parent page's title. For example, the page UI Components, must use the `/ui-components` directory to house its descendant pages.
To add auxiliary links to your site (in the upper right on all pages), add it to the `aux_links` [configuration option]({{ site.baseurl }}{% link docs/configuration.md %}#aux-links) in your site's `_config.yml` file.
#### Example
{: .no_toc }
```yaml
# Aux links for the upper right navigation
aux_links:
"Just the Docs on GitHub":
- "//github.com/pmarsceill/just-the-docs"
```
---
## In-page navigation with Table of Contents
To generate a Table of Contents on your docs pages, you can use the `{:toc}` method from Kramdown, immediately after an `<ol>` in markdown. This will automatically generate an ordered list of anchor links to various sections of page based on headings and heading levels. There may be occasions where you're using a heading and you don't want it to show up in the TOC, to skip a particular heading use the `{: .no_toc }` CSS class.
To generate a Table of Contents on your docs pages, you can use the `{:toc}` method from Kramdown, immediately after an `<ol>` in Markdown. This will automatically generate an ordered list of anchor links to various sections of the page based on headings and heading levels. There may be occasions where you're using a heading and you don't want it to show up in the TOC, so to skip a particular heading use the `{: .no_toc }` CSS class.
#### Example
{: .no_toc }
@@ -126,4 +239,21 @@ 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.
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
The Table of Contents can be made collapsible using the `<details>` and `<summary>` elements , as in the following example. The attribute `open` (expands the Table of Contents by default) and the styling with `{: .text-delta }` are optional.
```markdown
<details open markdown="block">
<summary>
Table of contents
</summary>
{: .text-delta }
1. TOC
{:toc}
</details>
```
The result is shown at [the top of this page](#navigation-structure) (`{:toc}` can be used only once on each page).

View File

@@ -1,42 +1,127 @@
---
layout: default
title: Search
nav_order: 6
nav_order: 7
---
# Search
{: .no_toc }
Just the docs uses [lunr.js](http://lunrjs.com) to add a client-side search interface powered by a JSON index that Jekyll generates. All search results are shown in an auto-complete style interface (there is no search results page). By default, all generated html pages are indexed using the following data points:
## Table of contents
{: .no_toc .text-delta }
1. TOC
{:toc}
---
Just the Docs uses [lunr.js](http://lunrjs.com) to add a client-side search interface powered by a JSON index that Jekyll generates.
All search results are shown in an auto-complete style interface (there is no search results page).
By default, all generated HTML pages are indexed using the following data points:
- Page title
- Page content
- Page URL
## Setup search
## Enable search in configuration
Before you can use search, you must initialize the feature by running this
rake command that comes with the `just-the-docs`
In your site's `_config.yml`, enable search:
```yaml
# Enable or disable the site search
# Supports true (default) or false
search_enabled: true
```
### Search granularity
Pages are split into sections that can be searched individually.
The sections are defined by the headings on the page.
Each section is displayed in a separate search result.
```yaml
# Split pages into sections that can be searched individually
# Supports 1 - 6, default: 2
search.heading_level: 2
```
### Search previews
A search result can contain previews that show where the search words are found in the specific section.
```yaml
# Maximum amount of previews per search result
# Default: 3
search.previews: 3
# Maximum amount of words to display before a matched word in the preview
# Default: 5
search.preview_words_before: 5
# Maximum amount of words to display after a matched word in the preview
# Default: 10
search.preview_words_after: 10
```
### Search tokenizer
The default is for hyphens to separate tokens in search terms:
`gem-based` is equivalent to `gem based`, matching either word.
To allow search for hyphenated words:
```yaml
# Set the search token separator
# Default: /[\s\-/]+/
# Example: enable support for hyphenated search words
search.tokenizer_separator: /[\s/]+/
```
### Display URL in search results
```yaml
# Display the relative url in search results
# Supports true (default) or false
search.rel_url: false
```
### Display search button
The search button displays in the bottom right corner of the screen and triggers the search input when clicked.
```yaml
# Enable or disable the search button that appears in the bottom right corner of every page
# Supports true or false (default)
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
---
layout: default
title: Page not found
nav_exclude: true
search_exclude: true
---
```
## Generate search index when used as a gem
If you use Just the Docs as a remote theme, you do not need the following steps.
If you use the theme as a gem, you must initialize the search by running this `rake` command that comes with `just-the-docs`:
```bash
$ bundle exec just-the-docs rake search:init
```
This command creates the `search-data.json` file that Jekyll uses to create
your search index. Alternatively, you can create the file manually in the
`assets/js/` of your Jekyll site with this content:
```{% raw %}
---
---
{
{% for page in site.html_pages %}"{{ forloop.index0 }}": {
"id": "{{ forloop.index0 }}",
"title": "{{ page.title | xml_escape }}",
"content": "{{ page.content | markdownify | strip_html | xml_escape | remove: 'Table of contents' | remove: page.title | strip_newlines | replace: '\', ' '}}",
"url": "{{ page.url | xml_escape }}"
}{% if forloop.last %}{% else %},
{% endif %}{% endfor %}
}{% endraw %}
```
_Note: If you don't run this rake command or create this file manually, search will not work (or it will use the search index data from this docs site, not your site's content)._
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).

22
docs/tests/index.md Normal file
View File

@@ -0,0 +1,22 @@
---
layout: default
title: Tests
has_children: true
nav_order: 100
---
# Tests
The main documentation pages of this theme illustrate the use of many of its features, which to some extent tests their implementation. The pages linked below provide further test cases for particular features, and may be useful for regression testing when developing new features.
The default configuration does not include the test pages. To include them, *commment-out* the following line in `_config.yml`:
```yaml
, "docs/tests/"
```
so that it is:
```yaml
# , "docs/tests/"
```
(Apparently Jekyll's `include` does *not* override `exclude` for the same folder...)

View File

@@ -0,0 +1,14 @@
---
layout: default
title: Tests for disambiguation A
has_children: true
---
# A
A top-level page
```yaml
title: Tests for disambiguation A
has_children: true
```

View File

@@ -0,0 +1,14 @@
---
layout: default
title: Tests for disambiguation B
has_children: true
---
# B
A top-level page
```yaml
title: Tests for disambiguation B
has_children: true
```

View File

@@ -0,0 +1,16 @@
---
layout: default
title: Tests for disambiguation C
parent: Tests for disambiguation A
has_children: true
---
# C
A child of page A, and parent of page D
```yaml
title: Tests for disambiguation C
parent: Tests for disambiguation A
has_children: true
```

View File

@@ -0,0 +1,16 @@
---
layout: default
title: Tests for disambiguation C
parent: Tests for disambiguation B
has_children: true
---
# C
A child of page B, and parent of page D
```yaml
title: Tests for disambiguation C
parent: Tests for disambiguation B
has_children: true
```

View File

@@ -0,0 +1,16 @@
---
layout: default
title: Tests for disambiguation D
parent: Tests for disambiguation C
grand_parent: Tests for disambiguation A
---
# D
A grandchild of page A
```yaml
title: Tests for disambiguation D
parent: Tests for disambiguation C
grand_parent: Tests for disambiguation A
```

View File

@@ -0,0 +1,16 @@
---
layout: default
title: Tests for disambiguation D
parent: Tests for disambiguation C
grand_parent: Tests for disambiguation B
---
# D
A grandchild of page B
```yaml
title: Tests for disambiguation D
parent: Tests for disambiguation C
grand_parent: Tests for disambiguation B
```

View File

@@ -0,0 +1,14 @@
---
layout: default
title: Disambiguation
parent: Navigation
grand_parent: Tests
---
# Disambiguation
When different pages with children have the same title, referencing the relevant grandparent in the children disambiguates which page is intended.
- [Page A](a/) has a child [page with title C](ca/), and a grandchild [page with title D](dca/).
- [Page B](b/) has a child [page with title C](cb/), and a grandchild [page with title D](dcb/).
- The grandchild pages specify their parent and grandparent pages, so there is no ambiguity.

View File

@@ -0,0 +1,13 @@
---
layout: default
title: Tests for exclusion 0
has_children: true
nav_exclude: true
---
# Tests for exclusion 0
```yaml
title: Tests for exclusion 0
has_children: true
nav_exclude: true
```

View File

@@ -0,0 +1,15 @@
---
layout: default
title: Tests for exclusion 00
parent: Tests for exclusion 0
has_children: true
nav_exclude: true
---
# Tests for exclusion 00
```yaml
title: Tests for exclusion 00
parent: Tests for exclusion 0
has_children: true
nav_exclude: true
```

View File

@@ -0,0 +1,17 @@
---
layout: default
title: Tests for exclusion 000
parent: Tests for exclusion 00
grand_parent: Tests for exclusion 0
has_children: false
nav_exclude: true
---
# Tests for exclusion 000
```yaml
title: Tests for exclusion 000
parent: Tests for exclusion 00
grand_parent: Tests for exclusion 0
has_children: false
nav_exclude: true
```

View File

@@ -0,0 +1,17 @@
---
layout: default
title: Tests for exclusion 001
parent: Tests for exclusion 00
grand_parent: Tests for exclusion 0
has_children: false
nav_exclude: false
---
# Tests for exclusion 001
```yaml
title: Tests for exclusion 001
parent: Tests for exclusion 00
grand_parent: Tests for exclusion 0
has_children: false
nav_exclude: false
```

View File

@@ -0,0 +1,15 @@
---
layout: default
title: Tests for exclusion 01
parent: Tests for exclusion 0
has_children: true
nav_exclude: false
---
# Tests for exclusion 01
```yaml
title: Tests for exclusion 01
parent: Tests for exclusion 0
has_children: true
nav_exclude: false
```

View File

@@ -0,0 +1,17 @@
---
layout: default
title: Tests for exclusion 010
parent: Tests for exclusion 01
grand_parent: Tests for exclusion 0
has_children: false
nav_exclude: true
---
# Tests for exclusion 010
```yaml
title: Tests for exclusion 010
parent: Tests for exclusion 01
grand_parent: Tests for exclusion 0
has_children: false
nav_exclude: true
```

View File

@@ -0,0 +1,17 @@
---
layout: default
title: Tests for exclusion 011
parent: Tests for exclusion 01
grand_parent: Tests for exclusion 0
has_children: false
nav_exclude: false
---
# Tests for exclusion 011
```yaml
title: Tests for exclusion 011
parent: Tests for exclusion 01
grand_parent: Tests for exclusion 0
has_children: false
nav_exclude: false
```

View File

@@ -0,0 +1,13 @@
---
layout: default
title: Tests for exclusion 1
has_children: true
nav_exclude: false
---
# Tests for exclusion 1
```yaml
title: Tests for exclusion 1
has_children: true
nav_exclude: false
```

View File

@@ -0,0 +1,15 @@
---
layout: default
title: Tests for exclusion 10
parent: Tests for exclusion 1
has_children: true
nav_exclude: true
---
# Tests for exclusion 10
```yaml
title: Tests for exclusion 10
parent: Tests for exclusion 1
has_children: true
nav_exclude: true
```

View File

@@ -0,0 +1,17 @@
---
layout: default
title: Tests for exclusion 100
parent: Tests for exclusion 10
grand_parent: Tests for exclusion 1
has_children: false
nav_exclude: true
---
# Tests for exclusion 100
```yaml
title: Tests for exclusion 100
parent: Tests for exclusion 10
grand_parent: Tests for exclusion 1
has_children: false
nav_exclude: true
```

View File

@@ -0,0 +1,17 @@
---
layout: default
title: Tests for exclusion 101
parent: Tests for exclusion 10
grand_parent: Tests for exclusion 1
has_children: false
nav_exclude: false
---
# Tests for exclusion 101
```yaml
title: Tests for exclusion 101
parent: Tests for exclusion 10
grand_parent: Tests for exclusion 1
has_children: false
nav_exclude: false
```

View File

@@ -0,0 +1,15 @@
---
layout: default
title: Tests for exclusion 11
parent: Tests for exclusion 1
has_children: true
nav_exclude: false
---
# Tests for exclusion 11
```yaml
title: Tests for exclusion 11
parent: Tests for exclusion 1
has_children: true
nav_exclude: false
```

View File

@@ -0,0 +1,17 @@
---
layout: default
title: Tests for exclusion 110
parent: Tests for exclusion 11
grand_parent: Tests for exclusion 1
has_children: false
nav_exclude: true
---
# Tests for exclusion 110
```yaml
title: Tests for exclusion 110
parent: Tests for exclusion 11
grand_parent: Tests for exclusion 1
has_children: false
nav_exclude: true
```

View File

@@ -0,0 +1,17 @@
---
layout: default
title: Tests for exclusion 111
parent: Tests for exclusion 11
grand_parent: Tests for exclusion 1
has_children: false
nav_exclude: false
---
# Tests for exclusion 111
```yaml
title: Tests for exclusion 111
parent: Tests for exclusion 11
grand_parent: Tests for exclusion 1
has_children: false
nav_exclude: false
```

View File

@@ -0,0 +1,11 @@
---
layout: default
nav_exclude: true
---
# Tests for exclusion untitled and excluded
This page does not have a `title`, and it is explicitly excluded from the navigation
```yaml
nav_exclude: true
```

View File

@@ -0,0 +1,36 @@
---
layout: default
title: Exclusion
parent: Navigation
grand_parent: Tests
---
# Exclusion
Pages excluded from the main navigation can have parents and children. Navigation to and between excluded pages can be supported by the auto-generating list of child pages inserted at the bottom of each page, and by links to parents in the breadcrumbs at the top of each page.
The following tests cover all combinations of excluded and included pages for the top level, child pages, and grandchild pages. The last binary digit in a page title indicates whether the page is included (1) or excluded (0); preceding digits refer to its parent and grandparent.
## Included in main navigation
- [Tests for exclusion 1](1/)
- [Tests for exclusion 11](11/)
- [Tests for exclusion 111](111/)
## Included only in child navigation
- [Tests for exclusion 110](110/)
- [Tests for exclusion 10](10/)
- [Tests for exclusion 101](101/)
- [Tests for exclusion 100](100/)
- [Tests for exclusion 01](01/)
- [Tests for exclusion 011](011/)
- [Tests for exclusion 010](010/)
- [Tests for exclusion 00](00/)
- [Tests for exclusion 001](001/)
- [Tests for exclusion 000](000/)
## Not included in main or child navigation
- [Tests for exclusion 0](0/)
- ["Untitled"](untitled/)

View File

@@ -0,0 +1,6 @@
---
layout: default
---
# Tests for exclusion untitled
This page does not have a `title`, and it is excluded from the navigation -- unless it is located in a Jekyll collection (which provides default titles). To exclude a title-less page from the navigation, regardless of whether it is located in a collection, set `nav_exclude: true`.

View File

@@ -0,0 +1,8 @@
---
layout: default
title: Navigation
parent: Tests
has_children: true
---
# Navigation

View File

@@ -0,0 +1,14 @@
---
layout: default
title: "10"
parent: Default
grand_parent: Tests for order
---
# 10
```yaml
title: "10"
parent: Default
grand_parent: Tests for order
```

View File

@@ -0,0 +1,14 @@
---
layout: default
title: "2"
parent: Default
grand_parent: Tests for order
---
# 2
```yaml
title: "2"
parent: Default
grand_parent: Tests for order
```

View File

@@ -0,0 +1,14 @@
---
layout: default
title: A
parent: Default
grand_parent: Tests for order
---
# A
```yaml
title: A
parent: Default
grand_parent: Tests for order
```

Some files were not shown because too many files have changed in this diff Show More