Compare commits

...

173 Commits

Author SHA1 Message Date
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
Paul DeBruicker
87a59ef8ef make font-sizes sass variables so they can be changed 2020-06-26 11:35:58 -07: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
Henrique Vianna
7cfc63e138 Fix native font stack precedence issue on Windows systems. 2020-06-01 14:35:15 -03: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
PLanCompS
d00aadeee7 Update .gitignore
Added `.jekyll-cache`
2020-04-27 16:28:30 +02:00
PLanCompS
0a81a86447 Merge remote-tracking branch 'upstream/master' 2020-04-25 09:21:00 +02: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
101 changed files with 2643 additions and 1147 deletions

View File

@@ -1,3 +1,6 @@
references:
- v+
- master
name-template: 'v$RESOLVED_VERSION 🌈' name-template: 'v$RESOLVED_VERSION 🌈'
tag-template: 'v$RESOLVED_VERSION' tag-template: 'v$RESOLVED_VERSION'
categories: categories:

View File

@@ -1,6 +1,6 @@
--- ---
layout: default layout: default
title: Page not found title: 404
permalink: /404 permalink: /404
nav_exclude: true nav_exclude: true
search_exclude: true search_exclude: true

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

@@ -33,6 +33,10 @@ Or install it yourself as:
$ gem install just-the-docs $ gem install just-the-docs
Alternatively, you can run it inside Docker while developing your site
$ docker-compose up
## Usage ## Usage
[View the documentation](https://pmarsceill.github.io/just-the-docs/) for usage information. [View the documentation](https://pmarsceill.github.io/just-the-docs/) for usage information.

View File

@@ -19,7 +19,15 @@ baseurl: "/just-the-docs" # the subpath of your site, e.g. /blog
url: "https://pmarsceill.github.io" # the base hostname & protocol for your site, e.g. http://example.com url: "https://pmarsceill.github.io" # the base hostname & protocol for your site, e.g. http://example.com
permalink: pretty permalink: pretty
exclude: ["node_modules/", "*.gemspec", "*.gem", "Gemfile", "Gemfile.lock", "package.json", "package-lock.json", "script/", "LICENSE.txt", "lib/", "bin/", "README.md", "Rakefile"] exclude: ["node_modules/", "*.gemspec", "*.gem", "Gemfile", "Gemfile.lock", "package.json", "package-lock.json", "script/", "LICENSE.txt", "lib/", "bin/", "README.md", "Rakefile"
, "docs/tests/"
]
# Regression tests
# By default, the pages in /docs/tests are excluded when the ste is built.
# To include them, comment-out the relevant line above.
# Uncommenting the following line doesn't work - see https://github.com/jekyll/jekyll/issues/4791
# include: ["docs/tests/"]
# Set a path/url to a logo that will be displayed instead of the title # Set a path/url to a logo that will be displayed instead of the title
#logo: "/assets/images/just-the-docs.png" #logo: "/assets/images/just-the-docs.png"
@@ -33,13 +41,13 @@ search:
heading_level: 2 heading_level: 2
# Maximum amount of previews per search result # Maximum amount of previews per search result
# Default: 3 # Default: 3
previews: 3 previews: 2
# Maximum amount of words to display before a matched word in the preview # Maximum amount of words to display before a matched word in the preview
# Default: 5 # Default: 5
preview_words_before: 5 preview_words_before: 3
# Maximum amount of words to display after a matched word in the preview # Maximum amount of words to display after a matched word in the preview
# Default: 10 # Default: 10
preview_words_after: 10 preview_words_after: 3
# Set the search token separator # Set the search token separator
# Default: /[\s\-/]+/ # Default: /[\s\-/]+/
# Example: enable support for hyphenated search words # Example: enable support for hyphenated search words
@@ -63,8 +71,8 @@ aux_links:
aux_links_new_tab: false aux_links_new_tab: false
# Sort order for navigation links # Sort order for navigation links
nav_sort: case_insensitive # default, equivalent to nil # nav_sort: case_insensitive # default, equivalent to nil
# nav_sort: case_sensitive # Capital letters sorted before lowercase nav_sort: case_sensitive # Capital letters sorted before lowercase
# Footer content # Footer content
# appears at the bottom of every page's main content # appears at the bottom of every page's main content
@@ -86,6 +94,7 @@ gh_edit_link: true # show or hide edit this page link
gh_edit_link_text: "Edit this page on GitHub" 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_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_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 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 currently only supports "dark", "light"/nil (default), or a custom scheme that you define
@@ -99,6 +108,11 @@ ga_tracking_anonymize_ip: true # Use GDPR compliant Google Analytics settings (t
plugins: plugins:
- jekyll-seo-tag - jekyll-seo-tag
kramdown:
syntax_highlighter_opts:
block:
line_numbers: false
compress_html: compress_html:
clippings: all clippings: all
comments: all comments: all
@@ -106,3 +120,5 @@ compress_html:
startings: [] startings: []
blanklines: false blanklines: false
profile: false profile: false
# ignore:
# envs: all

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

@@ -10,9 +10,9 @@
{% endif %} {% endif %}
{% endunless %} {% endunless %}
<link rel="shortcut icon" href="{{ 'favicon.ico' | absolute_url }}" type="image/x-icon"> <link rel="shortcut icon" href="{{ 'favicon.ico' | relative_url }}" type="image/x-icon">
<link rel="stylesheet" href="{{ '/assets/css/just-the-docs-default.css' | absolute_url }}"> <link rel="stylesheet" href="{{ '/assets/css/just-the-docs-default.css' | relative_url }}">
{% if site.ga_tracking != nil %} {% if site.ga_tracking != nil %}
<script async src="https://www.googletagmanager.com/gtag/js?id={{ site.ga_tracking }}"></script> <script async src="https://www.googletagmanager.com/gtag/js?id={{ site.ga_tracking }}"></script>
@@ -27,9 +27,9 @@
{% endif %} {% endif %}
{% if site.search_enabled != false %} {% if site.search_enabled != false %}
<script type="text/javascript" src="{{ '/assets/js/vendor/lunr.min.js' | absolute_url }}"></script> <script type="text/javascript" src="{{ '/assets/js/vendor/lunr.min.js' | relative_url }}"></script>
{% endif %} {% endif %}
<script type="text/javascript" src="{{ '/assets/js/just-the-docs.js' | absolute_url }}"></script> <script type="text/javascript" src="{{ '/assets/js/just-the-docs.js' | relative_url }}"></script>
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">

View File

View File

@@ -1,55 +1,99 @@
<ul class="nav-list"> <ul class="nav-list">
{%- assign ordered_pages_list = site.html_pages | where_exp:"item", "item.nav_order != nil" -%} {%- assign titled_pages = include.pages
{%- assign unordered_pages_list = site.html_pages | where_exp:"item", "item.nav_order == nil" -%} | 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' -%} {%- if site.nav_sort == 'case_insensitive' -%}
{%- assign sorted_ordered_pages_list = ordered_pages_list | sort_natural:"nav_order" -%} {%- assign sorted_string_ordered_groups = string_ordered_groups | sort_natural:"name" -%}
{%- assign sorted_unordered_pages_list = unordered_pages_list | sort_natural:"title" -%}
{%- else -%} {%- else -%}
{%- assign sorted_ordered_pages_list = ordered_pages_list | sort:"nav_order" -%} {%- assign sorted_string_ordered_groups = string_ordered_groups | sort:"name" -%}
{%- assign sorted_unordered_pages_list = unordered_pages_list | sort:"title" -%}
{%- endif -%} {%- endif -%}
{%- assign pages_list = sorted_ordered_pages_list | concat: sorted_unordered_pages_list -%} {%- assign sorted_string_ordered_pages = "" | split:"X" -%}
{%- for group in sorted_string_ordered_groups -%}
{%- assign sorted_string_ordered_pages = sorted_string_ordered_pages | concat: group.items -%}
{%- endfor -%}
{%- assign pages_list = sorted_number_ordered_pages | concat: sorted_string_ordered_pages -%}
{%- for node in pages_list -%} {%- for node in pages_list -%}
{%- unless node.nav_exclude -%} {%- if node.parent == nil -%}
{%- if node.parent == nil and node.title -%} {%- unless node.nav_exclude -%}
<li class="nav-list-item{% if page.url == node.url or page.parent == node.title or page.grand_parent == node.title %} active{% endif %}"> <li class="nav-list-item{% if page.url == node.url or page.parent == node.title or page.grand_parent == node.title %} active{% endif %}">
{%- if page.parent == node.title or page.grand_parent == node.title -%} {%- if node.has_children -%}
{%- assign first_level_url = node.url | absolute_url -%} <a href="#" class="nav-list-expander"><svg viewBox="0 0 24 24"><use xlink:href="#svg-arrow-right"></use></svg></a>
{%- endif -%} {%- endif -%}
{%- if node.has_children -%} <a href="{{ node.url | absolute_url }}" class="nav-list-link{% if page.url == node.url %} active{% endif %}">{{ node.title }}</a>
<a href="#" class="nav-list-expander"><svg viewBox="0 0 24 24"><use xlink:href="#svg-arrow-right"></use></svg></a> {%- if node.has_children -%}
{%- endif -%} {%- assign children_list = pages_list | where: "parent", node.title -%}
<a href="{{ node.url | absolute_url }}" class="nav-list-link{% if page.url == node.url %} active{% endif %}">{{ node.title }}</a> <ul class="nav-list ">
{%- if node.has_children -%} {%- for child in children_list -%}
{%- assign children_list = pages_list | where: "parent", node.title -%} {%- unless child.nav_exclude -%}
<ul class="nav-list "> <li class="nav-list-item {% if page.url == child.url or page.parent == child.title %} active{% endif %}">
{%- for child in children_list -%} {%- if child.has_children -%}
{%- unless child.nav_exclude -%} <a href="#" class="nav-list-expander"><svg viewBox="0 0 24 24"><use xlink:href="#svg-arrow-right"></use></svg></a>
<li class="nav-list-item {% if page.url == child.url or page.parent == child.title %} active{% endif %}"> {%- endif -%}
{%- if page.url == child.url or page.parent == child.title -%} <a href="{{ child.url | absolute_url }}" class="nav-list-link{% if page.url == child.url %} active{% endif %}">{{ child.title }}</a>
{%- assign second_level_url = child.url | absolute_url -%} {%- if child.has_children -%}
{%- endif -%} {%- assign grand_children_list = pages_list | where: "parent", child.title | where: "grand_parent", node.title -%}
{%- if child.has_children -%} <ul class="nav-list">
<a href="#" class="nav-list-expander"><svg viewBox="0 0 24 24"><use xlink:href="#svg-arrow-right"></use></svg></a> {%- for grand_child in grand_children_list -%}
{%- endif -%} {%- unless grand_child.nav_exclude -%}
<a href="{{ child.url | absolute_url }}" class="nav-list-link{% if page.url == child.url %} active{% endif %}">{{ child.title }}</a> <li class="nav-list-item {% if page.url == grand_child.url %} active{% endif %}">
{%- if child.has_children -%} <a href="{{ grand_child.url | absolute_url }}" class="nav-list-link{% if page.url == grand_child.url %} active{% endif %}">{{ grand_child.title }}</a>
{%- assign grand_children_list = pages_list | where: "parent", child.title | where: "grand_parent", node.title -%} </li>
<ul class="nav-list"> {%- endunless -%}
{%- for grand_child in grand_children_list -%} {%- endfor -%}
<li class="nav-list-item {% if page.url == grand_child.url %} active{% endif %}"> </ul>
<a href="{{ grand_child.url | absolute_url }}" class="nav-list-link{% if page.url == grand_child.url %} active{% endif %}">{{ grand_child.title }}</a> {%- endif -%}
</li> </li>
{%- endfor -%} {%- endunless -%}
</ul> {%- endfor -%}
{%- endif -%} </ul>
</li> {%- endif -%}
{%- endunless -%} </li>
{%- endfor -%} {%- endunless -%}
</ul> {%- endif -%}
{%- endif -%}
</li>
{%- endif -%}
{%- endunless -%}
{%- endfor -%} {%- endfor -%}
</ul> </ul>

View File

@@ -1,18 +1,44 @@
{% capture headingsWorkspace %} {% capture headingsWorkspace %}
{% comment %} {% comment %}
Version 1.0.3 Copyright (c) 2018 Vladimir "allejo" Jimenez
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
{% endcomment %}
{% comment %}
Version 1.0.7
https://github.com/allejo/jekyll-anchor-headings https://github.com/allejo/jekyll-anchor-headings
"Be the pull request you wish to see in the world." ~Ben Balter "Be the pull request you wish to see in the world." ~Ben Balter
Usage: Usage:
{% include anchor_headings.html html=content %} {% include anchor_headings.html html=content anchorBody="#" %}
Parameters: Parameters:
* html (string) - the HTML of compiled markdown generated by kramdown in Jekyll * html (string) - the HTML of compiled markdown generated by kramdown in Jekyll
Optional Parameters: Optional Parameters:
* beforeHeading (bool) : false - Set to true if the anchor should be placed _before_ the heading's content * 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 * 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 * 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 * anchorTitle (string) : '' - The `title` attribute that will be used for anchors
@@ -42,17 +68,22 @@
{% assign nextChar = node | replace: '"', '' | strip | slice: 0, 1 %} {% assign nextChar = node | replace: '"', '' | strip | slice: 0, 1 %}
{% assign headerLevel = nextChar | times: 1 %} {% assign headerLevel = nextChar | times: 1 %}
<!-- If the level is cast to 0, it means it's not a h1-h6 tag, so let's try to fix it --> <!-- If the level is cast to 0, it means it's not a h1-h6 tag, so let's see if we need to fix it -->
{% if headerLevel == 0 %} {% if headerLevel == 0 %}
{% if nextChar != '<' and nextChar != '' %} <!-- Split up the node based on closing angle brackets and get the first one. -->
{% assign firstChunk = node | split: '>' | first %}
<!-- If the first chunk does NOT contain a '<', that means we've broken another HTML tag that starts with 'h' -->
{% unless firstChunk contains '<' %}
{% capture node %}<h{{ node }}{% endcapture %} {% capture node %}<h{{ node }}{% endcapture %}
{% endif %} {% endunless %}
{% capture edited_headings %}{{ edited_headings }}{{ node }}{% endcapture %} {% capture edited_headings %}{{ edited_headings }}{{ node }}{% endcapture %}
{% continue %} {% continue %}
{% endif %} {% endif %}
{% assign _workspace = node | split: '</h' %} {% capture _closingTag %}</h{{ headerLevel }}>{% endcapture %}
{% assign _workspace = node | split: _closingTag %}
{% assign _idWorkspace = _workspace[0] | split: 'id="' %} {% assign _idWorkspace = _workspace[0] | split: 'id="' %}
{% assign _idWorkspace = _idWorkspace[1] | split: '"' %} {% assign _idWorkspace = _idWorkspace[1] | split: '"' %}
{% assign html_id = _idWorkspace[0] %} {% assign html_id = _idWorkspace[0] %}
@@ -64,7 +95,7 @@
{% capture anchor %}{% endcapture %} {% capture anchor %}{% endcapture %}
{% if html_id and headerLevel >= minHeader and headerLevel <= maxHeader %} {% if html_id and headerLevel >= minHeader and headerLevel <= maxHeader %}
{% capture anchor %}href="#{{ html_id}}"{% endcapture %} {% capture anchor %}href="#{{ html_id }}"{% endcapture %}
{% if include.anchorClass %} {% if include.anchorClass %}
{% capture anchor %}{{ anchor }} class="{{ include.anchorClass }}"{% endcapture %} {% capture anchor %}{{ anchor }} class="{{ include.anchorClass }}"{% endcapture %}
@@ -74,6 +105,10 @@
{% capture anchor %}{{ anchor }} title="{{ include.anchorTitle | replace: '%heading%', header }}"{% endcapture %} {% capture anchor %}{{ anchor }} title="{{ include.anchorTitle | replace: '%heading%', header }}"{% endcapture %}
{% endif %} {% 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 %} {% 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 --> <!-- In order to prevent adding extra space after a heading, we'll let the 'anchor' value contain it -->
@@ -93,8 +128,17 @@
{{ header }}{{ anchor }} {{ header }}{{ anchor }}
{% endif %} {% endif %}
{{ include.bodySuffix }} {{ include.bodySuffix }}
</h{{ _workspace | last }} </h{{ headerLevel }}>
{% endcapture %} {% 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 %} {% capture edited_headings %}{{ edited_headings }}{{ new_heading }}{% endcapture %}
{% endfor %} {% endfor %}
{% endcapture %}{% assign headingsWorkspace = '' %}{{ edited_headings | strip }} {% endcapture %}{% assign headingsWorkspace = '' %}{{ edited_headings | strip }}

View File

@@ -48,7 +48,22 @@ layout: table_wrappers
</a> </a>
</div> </div>
<nav role="navigation" aria-label="Main" id="site-nav" class="site-nav"> <nav role="navigation" aria-label="Main" id="site-nav" class="site-nav">
{% include nav.html %} {% if site.just_the_docs.collections %}
{% assign collections_size = site.just_the_docs.collections | size %}
{% for collection_entry in site.just_the_docs.collections %}
{% assign collection_key = collection_entry[0] %}
{% assign collection_value = collection_entry[1] %}
{% assign collection = site[collection_key] %}
{% if collection_value.nav_exclude != true %}
{% if collections_size > 1 %}
<div class="nav-category">{{ collection_value.name }}</div>
{% endif %}
{% include nav.html pages=collection %}
{% endif %}
{% endfor %}
{% else %}
{% include nav.html pages=site.html_pages %}
{% endif %}
</nav> </nav>
<footer class="site-footer"> <footer class="site-footer">
This site uses <a href="https://github.com/pmarsceill/just-the-docs">Just the Docs</a>, a documentation theme for Jekyll. This site uses <a href="https://github.com/pmarsceill/just-the-docs">Just the Docs</a>, a documentation theme for Jekyll.
@@ -65,6 +80,7 @@ layout: table_wrappers
<div id="search-results" class="search-results"></div> <div id="search-results" class="search-results"></div>
</div> </div>
{% endif %} {% endif %}
{% include header_custom.html %}
{% if site.aux_links %} {% if site.aux_links %}
<nav aria-label="Auxiliary" class="aux-nav"> <nav aria-label="Auxiliary" class="aux-nav">
<ul class="aux-nav-list"> <ul class="aux-nav-list">
@@ -86,6 +102,21 @@ layout: table_wrappers
<div id="main-content-wrap" class="main-content-wrap"> <div id="main-content-wrap" class="main-content-wrap">
{% unless page.url == "/" %} {% unless page.url == "/" %}
{% if page.parent %} {% 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"> <nav aria-label="Breadcrumb" class="breadcrumb-nav">
<ol class="breadcrumb-nav-list"> <ol class="breadcrumb-nav-list">
{% if page.grand_parent %} {% if page.grand_parent %}
@@ -101,7 +132,7 @@ layout: table_wrappers
{% endunless %} {% endunless %}
<div id="main-content" class="main-content" role="main"> <div id="main-content" class="main-content" role="main">
{% if site.heading_anchors != false %} {% if site.heading_anchors != false %}
{% include vendor/anchor_headings.html html=content beforeHeading="true" anchorBody="<svg viewBox=\"0 0 16 16\" aria-hidden=\"true\"><use xlink:href=\"#svg-link\"></use></svg>" anchorClass="anchor-heading" %} {% include vendor/anchor_headings.html html=content beforeHeading="true" anchorBody="<svg viewBox=\"0 0 16 16\" aria-hidden=\"true\"><use xlink:href=\"#svg-link\"></use></svg>" anchorClass="anchor-heading" anchorAttrs="aria-labelledby=\"%html_id%\"" %}
{% else %} {% else %}
{{ content }} {{ content }}
{% endif %} {% endif %}
@@ -119,15 +150,17 @@ layout: table_wrappers
</ul> </ul>
{% endif %} {% endif %}
{% if site.footer_content != nil or site.last_edit_timestamp or site.gh_edit_link %} {% capture footer_custom %}
{%- include footer_custom.html -%}
{% endcapture %}
{% if footer_custom != "" or site.last_edit_timestamp or site.gh_edit_link %}
<hr> <hr>
<footer> <footer>
{% if site.back_to_top %} {% if site.back_to_top %}
<p><a href="#top" id="back-to-top">{{ site.back_to_top_text }}</a></p> <p><a href="#top" id="back-to-top">{{ site.back_to_top_text }}</a></p>
{% endif %} {% endif %}
{% if site.footer_content != nil %}
<p class="text-small text-grey-dk-000 mb-0">{{ site.footer_content }}</p> {{ footer_custom }}
{% endif %}
{% if site.last_edit_timestamp or site.gh_edit_link %} {% if site.last_edit_timestamp or site.gh_edit_link %}
<div class="d-flex mt-2"> <div class="d-flex mt-2">
@@ -144,7 +177,7 @@ layout: table_wrappers
site.gh_edit_view_mode site.gh_edit_view_mode
%} %}
<p class="text-small text-grey-dk-000 mb-0"> <p class="text-small text-grey-dk-000 mb-0">
<a href="{{ site.gh_edit_repository }}/{{ site.gh_edit_view_mode }}/{{ site.gh_edit_branch }}/{{ page.path }}" id="edit-this-page">{{ site.gh_edit_link_text }}</a> <a href="{{ site.gh_edit_repository }}/{{ site.gh_edit_view_mode }}/{{ site.gh_edit_branch }}{% if site.gh_edit_source %}/{{ site.gh_edit_source }}{% endif %}/{{ page.path }}" id="edit-this-page">{{ site.gh_edit_link_text }}</a>
</p> </p>
{% endif %} {% endif %}
</div> </div>

View File

@@ -11,23 +11,102 @@ code {
border-radius: $border-radius; border-radius: $border-radius;
} }
pre.highlight, // Avoid appearance of dark border around visited code links in Safari
figure.highlight { 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; padding: $sp-3;
margin-top: 0; margin-top: 0;
margin-bottom: 0; margin-bottom: $sp-3;
overflow-x: auto;
background-color: $code-background-color; background-color: $code-background-color;
border-radius: $border-radius; border-radius: $border-radius;
box-shadow: none;
-webkit-overflow-scrolling: touch; -webkit-overflow-scrolling: touch;
div.highlight,
pre.highlight,
code { code {
padding: 0; padding: 0;
margin: 0;
border: 0; border: 0;
} }
} }
.highlighter-rouge { // {% highlight LANG %}...{% endhighlight %},
// {% highlight LANG linenos %}...{% endhighlight %}:
figure.highlight {
padding: $sp-3;
margin-top: 0;
margin-bottom: $sp-3; margin-bottom: $sp-3;
background-color: $code-background-color;
border-radius: $border-radius;
box-shadow: none;
-webkit-overflow-scrolling: touch;
pre,
code {
padding: 0;
margin: 0;
border: 0;
}
}
// ```[LANG]...```, kramdown line_numbers = true,
// {% highlight LANG linenos %}...{% endhighlight %}:
.highlight .table-wrapper {
padding: 0;
margin: 0;
border: 0;
box-shadow: none;
td,
pre {
@include fs-2;
min-width: 0;
padding: 0;
background-color: $code-background-color;
border: 0;
}
td.gl {
padding-right: $sp-3;
}
pre {
margin: 0;
line-height: 2;
}
} }
.highlight .c { .highlight .c {

View File

@@ -109,7 +109,7 @@
dl { dl {
display: grid; display: grid;
grid-template-columns: max-content 1fr; grid-template: auto / 10em 1fr;
} }
dt, dt,
@@ -118,16 +118,50 @@
} }
dt { dt {
grid-column: 1;
font-weight: 500;
text-align: right; text-align: right;
&::after { &::after {
content: ":"; content: ":";
} }
} }
dd { dd {
grid-column: 2;
margin-bottom: 0;
margin-left: 1em; 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 { .anchor-heading {
@@ -165,6 +199,10 @@
} }
} }
summary {
cursor: pointer;
}
h1, h1,
h2, h2,
h3, h3,

