Commit Graph

793 Commits

Author SHA1 Message Date
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
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
Patrick Marsceill
31b99a2a9b Update release-drafter.yml 2020-07-20 17:32:21 -04:00
Patrick Marsceill
9dd1cde227 Update release-drafter.yml 2020-07-20 17:23:57 -04:00
Patrick Marsceill
46aa1134a8 Update just-the-docs.gemspec v0.3.1-r 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
Patrick Marsceill
654da0a6ef Merge pull request #369 from SgtSilvio/bugfix/css-main-search-active
Fixed css .search-active.main
v0.3.1
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
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
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
972da61cf9 Merge pull request #327 from pmarsceill/dependabot/npm_and_yarn/primer/css-14.4.0
Bump @primer/css from 14.3.0 to 14.4.0
v0.3.0
2020-06-26 16:00:04 -04:00
Patrick Marsceill
ab9fd6453b Merge pull request #343 from pmarsceill/dependabot/npm_and_yarn/stylelint-13.6.1
Bump stylelint from 13.3.3 to 13.6.1
2020-06-26 15:59:44 -04:00
Patrick Marsceill
2ef11e3701 Merge branch 'master' into dependabot/npm_and_yarn/stylelint-13.6.1 2020-06-26 15:54:25 -04:00
Patrick Marsceill
3382a954d2 Merge branch 'master' into dependabot/npm_and_yarn/primer/css-14.4.0 2020-06-26 15:53:11 -04:00
Patrick Marsceill
848b090d06 Merge pull request #349 from pmarsceill/dependabot/npm_and_yarn/stylelint-config-prettier-8.0.2
Bump stylelint-config-prettier from 8.0.1 to 8.0.2
2020-06-26 15:52:28 -04:00
Patrick Marsceill
8700916a93 Update release-drafter.yml 2020-06-26 15:52:02 -04:00
dependabot-preview[bot]
13d01a6561 Bump @primer/css from 14.3.0 to 14.4.0
Bumps [@primer/css](https://github.com/primer/css) from 14.3.0 to 14.4.0.
- [Release notes](https://github.com/primer/css/releases)
- [Changelog](https://github.com/primer/css/blob/master/CHANGELOG.md)
- [Commits](https://github.com/primer/css/compare/v14.3.0...v14.4.0)

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

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-06-26 19:46:07 +00:00
Patrick Marsceill
20222fe0a7 Merge pull request #360 from pmarsceill/bump-version
Bump version numbers
2020-06-26 15:44:30 -04:00
Patrick Marsceill
c4d5f4f6b0 Merge pull request #362 from pmarsceill/pdebruic-print-css
Add print styles
2020-06-26 15:42:08 -04:00
Patrick Marsceill
12536de881 Merge branch 'master' into bump-version 2020-06-26 15:38:51 -04:00
Patrick Marsceill
c895d5ecd9 Remove print from utils 2020-06-26 15:34:26 -04:00
Patrick Marsceill
b8602eb05d Move print to top level (not util) 2020-06-26 15:33:16 -04:00
Patrick Marsceill
8715224655 Add IDs to target print styles 2020-06-26 15:33:03 -04:00
Patrick Marsceill
cba7303660 Merge branch 'master' into print-css 2020-06-26 14:29:36 -04:00
Patrick Marsceill
5def3aee43 Merge pull request #348 from PierrickMartos/master
Remove constraint with jekyll 4.1.0
2020-06-26 14:28:49 -04:00
Patrick Marsceill
53a5feb11b Merge branch 'master' into master 2020-06-26 14:23:28 -04:00
Patrick Marsceill
17c140da35 Update just-the-docs.gemspec 2020-06-26 14:22:29 -04:00
Patrick Marsceill
e29a540a59 Update package.json 2020-06-26 14:20:54 -04:00
Patrick Marsceill
45af827e0a Merge pull request #352 from SgtSilvio/navigation-improvements-and-search-sections
Navigation improvements and search sections
2020-06-26 14:19:37 -04:00
Silvio Giebl
597c534279 Replaced svgs with feathericons.com 2020-06-25 23:48:24 +02:00
Silvio Giebl
3f0b7254a2 Update _config.yml with default values 2020-06-25 23:19:24 +02:00
Silvio Giebl
868bb0e3ac Apply suggestions from code review
Co-authored-by: Patrick Marsceill <pmarsceill@users.noreply.github.com>
2020-06-25 23:11:43 +02:00
Patrick Marsceill
1e73c69700 Merge branch 'master' into dependabot/npm_and_yarn/stylelint-13.6.1 2020-06-25 17:09:50 -04:00
Patrick Marsceill
5ec0044b72 Update just-the-docs.gemspec 2020-06-25 16:28:45 -04:00
Patrick Marsceill
15f9f52a77 Merge branch 'master' into master 2020-06-25 16:28:19 -04:00
Silvio Giebl
f2aa3c9a4d Fixed prettier style 2020-06-25 21:42:41 +02:00
Silvio Giebl
397e4a6933 Merge branch 'master' into navigation-improvements-and-search-sections 2020-06-25 21:16:21 +02:00
Patrick Marsceill
171ff71a2b Update ci.yml 2020-06-25 14:23:27 -04:00
Patrick Marsceill
e4a29e54ec Update release-drafter.yml 2020-06-25 14:17:46 -04:00
Patrick Marsceill
eadd46c6e4 Create release-drafter.yml 2020-06-25 14:16:41 -04:00
Paul DeBruicker
d3c389ccc5 add print css. hides the sidebar, keeps the logo 2020-06-25 07:43:12 -07:00
Patrick Marsceill
16c18c1020 Fix bundle exec in CI 2020-06-23 11:56:15 -04:00