View File

@@ -131,6 +131,29 @@
} }
} }
.nav-category {
padding-top: $sp-2;
padding-right: $gutter-spacing-sm;
padding-bottom: $sp-2;
padding-left: $gutter-spacing-sm;
font-weight: 600;
text-align: end;
text-transform: uppercase;
border-bottom: $border $border-color;
@include fs-2;
@include mq(md) {
padding-right: $gutter-spacing;
padding-left: $gutter-spacing;
margin-top: $gutter-spacing-sm;
text-align: start;
&:first-child {
margin-top: 0;
}
}
}
// Aux nav // Aux nav
.aux-nav { .aux-nav {

View File

@@ -284,13 +284,13 @@
background-color: $search-background-color; background-color: $search-background-color;
@include mq(md) { @include mq(md) {
padding-left: #{$sp-4 * 1.25 + $sp-5}; padding-left: 2.3rem;
} }
} }
.search-label { .search-label {
@include mq(md) { @include mq(md) {
padding-left: #{$sp-4 * 1.25}; padding-left: 0.6rem;
} }
} }
@@ -308,6 +308,8 @@
@include mq(md) { @include mq(md) {
.main { .main {
position: fixed; position: fixed;
right: 0;
left: 0;
} }
} }

View File

@@ -2,14 +2,32 @@
// Typography // Typography
// //
$body-font-family: -apple-system, BlinkMacSystemFont, "helvetica neue", $body-font-family: system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI",
helvetica, roboto, noto, "segoe ui", arial, sans-serif !default; Roboto, "Helvetica Neue", Arial, sans-serif !default;
$mono-font-family: "SFMono-Regular", Menlo, Consolas, Monospace !default; $mono-font-family: "SFMono-Regular", Menlo, Consolas, Monospace !default;
$root-font-size: 16px !default; // Base font-size for rems $root-font-size: 16px !default; // Base font-size for rems
$body-line-height: 1.4 !default; $body-line-height: 1.4 !default;
$content-line-height: 1.6 !default; $content-line-height: 1.6 !default;
$body-heading-line-height: 1.25 !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 // Colors
// //

View File

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

View File

@@ -27,6 +27,10 @@ h4,
letter-spacing: 0.1em; letter-spacing: 0.1em;
} }
h4 code {
text-transform: none;
}
h5, h5,
.text-epsilon { .text-epsilon {
@include fs-3; @include fs-3;

View File

@@ -1,78 +1,7 @@
# normalize.scss v0.1.0 # normalize.scss
Normalize.scss is the SCSS version of [normalize.css](http://necolas.github.io/normalize.css), a customisable CSS file that makes browsers render all elements more consistently and in line with modern standards. Normalize.scss is an SCSS copy of [normalize.css](http://necolas.github.io/normalize.css), a customisable CSS file that makes browsers render all elements more consistently and in line with modern standards.
The [normalize.scss fork](https://github.com/guerrero/normalize.scss) of [normalize.css](http://necolas.github.io/normalize.css) was archived in 2014, and has not been updated since v0.1.0.
[View the normalize.css test file](http://necolas.github.io/normalize.css/latest/test.html) [View the normalize.css test file](http://necolas.github.io/normalize.css/latest/test.html)
## Install
* [npm](http://npmjs.org/): `npm install --save normalize.scss`
* [Component(1)](https://github.com/component/component/): `component install guerrero/normalize.scss`
* [Bower](http://bower.io/): `bower install --save normalize.scss`
* Download: Go to [this link](https://raw.githubusercontent.com/guerrero/normalize.scss/master/normalize.scss), press right-click on the page and choose "Save as..."
No other styles should come before Normalize.scss.
It's recommendable to modify `normalize.scss` to suit it to your project
## What does it do?
* Preserves useful defaults, unlike many CSS resets.
* Normalizes styles for a wide range of elements.
* Corrects bugs and common browser inconsistencies.
* Improves usability with subtle improvements.
* Explains what code does using detailed comments.
## Browser support
* Google Chrome (latest)
* Mozilla Firefox (latest)
* Mozilla Firefox 4
* Opera (latest)
* Apple Safari 6+
* Internet Explorer 8+
[Normalize.css v1 provides legacy browser
support](https://github.com/necolas/normalize.css/tree/v1) (IE 6+, Safari 4+),
but is no longer actively developed.
## Extended details
Additional detail and explanation of the esoteric parts of normalize.css.
#### `pre, code, kbd, samp`
The `font-family: monospace, monospace` hack fixes the inheritance and scaling
of font-size for preformated text. The duplication of `monospace` is
intentional. [Source](http://en.wikipedia.org/wiki/User:Davidgothberg/Test59).
#### `sub, sup`
Normally, using `sub` or `sup` affects the line-box height of text in all
browsers. [Source](http://gist.github.com/413930).
#### `svg:not(:root)`
Adding `overflow: hidden` fixes IE9's SVG rendering. Earlier versions of IE
don't support SVG, so we can safely use the `:not()` and `:root` selectors that
modern browsers use in the default UA stylesheets to apply this style. [SVG
Mailing List discussion](http://lists.w3.org/Archives/Public/public-svg-wg/2008JulSep/0339.html)
#### `input[type="search"]`
The search input is not fully stylable by default. In Chrome and Safari on
OSX/iOS you can't control `font`, `padding`, `border`, or `background`. In
Chrome and Safari on Windows you can't control `border` properly. It will apply
`border-width` but will only show a border color (which cannot be controlled)
for the outer 1px of that border. Applying `-webkit-appearance: textfield`
addresses these issues without removing the benefits of search inputs (e.g.
showing past searches).
#### `legend`
Adding `border: 0` corrects an IE 811 bug where `color` (yes, `color`) is not
inherited by `legend`.
## Acknowledgements
Normalize.scss is a project by [Alex Guerrero](https://github.com/guerrero) based on [normalize.css](http://necolas.github.io/normalize.css) from [Nicolas Gallagher](https://github.com/necolas), co-created with [Jonathan Neal](https://github.com/jonathantneal).

View File

@@ -1,135 +1,40 @@
/*! normalize.scss v0.1.0 | MIT License | based on git.io/normalize */ /*! normalize.css v8.0.1 | MIT License | github.com/necolas/normalize.css */
/* Document
========================================================================== */
/** /**
* 1. Set default font family to sans-serif. * 1. Correct the line height in all browsers.
* 2. Prevent iOS text size adjust after orientation change, without disabling * 2. Prevent adjustments of font size after orientation changes in iOS.
* user zoom.
*/ */
html { html {
font-family: sans-serif; /* 1 */ line-height: 1.15; /* 1 */
-ms-text-size-adjust: 100%; /* 2 */
-webkit-text-size-adjust: 100%; /* 2 */ -webkit-text-size-adjust: 100%; /* 2 */
} }
/* Sections
========================================================================== */
/** /**
* Remove default margin. * Remove the margin in all browsers.
*/ */
body { body {
margin: 0; margin: 0;
} }
/* HTML5 display definitions
========================================================================== */
/** /**
* Correct `block` display not defined for any HTML5 element in IE 8/9. * Render the `main` element consistently in IE.
* Correct `block` display not defined for `details` or `summary` in IE 10/11
* and Firefox.
* Correct `block` display not defined for `main` in IE 11.
*/ */
article, main {
aside,
details,
figcaption,
figure,
footer,
header,
hgroup,
main,
menu,
nav,
section,
summary {
display: block; display: block;
} }
/** /**
* 1. Correct `inline-block` display not defined in IE 8/9. * Correct the font size and margin on `h1` elements within `section` and
* 2. Normalize vertical alignment of `progress` in Chrome, Firefox, and Opera. * `article` contexts in Chrome, Firefox, and Safari.
*/
audio,
canvas,
progress,
video {
display: inline-block; /* 1 */
vertical-align: baseline; /* 2 */
}
/**
* Prevent modern browsers from displaying `audio` without controls.
* Remove excess height in iOS 5 devices.
*/
audio:not([controls]) {
display: none;
height: 0;
}
/**
* Address `[hidden]` styling not present in IE 8/9/10.
* Hide the `template` element in IE 8/9/11, Safari, and Firefox < 22.
*/
[hidden],
template {
display: none;
}
/* Links
========================================================================== */
/**
* Remove the gray background color from active links in IE 10.
*/
a {
background-color: transparent;
}
/**
* Improve readability when focused and also mouse hovered in all browsers.
*/
a:active,
a:hover {
outline: 0;
}
/* Text-level semantics
========================================================================== */
/**
* Address styling not present in IE 8/9/10/11, Safari, and Chrome.
*/
abbr[title] {
border-bottom: 1px dotted;
}
/**
* Address style set to `bolder` in Firefox 4+, Safari, and Chrome.
*/
b,
strong {
font-weight: bold;
}
/**
* Address styling not present in Safari and Chrome.
*/
dfn {
font-style: italic;
}
/**
* Address variable `h1` font-size and margin within `section` and `article`
* contexts in Firefox 4+, Safari, and Chrome.
*/ */
h1 { h1 {
@@ -137,17 +42,75 @@ h1 {
margin: 0.67em 0; margin: 0.67em 0;
} }
/* Grouping content
========================================================================== */
/** /**
* Address styling not present in IE 8/9. * 1. Add the correct box sizing in Firefox.
* 2. Show the overflow in Edge and IE.
*/ */
mark { hr {
background: #ff0; box-sizing: content-box; /* 1 */
color: #000; height: 0; /* 1 */
overflow: visible; /* 2 */
} }
/** /**
* Address inconsistent and variable font size in all browsers. * 1. Correct the inheritance and scaling of font size in all browsers.
* 2. Correct the odd `em` font sizing in all browsers.
*/
pre {
font-family: monospace, monospace; /* 1 */
font-size: 1em; /* 2 */
}
/* Text-level semantics
========================================================================== */
/**
* Remove the gray background on active links in IE 10.
*/
a {
background-color: transparent;
}
/**
* 1. Remove the bottom border in Chrome 57-
* 2. Add the correct text decoration in Chrome, Edge, IE, Opera, and Safari.
*/
abbr[title] {
border-bottom: none; /* 1 */
text-decoration: underline; /* 2 */
text-decoration: underline dotted; /* 2 */
}
/**
* Add the correct font weight in Chrome, Edge, and Safari.
*/
b,
strong {
font-weight: bolder;
}
/**
* 1. Correct the inheritance and scaling of font size in all browsers.
* 2. Correct the odd `em` font sizing in all browsers.
*/
code,
kbd,
samp {
font-family: monospace, monospace; /* 1 */
font-size: 1em; /* 2 */
}
/**
* Add the correct font size in all browsers.
*/ */
small { small {
@@ -155,7 +118,8 @@ small {
} }
/** /**
* Prevent `sub` and `sup` affecting `line-height` in all browsers. * Prevent `sub` and `sup` elements from affecting the line height in
* all browsers.
*/ */
sub, sub,
@@ -166,87 +130,31 @@ sup {
vertical-align: baseline; vertical-align: baseline;
} }
sup {
top: -0.5em;
}
sub { sub {
bottom: -0.25em; bottom: -0.25em;
} }
sup {
top: -0.5em;
}
/* Embedded content /* Embedded content
========================================================================== */ ========================================================================== */
/** /**
* Remove border when inside `a` element in IE 8/9/10. * Remove the border on images inside links in IE 10.
*/ */
img { img {
border: 0; border-style: none;
}
/**
* Correct overflow not hidden in IE 9/10/11.
*/
svg:not(:root) {
overflow: hidden;
}
/* Grouping content
========================================================================== */
/**
* Address margin not present in IE 8/9 and Safari.
*/
figure {
margin: 1em 40px;
}
/**
* Address differences between Firefox and other browsers.
*/
hr {
-moz-box-sizing: content-box;
box-sizing: content-box;
height: 0;
}
/**
* Contain overflow in all browsers.
*/
pre {
overflow: auto;
}
/**
* Address odd `em`-unit font size rendering in all browsers.
*/
code,
kbd,
pre,
samp {
font-family: monospace, monospace;
font-size: 1em;
} }
/* Forms /* Forms
========================================================================== */ ========================================================================== */
/** /**
* Known limitation: by default, Chrome and Safari on OS X allow very limited * 1. Change the font styles in all browsers.
* styling of `select`, unless a `border` property is set. * 2. Remove the margin in Firefox and Safari.
*/
/**
* 1. Correct color not being inherited.
* Known issue: affects color of disabled elements.
* 2. Correct font properties not being inherited.
* 3. Address margins set differently in Firefox 4+, Safari, and Chrome.
*/ */
button, button,
@@ -254,146 +162,100 @@ input,
optgroup, optgroup,
select, select,
textarea { textarea {
color: inherit; /* 1 */ font-family: inherit; /* 1 */
font: inherit; /* 2 */ font-size: 100%; /* 1 */
margin: 0; /* 3 */ line-height: 1.15; /* 1 */
margin: 0; /* 2 */
} }
/** /**
* Address `overflow` set to `hidden` in IE 8/9/10/11. * Show the overflow in IE.
* 1. Show the overflow in Edge.
*/ */
button { button,
input { /* 1 */
overflow: visible; overflow: visible;
} }
/** /**
* Address inconsistent `text-transform` inheritance for `button` and `select`. * Remove the inheritance of text transform in Edge, Firefox, and IE.
* All other form control elements do not inherit `text-transform` values. * 1. Remove the inheritance of text transform in Firefox.
* Correct `button` style inheritance in Firefox, IE 8/9/10/11, and Opera.
* Correct `select` style inheritance in Firefox.
*/ */
button, button,
select { select { /* 1 */
text-transform: none; text-transform: none;
} }
/** /**
* 1. Avoid the WebKit bug in Android 4.0.* where (2) destroys native `audio` * Correct the inability to style clickable types in iOS and Safari.
* and `video` controls.
* 2. Correct inability to style clickable `input` types in iOS.
* 3. Improve usability and consistency of cursor style between image-type
* `input` and others.
*/ */
button, button,
html input[type="button"], /* 1 */ [type="button"],
input[type="reset"], [type="reset"],
input[type="submit"] { [type="submit"] {
-webkit-appearance: button; /* 2 */ -webkit-appearance: button;
cursor: pointer; /* 3 */
} }
/** /**
* Re-set default cursor for disabled elements. * Remove the inner border and padding in Firefox.
*/
button[disabled],
html input[disabled] {
cursor: default;
}
/**
* Remove inner padding and border in Firefox 4+.
*/ */
button::-moz-focus-inner, button::-moz-focus-inner,
input::-moz-focus-inner { [type="button"]::-moz-focus-inner,
border: 0; [type="reset"]::-moz-focus-inner,
[type="submit"]::-moz-focus-inner {
border-style: none;
padding: 0; padding: 0;
} }
/** /**
* Address Firefox 4+ setting `line-height` on `input` using `!important` in * Restore the focus styles unset by the previous rule.
* the UA stylesheet.
*/ */
input { button:-moz-focusring,
line-height: normal; [type="button"]:-moz-focusring,
[type="reset"]:-moz-focusring,
[type="submit"]:-moz-focusring {
outline: 1px dotted ButtonText;
} }
/** /**
* It's recommended that you don't attempt to style these elements. * Correct the padding in Firefox.
* Firefox's implementation doesn't respect box-sizing, padding, or width.
*
* 1. Address box sizing set to `content-box` in IE 8/9/10.
* 2. Remove excess padding in IE 8/9/10.
*/
input[type="checkbox"],
input[type="radio"] {
box-sizing: border-box; /* 1 */
padding: 0; /* 2 */
}
/**
* Fix the cursor style for Chrome's increment/decrement buttons. For certain
* `font-size` values of the `input`, it causes the cursor style of the
* decrement button to change from `default` to `text`.
*/
input[type="number"]::-webkit-inner-spin-button,
input[type="number"]::-webkit-outer-spin-button {
height: auto;
}
/**
* 1. Address `appearance` set to `searchfield` in Safari and Chrome.
* 2. Address `box-sizing` set to `border-box` in Safari and Chrome
* (include `-moz` to future-proof).
*/
input[type="search"] {
-webkit-appearance: textfield; /* 1 */
-moz-box-sizing: content-box;
-webkit-box-sizing: content-box; /* 2 */
box-sizing: content-box;
}
/**
* Remove inner padding and search cancel button in Safari and Chrome on OS X.
* Safari (but not Chrome) clips the cancel button when the search input has
* padding (and `textfield` appearance).
*/
input[type="search"]::-webkit-search-cancel-button,
input[type="search"]::-webkit-search-decoration {
-webkit-appearance: none;
}
/**
* Define consistent border, margin, and padding.
*/ */
fieldset { fieldset {
border: 1px solid #c0c0c0; padding: 0.35em 0.75em 0.625em;
margin: 0 2px;
padding: 0.35em 0.625em 0.75em;
} }
/** /**
* 1. Correct `color` not being inherited in IE 8/9/10/11. * 1. Correct the text wrapping in Edge and IE.
* 2. Remove padding so people aren't caught out if they zero out fieldsets. * 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 { legend {
border: 0; /* 1 */ box-sizing: border-box; /* 1 */
padding: 0; /* 2 */ color: inherit; /* 2 */
display: table; /* 1 */
max-width: 100%; /* 1 */
padding: 0; /* 3 */
white-space: normal; /* 1 */
} }
/** /**
* Remove default vertical scrollbar in IE 8/9/10/11. * Add the correct vertical alignment in Chrome, Firefox, and Opera.
*/
progress {
vertical-align: baseline;
}
/**
* Remove the default vertical scrollbar in IE 10+.
*/ */
textarea { textarea {
@@ -401,27 +263,87 @@ textarea {
} }
/** /**
* Don't inherit the `font-weight` (applied by a rule above). * 1. Add the correct box sizing in IE 10.
* NOTE: the default cannot safely be changed in Chrome and Safari on OS X. * 2. Remove the padding in IE 10.
*/ */
optgroup { [type="checkbox"],
font-weight: bold; [type="radio"] {
box-sizing: border-box; /* 1 */
padding: 0; /* 2 */
} }
/* Tables /**
* Correct the cursor style of increment and decrement buttons in Chrome.
*/
[type="number"]::-webkit-inner-spin-button,
[type="number"]::-webkit-outer-spin-button {
height: auto;
}
/**
* 1. Correct the odd appearance in Chrome and Safari.
* 2. Correct the outline style in Safari.
*/
[type="search"] {
-webkit-appearance: textfield; /* 1 */
outline-offset: -2px; /* 2 */
}
/**
* Remove the inner padding in Chrome and Safari on macOS.
*/
[type="search"]::-webkit-search-decoration {
-webkit-appearance: none;
}
/**
* 1. Correct the inability to style clickable types in iOS and Safari.
* 2. Change font properties to `inherit` in Safari.
*/
::-webkit-file-upload-button {
-webkit-appearance: button; /* 1 */
font: inherit; /* 2 */
}
/* Interactive
========================================================================== */
/*
* Add the correct display in Edge, IE 10+, and Firefox.
*/
details {
display: block;
}
/*
* Add the correct display in all browsers.
*/
summary {
display: list-item;
}
/* Misc
========================================================================== */ ========================================================================== */
/** /**
* Remove most spacing between table cells. * Add the correct display in IE 10+.
*/ */
table { template {
border-collapse: collapse; display: none;
border-spacing: 0;
} }
td, /**
th { * Add the correct display in IE 10.
padding: 0; */
[hidden] {
display: none;
} }

View File

@@ -1,70 +0,0 @@
{
"_args": [
[
"normalize.scss",
"/Users/pmarsceill/_projects/just-the-docs"
]
],
"_from": "normalize.scss@*",
"_id": "normalize.scss@0.1.0",
"_inCache": true,
"_installable": true,
"_location": "/normalize.scss",
"_nodeVersion": "0.10.32",
"_npmUser": {
"email": "alexguerrero1092@gmail.com",
"name": "alexguerrero"
},
"_npmVersion": "2.0.2",
"_phantomChildren": {},
"_requested": {
"name": "normalize.scss",
"raw": "normalize.scss",
"rawSpec": "",
"scope": null,
"spec": "*",
"type": "range"
},
"_requiredBy": [
"#DEV:/"
],
"_resolved": "https://registry.npmjs.org/normalize.scss/-/normalize.scss-0.1.0.tgz",
"_shasum": "4a21dc25bd4c019c857785f829b658aba2a8f9ab",
"_shrinkwrap": null,
"_spec": "normalize.scss",
"_where": "/Users/pmarsceill/_projects/just-the-docs",
"author": "",
"bugs": {
"url": "https://github.com/guerrero/normalize.scss/issues"
},
"dependencies": {},
"description": "Normalize.scss as a node packaged module",
"devDependencies": {},
"directories": {},
"dist": {
"shasum": "4a21dc25bd4c019c857785f829b658aba2a8f9ab",
"tarball": "https://registry.npmjs.org/normalize.scss/-/normalize.scss-0.1.0.tgz"
},
"files": [
"normalize.scss"
],
"gitHead": "d67d517e28615a873066438af1d4845c157c9baf",
"homepage": "https://github.com/guerrero/normalize.scss",
"license": "MIT",
"maintainers": [
{
"name": "alexguerrero",
"email": "alexguerrero1092@gmail.com"
}
],
"name": "normalize.scss",
"optionalDependencies": {},
"readme": "ERROR: No README data found!",
"repository": {
"type": "git",
"url": "git://github.com/guerrero/normalize.scss.git"
},
"scripts": {},
"style": "normalize.scss",
"version": "0.1.0"
}

View File

@@ -2,8 +2,21 @@
permalink: /assets/js/search-data.json permalink: /assets/js/search-data.json
--- ---
{ {
{%- assign i = 0 -%} {%- assign i = 0 -%}
{% for page in site.html_pages %} {%- 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 -%} {%- if page.title and page.search_exclude != true -%}
{%- assign page_content = page.content -%} {%- assign page_content = page.content -%}
{%- assign heading_level = site.search.heading_level | default: 2 -%} {%- assign heading_level = site.search.heading_level | default: 2 -%}
@@ -14,7 +27,7 @@ permalink: /assets/js/search-data.json
{%- endfor -%} {%- endfor -%}
{%- assign parts = page_content | split: '<h1' -%} {%- assign parts = page_content | split: '<h1' -%}
{%- assign title_found = false -%} {%- assign title_found = false -%}
{% for part in parts offset: 1 %} {%- for part in parts offset: 1 -%}
{%- assign titleAndContent = part | split: '</h1>' -%} {%- assign titleAndContent = part | split: '</h1>' -%}
{%- assign title = titleAndContent[0] | replace_first: '>', '<h1>' | split: '<h1>' -%} {%- assign title = titleAndContent[0] | replace_first: '>', '<h1>' | split: '<h1>' -%}
{%- assign title = title[1] | strip_html -%} {%- assign title = title[1] | strip_html -%}
@@ -54,5 +67,6 @@ permalink: /assets/js/search-data.json
{%- assign i = i | plus: 1 -%} {%- assign i = i | plus: 1 -%}
{%- endunless -%} {%- endunless -%}
{%- endif -%} {%- endif -%}
{% endfor %} {%- endfor -%}
{%- endfor %}
} }

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

View File

@@ -22,6 +22,7 @@ Just the Docs has some specific configuration parameters that can be defined in
View this site's [_config.yml](https://github.com/pmarsceill/just-the-docs/tree/master/_config.yml) file as an example. View this site's [_config.yml](https://github.com/pmarsceill/just-the-docs/tree/master/_config.yml) file as an example.
## Site logo ## Site logo
```yaml ```yaml
@@ -86,9 +87,11 @@ heading_anchors: true
## Footer content ## Footer content
```yaml ```yaml
# Footer content # Footer content
# appears at the bottom of every page's main content # appears at the bottom of every page's main content
footer_content: "Copyright &copy; 2017-2019 Patrick Marsceill. Distributed by an <a href=\"https://github.com/pmarsceill/just-the-docs/tree/master/LICENSE.txt\">MIT license.</a>" # Note: The footer_content option is deprecated and will be removed in a future major release. Please use `_includes/footer_custom.html` for more robust
markup / liquid-based content.
footer_content: "Copyright &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 # 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_timestamp: true # show or hide edit time - page must have `last_modified_date` defined in the frontmatter
@@ -99,13 +102,17 @@ gh_edit_link: true # show or hide edit this page link
gh_edit_link_text: "Edit this page on GitHub." 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_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_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 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 - 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) - `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_repository` is the URL of the project's GitHub repository
- `gh_edit_branch` is the branch that the docs site is served from; defaults to `master` - `gh_edit_branch` is the branch that the docs site is served from; defaults to `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 - `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 ## Color scheme
@@ -140,3 +147,52 @@ See [Customization]({{ site.baseurl }}{% link docs/customization.md %}) for more
ga_tracking: UA-5555555-55 ga_tracking: UA-5555555-55
ga_tracking_anonymize_ip: true # Use GDPR compliant Google Analytics settings (true by default) 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

@@ -39,7 +39,7 @@ GitHubPages::Dependencies.gems.each do |gem, version|
end 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.
* This is an unordered list following a header. * This is an unordered list following a header.
@@ -140,6 +140,37 @@ end
<dd>Green</dd> <dd>Green</dd>
</dl> </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. 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

@@ -7,11 +7,14 @@ nav_order: 5
# Navigation Structure # Navigation Structure
{: .no_toc } {: .no_toc }
## Table of contents <details open markdown="block">
{: .no_toc .text-delta } <summary>
Table of contents
</summary>
{: .text-delta }
1. TOC 1. TOC
{:toc} {:toc}
</details>
--- ---
@@ -25,7 +28,7 @@ By default, all pages will appear as top level pages in the main nav unless a pa
## Ordering pages ## Ordering pages
To specify a page order, use the `nav_order` parameter in your pages' YAML front matter. To specify a page order, you can use the `nav_order` parameter in your pages' YAML front matter.
#### Example #### Example
{: .no_toc } {: .no_toc }
@@ -38,12 +41,13 @@ nav_order: 4
--- ---
``` ```
The specified `nav_order` parameters on a site should be all integers or all strings. 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.
Pages without a `nav_order` parameter are ordered alphabetically by their `title`,
and appear after the explicitly-ordered pages at each level. 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 are sorted before all lowercase letters;
adding `nav_sort: case_insensitive` in the configuration file ignores case 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.
when sorting strings (but also sorts numbers lexicographically: `10` comes before `1`).
> *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.
--- ---
@@ -62,6 +66,10 @@ 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 ## Pages with children
@@ -231,4 +239,21 @@ To generate a Table of Contents on your docs pages, you can use the `{:toc}` met
{:toc} {:toc}
``` ```
This example skips the page name heading (`#`) from the TOC, as well as the heading for the Table of Contents itself (`##`) because it is redundant, followed by the table of contents itself. 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).

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
```

View File

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

View File

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

View File

@@ -0,0 +1,15 @@
---
layout: default
title: Default
parent: Tests for order
nav_order: 1
has_children: true
---
# Default Order
When `nav_order` fields are omitted, the pages are ordered alphabetically by their titles.
By default, all Capital letters come before all lowercase letters; you can add `nav_sort: case_insensitive` in the configuration file to ignore the case).
Digits precede letters, and numeric titles are ordered lexicographically: `10` precedes `2` (in contrast to explicit numeric `nav_order` values).

View File

@@ -0,0 +1,16 @@
---
layout: default
title: "-1.1"
nav_order: -1.1
parent: Floats
grand_parent: Tests for order
---
# -1.1
```yaml
title: "-1.1"
nav_order: -1.1
parent: Floats
grand_parent: Tests for order
```

View File

@@ -0,0 +1,16 @@
---
layout: default
title: "0.0"
nav_order: 0.0
parent: Floats
grand_parent: Tests for order
---
# 0.0
```yaml
title: "0.0"
nav_order: 0.0
parent: Floats
grand_parent: Tests for order
```

View File

@@ -0,0 +1,16 @@
---
layout: default
title: "10.0"
nav_order: 10.0
parent: Floats
grand_parent: Tests for order
---
# 10.0
```yaml
title: "10.0"
nav_order: 10.0
parent: Floats
grand_parent: Tests for order
```

View File

@@ -0,0 +1,16 @@
---
layout: default
title: "2.2222"
nav_order: 2.2222
parent: Floats
grand_parent: Tests for order
---
# 2.2222
```yaml
title: "2.2222"
nav_order: 2.2222
parent: Floats
grand_parent: Tests for order
```

View File

@@ -0,0 +1,13 @@
---
layout: default
title: Floats
parent: Tests for order
nav_order: 4
has_children: true
---
# Floating-Point Order
When `nav_order` fields are floating-point numbers, the pages are ordered in increasing order of the numerical values.
Floats include `0.0` and negative values.

View File

@@ -0,0 +1,16 @@
---
layout: default
title: Order
parent: Navigation
grand_parent: Tests
---
# Order
The value of `nav_order` can be numbers (integers, floats) and/or strings. The following tests illustrate their effects.
- [Default](default/), using `title` instead of `nav_order` fields.
- [Strings](strings/), lexicographically ordered, possibly case-insensitively.
- [Integers](integers/), numerically ordered.
- [Floats](floats/), numerically ordered.
- [Mixture](mixture/), with numbers before strings.

View File

@@ -0,0 +1,16 @@
---
layout: default
title: "-1"
nav_order: -1
parent: Integers
grand_parent: Tests for order
---
# -1
```yaml
title: "-1"
nav_order: -1
parent: Integers
grand_parent: Tests for order
```

View File

@@ -0,0 +1,16 @@
---
layout: default
title: "0"
nav_order: 0
parent: Integers
grand_parent: Tests for order
---
# 0
```yaml
title: "0"
nav_order: 0
parent: Integers
grand_parent: Tests for order
```

View File

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

View File

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

View File

@@ -0,0 +1,13 @@
---
layout: default
title: Integers
parent: Tests for order
nav_order: 3
has_children: true
---
# Integer Order
When `nav_order` fields are integers, the pages are ordered in increasing order of the numerical values.
Integers include `0` and negative values. Integers can be reused for top-level pages and for different sets of child pages.

View File

@@ -0,0 +1,16 @@
---
layout: default
title: "-1.1"
nav_order: -1.1
parent: Mixture
grand_parent: Tests for order
---
# -1.1
```yaml
title: "-1.1"
nav_order: -1.1
parent: Mixture
grand_parent: Tests for order
```

View File

@@ -0,0 +1,16 @@
---
layout: default
title: "-1"
nav_order: -1
parent: Mixture
grand_parent: Tests for order
---
# -1
```yaml
title: "-1"
nav_order: -1
parent: Mixture
grand_parent: Tests for order
```

View File

@@ -0,0 +1,16 @@
---
layout: default
title: "0.0"
nav_order: 0.0
parent: Mixture
grand_parent: Tests for order
---
# 0.0
```yaml
title: "0.0"
nav_order: 0.0
parent: Mixture
grand_parent: Tests for order
```

View File

@@ -0,0 +1,16 @@
---
layout: default
title: "0"
nav_order: 0
parent: Mixture
grand_parent: Tests for order
---
# 0
```yaml
title: "0"
nav_order: 0
parent: Mixture
grand_parent: Tests for order
```

View File

@@ -0,0 +1,16 @@
---
layout: default
title: "10.0"
nav_order: 10.0
parent: Mixture
grand_parent: Tests for order
---
# 10.0
```yaml
title: "10.0"
nav_order: 10.0
parent: Mixture
grand_parent: Tests for order
```

View File

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

View File

@@ -0,0 +1,16 @@
---
layout: default
title: "2.2222"
nav_order: 2.2222
parent: Mixture
grand_parent: Tests for order
---
# 2.2222
```yaml
title: "2.2222"
nav_order: 2.2222
parent: Mixture
grand_parent: Tests for order
```

View File

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

View File

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

View File

@@ -0,0 +1,16 @@
---
layout: default
title: aa
nav_order: "aa"
parent: Mixture
grand_parent: Tests for order
---
# aa
```yaml
title: aa
nav_order: "aa"
parent: Mixture
grand_parent: Tests for order
```

View File

@@ -0,0 +1,16 @@
---
layout: default
title: Aa
nav_order: "Aa"
parent: Mixture
grand_parent: Tests for order
---
# Aa
```yaml
title: Aa
nav_order: "Aa"
parent: Mixture
grand_parent: Tests for order
```

View File

@@ -0,0 +1,11 @@
---
layout: default
title: Mixture
parent: Tests for order
nav_order: 5
has_children: true
---
# Mixed Order
It seems unlikely that different types of `nav_order` values are needed for the children of the same parent.

View File

@@ -0,0 +1,7 @@
---
layout: default
title: Tests for order
has_children: true
---
# Order

View File

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

View File

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

View File

@@ -0,0 +1,16 @@
---
layout: default
title: A
nav_order: A
parent: Strings
grand_parent: Tests for order
---
# A
```yaml
title: A
nav_order: A
parent: Strings
grand_parent: Tests for order
```

View File

@@ -0,0 +1,16 @@
---
layout: default
title: aa
nav_order: "aa"
parent: Strings
grand_parent: Tests for order
---
# aa
```yaml
title: aa
nav_order: "aa"
parent: Strings
grand_parent: Tests for order
```

View File

@@ -0,0 +1,16 @@
---
layout: default
title: Aa
nav_order: "Aa"
parent: Strings
grand_parent: Tests for order
---
# Aa
```yaml
title: Aa
nav_order: "Aa"
parent: Strings
grand_parent: Tests for order
```

View File

@@ -0,0 +1,13 @@
---
layout: default
title: Strings
parent: Tests for order
nav_order: 2
has_children: true
---
# String Order
By default, all Capital letters come before all lowercase letters; you can add `nav_sort: case_insensitive` in the configuration file to ignore the case).
Digits precede letters, and numeric titles are ordered lexicographically: `"10"` precedes `"2"` (in contrast to explicit numeric `nav_order` values).

83
docs/tests/styling/dl.md Normal file
View File

@@ -0,0 +1,83 @@
---
layout: default
title: Description lists
parent: Styling
grand_parent: Tests
---
# Description lists
The first child element of each `dd` element in a `dl` list should be aligned with the preceding `dt` element in the following examples.
term
: paragraph text
paragraph text
term
: ### Header
paragraph text
term
: > block quote
paragraph text
term
: ```sh
fenced code block
```
paragraph text
term
: + unordered list item
+ unordered list item
paragraph text
term
: 1. ordered list item
2. ordered list item
paragraph text
term
: sub-term
: sub-description
sub-term
: sub-description
paragraph text
term
: |-----------------+------------+-----------------+----------------|
| Default aligned |Left aligned| Center aligned | Right aligned |
|-----------------|:-----------|:---------------:|---------------:|
| First body part |Second cell | Third cell | fourth cell |
| Second line |foo | **strong** | baz |
| Third line |quux | baz | bar |
|-----------------+------------+-----------------+----------------|
| Second body | | | |
| 2 line | | | |
|=================+============+=================+================|
| Footer row | | | |
|-----------------+------------+-----------------+----------------|
paragraph text
term
: ***
paragraph text

View File

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

65
docs/tests/styling/ol.md Normal file
View File

@@ -0,0 +1,65 @@
---
layout: default
title: Ordered lists
parent: Styling
grand_parent: Tests
---
# Ordered lists
The first child element of each `li` element in an `ol` list should be aligned with the preceding label in the following examples.
1. paragraph text
paragraph text
1. ### Header
paragraph text
1. > block quote
paragraph text
1. ```sh
fenced code block
```
paragraph text
1. + unordered list item
+ unordered list item
paragraph text
1. 1. ordered list item
2. ordered list item
paragraph text
1. term
: description
term
: description
paragraph text
1. |-----------------+------------+-----------------+----------------|
| Default aligned |Left aligned| Center aligned | Right aligned |
|-----------------|:-----------|:---------------:|---------------:|
| First body part |Second cell | Third cell | fourth cell |
| Second line |foo | **strong** | baz |
| Third line |quux | baz | bar |
|-----------------+------------+-----------------+----------------|
| Second body | | | |
| 2 line | | | |
|=================+============+=================+================|
| Footer row | | | |
|-----------------+------------+-----------------+----------------|
paragraph text
1. ***
paragraph text

65
docs/tests/styling/ul.md Normal file
View File

@@ -0,0 +1,65 @@
---
layout: default
title: Unordered lists
parent: Styling
grand_parent: Tests
---
# Unordered lists
The first child element of each `li` element in a `ul` list should be aligned with the preceding bullet in the following examples.
- paragraph text
paragraph text
- ### Header
paragraph text
- > block quote
paragraph text
- ```sh
fenced code block
```
paragraph text
- + unordered list item
+ unordered list item
paragraph text
- 1. ordered list item
2. ordered list item
paragraph text
- term
: description
term
: description
paragraph text
- |-----------------+------------+-----------------+----------------|
| Default aligned |Left aligned| Center aligned | Right aligned |
|-----------------|:-----------|:---------------:|---------------:|
| First body part |Second cell | Third cell | fourth cell |
| Second line |foo | **strong** | baz |
| Third line |quux | baz | bar |
|-----------------+------------+-----------------+----------------|
| Second body | | | |
| 2 line | | | |
|=================+============+=================+================|
| Footer row | | | |
|-----------------+------------+-----------------+----------------|
paragraph text
- ***
paragraph text

View File

@@ -2,6 +2,7 @@
layout: default layout: default
title: Code title: Code
parent: UI Components parent: UI Components
has_children: true
nav_order: 6 nav_order: 6
--- ---

View File

@@ -0,0 +1,115 @@
---
layout: default
title: Code with line numbers
parent: Code
grand_parent: UI Components
permalink: /docs/ui-components/code/line-numbers/
---
# Code snippets with line numbers
The default settings for HTML compression are incompatible with the HTML
produced by Jekyll (4.1.1 or earlier) for line numbers from highlighted code
-- both when using Kramdown code fences and when using Liquid highlight tags.
To avoid non-conforming HTML and unsatisfactory layout, HTML compression
can be turned off by using the following configuration option:
{% highlight yaml %}
compress_html:
ignore:
envs: all
{% endhighlight %}
When using Kramdown code fences, line numbers are turned on globally by the
following configuration option:
{% highlight yaml %}
kramdown:
syntax_highlighter_opts:
block:
line_numbers: true
{% endhighlight %}
Line numbers can then be suppressed locally using Liquid tags (_without_ the
`linenos` option) instead of fences:
{% highlight yaml %}
{% raw %}{% highlight some_language %}
Some code
{% endhighlight %}{% endraw %}
{% endhighlight %}
## Workarounds
To use HTML compression together with line numbers, all highlighted code
needs to be wrapped using one of the following workarounds.
(The variable name `some_var` can be changed to avoid clashes; it can also
be replaced by `code` -- but note that `code=code` cannot be removed).
### Code fences (three backticks)
{% highlight default %}
{% raw %}{% capture some_var %}
```some_language
Some code
```
{% endcapture %}
{% assign some_var = some_var | markdownify %}
{% include fix_linenos.html code=some_var %}{% endraw %}
{% endhighlight %}
### Liquid highlighting
{% highlight default %}
{% raw %}{% capture some_var %}
{% highlight some_language linenos %}
Some code
{% endhighlight %}
{% endcapture %}
{% include fix_linenos.html code=some_var %}{% endraw %}
{% endhighlight %}
_Credit:_ The original version of the above workaround was suggested by
Dmitry Hrabrov at
<https://github.com/penibelst/jekyll-compress-html/issues/71#issuecomment-188144901>.
## Examples
✅ Using code fences + workaround (will only show line numbers if enabled globally in `_config.yml`):
{% capture code_fence %}
```js
// Javascript code with syntax highlighting in fences
var fun = function lang(l) {
dateformat.i18n = require('./lang/' + l)
return true;
}
```
{% endcapture %}
{% assign code_fence = code_fence | markdownify %}
{% include fix_linenos.html code=code_fence %}
✅ Using liquid highlighting + workaround:
{% capture code %}
{% highlight ruby linenos %}
# Ruby code with syntax highlighting and fixed line numbers using Liquid
GitHubPages::Dependencies.gems.each do |gem, version|
s.add_dependency(gem, "= #{version}")
end
{% endhighlight %}
{% endcapture %}
{% include fix_linenos.html code=code %}
{% assign code = nil %}
❌ With the default configuration options, the following example illustrates
the **incorrect** formatting arising from the incompatibility of HTML compression
and the non-conforming HTML produced by Jekyll for line numbers:
{% highlight ruby linenos %}
# Ruby code with syntax highlighting and unfixed line numbers using Liquid
GitHubPages::Dependencies.gems.each do |gem, version|
s.add_dependency(gem, "= #{version}")
end
{% endhighlight %}

View File

@@ -21,7 +21,7 @@ nav_order: 1
By default, Just the Docs uses a native system font stack for sans-serif fonts: By default, Just the Docs uses a native system font stack for sans-serif fonts:
```scss ```scss
-apple-system, BlinkMacSystemFont, "helvetica neue", helvetica, roboto, noto, "segoe ui", arial, sans-serif system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue", Arial, sans-serif
``` ```
ABCDEFGHIJKLMNOPQRSTUVWXYZ ABCDEFGHIJKLMNOPQRSTUVWXYZ

View File

@@ -4,7 +4,6 @@ title: Home
nav_order: 1 nav_order: 1
description: "Just the Docs is a responsive Jekyll theme with built-in search that is easily customizable and hosted on GitHub Pages." description: "Just the Docs is a responsive Jekyll theme with built-in search that is easily customizable and hosted on GitHub Pages."
permalink: / permalink: /
last_modified_date: 2020-04-27T17:54:08+0000
--- ---
# Focus on writing good documentation # Focus on writing good documentation

View File

@@ -2,7 +2,7 @@
Gem::Specification.new do |spec| Gem::Specification.new do |spec|
spec.name = "just-the-docs" spec.name = "just-the-docs"
spec.version = "0.3.0" spec.version = "0.3.2"
spec.authors = ["Patrick Marsceill"] spec.authors = ["Patrick Marsceill"]
spec.email = ["patrick.marsceill@gmail.com"] spec.email = ["patrick.marsceill@gmail.com"]

View File

@@ -12,8 +12,21 @@ namespace :search do
permalink: /assets/js/search-data.json permalink: /assets/js/search-data.json
--- ---
{ {
{%- assign i = 0 -%} {%- assign i = 0 -%}
{% for page in site.html_pages %} {%- 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 -%} {%- if page.title and page.search_exclude != true -%}
{%- assign page_content = page.content -%} {%- assign page_content = page.content -%}
{%- assign heading_level = site.search.heading_level | default: 2 -%} {%- assign heading_level = site.search.heading_level | default: 2 -%}
@@ -24,7 +37,7 @@ permalink: /assets/js/search-data.json
{%- endfor -%} {%- endfor -%}
{%- assign parts = page_content | split: \'<h1\' -%} {%- assign parts = page_content | split: \'<h1\' -%}
{%- assign title_found = false -%} {%- assign title_found = false -%}
{% for part in parts offset: 1 %} {%- for part in parts offset: 1 -%}
{%- assign titleAndContent = part | split: \'</h1>\' -%} {%- assign titleAndContent = part | split: \'</h1>\' -%}
{%- assign title = titleAndContent[0] | replace_first: \'>\', \'<h1>\' | split: \'<h1>\' -%} {%- assign title = titleAndContent[0] | replace_first: \'>\', \'<h1>\' | split: \'<h1>\' -%}
{%- assign title = title[1] | strip_html -%} {%- assign title = title[1] | strip_html -%}
@@ -47,7 +60,7 @@ permalink: /assets/js/search-data.json
"doc": {{ page.title | jsonify }}, "doc": {{ page.title | jsonify }},
"title": {{ 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 }}, "content": {{ content | replace: \'</h\', \' . </h\' | replace: \'<hr\', \' . <hr\' | replace: \'</p\', \' . </p\' | replace: \'<ul\', \' . <ul\' | replace: \'</ul\', \' . </ul\' | replace: \'<ol\', \' . <ol\' | replace: \'</ol\', \' . </ol\' | replace: \'</tr\', \' . </tr\' | replace: \'<li\', \' | <li\' | replace: \'</li\', \' | </li\' | replace: \'</td\', \' | </td\' | replace: \'<td\', \' | <td\' | replace: \'</th\', \' | </th\' | replace: \'<th\', \' | <th\' | strip_html | remove: \'Table of contents\' | normalize_whitespace | replace: \'. . .\', \'.\' | replace: \'. .\', \'.\' | replace: \'| |\', \'|\' | append: \' \' | jsonify }},
"url": "{{ url | absolute_url }}", "url": "{{ url | relative_url }}",
"relUrl": "{{ url }}" "relUrl": "{{ url }}"
} }
{%- assign i = i | plus: 1 -%} {%- assign i = i | plus: 1 -%}
@@ -58,13 +71,14 @@ permalink: /assets/js/search-data.json
"doc": {{ page.title | jsonify }}, "doc": {{ page.title | jsonify }},
"title": {{ 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 }}, "content": {{ parts[0] | replace: \'</h\', \' . </h\' | replace: \'<hr\', \' . <hr\' | replace: \'</p\', \' . </p\' | replace: \'<ul\', \' . <ul\' | replace: \'</ul\', \' . </ul\' | replace: \'<ol\', \' . <ol\' | replace: \'</ol\', \' . </ol\' | replace: \'</tr\', \' . </tr\' | replace: \'<li\', \' | <li\' | replace: \'</li\', \' | </li\' | replace: \'</td\', \' | </td\' | replace: \'<td\', \' | <td\' | replace: \'</th\', \' | </th\' | replace: \'<th\', \' | <th\' | strip_html | remove: \'Table of contents\' | normalize_whitespace | replace: \'. . .\', \'.\' | replace: \'. .\', \'.\' | replace: \'| |\', \'|\' | append: \' \' | jsonify }},
"url": "{{ page.url | absolute_url }}", "url": "{{ page.url | relative_url }}",
"relUrl": "{{ page.url }}" "relUrl": "{{ page.url }}"
} }
{%- assign i = i | plus: 1 -%} {%- assign i = i | plus: 1 -%}
{%- endunless -%} {%- endunless -%}
{%- endif -%} {%- endif -%}
{% endfor %} {%- endfor -%}
{%- endfor %}
}' }'
end end
puts 'Done.' puts 'Done.'

1043
package-lock.json generated

File diff suppressed because it is too large Load Diff

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