diff --git a/404.html b/404.html index 1e7a37e..5fde966 100644 --- a/404.html +++ b/404.html @@ -1,6 +1,6 @@ --- layout: default -title: Page not found +title: 404 permalink: /404 nav_exclude: true search_exclude: true diff --git a/_config.yml b/_config.yml index aca049e..d2119ef 100644 --- a/_config.yml +++ b/_config.yml @@ -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 permalink: pretty -exclude: ["node_modules/", "*.gemspec", "*.gem", "Gemfile", "Gemfile.lock", "package.json", "package-lock.json", "script/", "LICENSE.txt", "lib/", "bin/", "README.md", "Rakefile"] +exclude: ["node_modules/", "*.gemspec", "*.gem", "Gemfile", "Gemfile.lock", "package.json", "package-lock.json", "script/", "LICENSE.txt", "lib/", "bin/", "README.md", "Rakefile" +, "docs/tests/" +] + +# Regression tests +# By default, the pages in /docs/tests are excluded when the ste is built. +# To include them, comment-out the relevant line above. +# Uncommenting the following line doesn't work - see https://github.com/jekyll/jekyll/issues/4791 +# include: ["docs/tests/"] # Set a path/url to a logo that will be displayed instead of the title #logo: "/assets/images/just-the-docs.png" @@ -63,8 +71,8 @@ aux_links: aux_links_new_tab: false # Sort order for navigation links -nav_sort: case_insensitive # default, equivalent to nil -# nav_sort: case_sensitive # Capital letters sorted before lowercase +# nav_sort: case_insensitive # default, equivalent to nil +nav_sort: case_sensitive # Capital letters sorted before lowercase # Footer content # appears at the bottom of every page's main content diff --git a/_includes/nav.html b/_includes/nav.html index 2eafe51..a70e2b0 100644 --- a/_includes/nav.html +++ b/_includes/nav.html @@ -1,55 +1,100 @@ diff --git a/docs/navigation-structure.md b/docs/navigation-structure.md index d5a7504..bb601d4 100644 --- a/docs/navigation-structure.md +++ b/docs/navigation-structure.md @@ -7,11 +7,14 @@ nav_order: 5 # Navigation Structure {: .no_toc } -## Table of contents -{: .no_toc .text-delta } - +
+ + Table of contents + + {: .text-delta } 1. TOC {:toc} +
--- @@ -25,7 +28,7 @@ By default, all pages will appear as top level pages in the main nav unless a pa ## Ordering pages -To specify a page order, use the `nav_order` parameter in your pages' YAML front matter. +To specify a page order, you can use the `nav_order` parameter in your pages' YAML front matter. #### Example {: .no_toc } @@ -38,12 +41,13 @@ nav_order: 4 --- ``` -The specified `nav_order` parameters on a site should be all integers or all strings. -Pages without a `nav_order` parameter are ordered alphabetically by their `title`, -and appear after the explicitly-ordered pages at each level. -By default, all Capital letters are sorted before all lowercase letters; -adding `nav_sort: case_insensitive` in the configuration file ignores case -when sorting strings (but also sorts numbers lexicographically: `10` comes before `1`). +The parameter values determine the order of the top-level pages, and of child pages with the same parent. You can reuse the same parameter values (e.g., integers starting from 1) for the child pages of different parents. + +The parameter values can be numbers (integers, floats) and/or strings. When you omit `nav_order` parameters, they default to the titles of the pages, which are ordered alphabetically. Pages with numerical `nav_order` parameters always come before those with strings or default `nav_order` parameters. If you want to make the page order independent of the page titles, you can set explicit `nav_order` parameters on all pages. + +By default, all Capital letters come before all lowercase letters; you can add `nav_sort: case_insensitive` in the configuration file to ignore the case. Enclosing strings in quotation marks is optional. + +> *Note for users of previous versions:* `nav_sort: case_insensitive` previously affected the ordering of numerical `nav_order` parameters: e.g., `10` came before `2`. Also, all pages with explicit `nav_order` parameters previously came before all pages with default parameters. Both were potentially confusing, and they have now been eliminated. --- @@ -62,6 +66,8 @@ nav_exclude: true --- ``` +Pages with no `title` are automatically excluded from the navigation. + --- ## Pages with children diff --git a/docs/tests/index.md b/docs/tests/index.md new file mode 100644 index 0000000..27fc4d7 --- /dev/null +++ b/docs/tests/index.md @@ -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...) diff --git a/docs/tests/navigation/exclude/excluded-child.md b/docs/tests/navigation/exclude/excluded-child.md new file mode 100644 index 0000000..b7b4f9a --- /dev/null +++ b/docs/tests/navigation/exclude/excluded-child.md @@ -0,0 +1,15 @@ +--- +layout: default +title: Excluded Child +parent: Not Excluded +nav_exclude: true +--- +# Excluded Child + +This child page is explicitly excluded, and should not appear in the navigation. + +```yaml +title: Excluded Child +parent: Not Excluded +nav_exclude: true +``` diff --git a/docs/tests/navigation/exclude/excluded-grandchild.md b/docs/tests/navigation/exclude/excluded-grandchild.md new file mode 100644 index 0000000..2e3eadf --- /dev/null +++ b/docs/tests/navigation/exclude/excluded-grandchild.md @@ -0,0 +1,17 @@ +--- +layout: default +title: Excluded Grandchild +parent: Non-excluded Child +grand_parent: Non-excluded +nav_exclude: true +--- +# Excluded Grandchild + +This grandchild page is explicitly excluded, and should not appear in the navigation. + +```yaml +title: Excluded Grandchild +parent: Non-excluded Child +grand_parent: Non-excluded +nav_exclude: true +``` diff --git a/docs/tests/navigation/exclude/excluded.md b/docs/tests/navigation/exclude/excluded.md new file mode 100644 index 0000000..50cebd3 --- /dev/null +++ b/docs/tests/navigation/exclude/excluded.md @@ -0,0 +1,15 @@ +--- +layout: default +title: Excluded +has_children: true +nav_exclude: true +--- +# Excluded + +This top-level page is explicitly excluded, and should not appear in the navigation. Any child pages are implicitly excluded. + +```yaml +title: Excluded +has_children: true +nav_exclude: true +``` diff --git a/docs/tests/navigation/exclude/non-excluded-child-of-excluded.md b/docs/tests/navigation/exclude/non-excluded-child-of-excluded.md new file mode 100644 index 0000000..efe478c --- /dev/null +++ b/docs/tests/navigation/exclude/non-excluded-child-of-excluded.md @@ -0,0 +1,15 @@ +--- +layout: default +title: Non-excluded Child of Excluded +parent: Excluded +nav_exclude: false +--- +# Non-excluded Child of Excluded + +This child page is explicitly not excluded, but its parent page is excluded, so it should not appear in the navigation. + +```yaml +title: Non-excluded Child of Excluded +parent: Excluded +nav_exclude: false +``` diff --git a/docs/tests/navigation/exclude/non-excluded-child.md b/docs/tests/navigation/exclude/non-excluded-child.md new file mode 100644 index 0000000..b7ec02d --- /dev/null +++ b/docs/tests/navigation/exclude/non-excluded-child.md @@ -0,0 +1,16 @@ +--- +layout: default +title: Non-excluded Child +parent: Non-excluded +has_children: true +nav_exclude: false +--- +# Non-excluded Child + +This child page is explicitly not excluded, and should appear in the navigation. + +```yaml +title: Non-excluded Child +parent: Non-excluded +nav_exclude: false +``` diff --git a/docs/tests/navigation/exclude/non-excluded-grandchild-of-excluded.md b/docs/tests/navigation/exclude/non-excluded-grandchild-of-excluded.md new file mode 100644 index 0000000..8dc7720 --- /dev/null +++ b/docs/tests/navigation/exclude/non-excluded-grandchild-of-excluded.md @@ -0,0 +1,17 @@ +--- +layout: default +title: Non-excluded Grandchild of Excluded +parent: Non-excluded Child +grand_parent: Excluded +nav_exclude: false +--- +# Non-excluded Grandchild of Excluded + +This grandchild page is explicitly not excluded, and neither is its parent page; but its grandparent page is excluded, so it should not appear in the navigation. + +```yaml +title: Non-excluded Grandchild of Excluded +parent: Non-excluded Child +grand_parent: Excluded +nav_exclude: false +``` diff --git a/docs/tests/navigation/exclude/non-excluded-grandchild.md b/docs/tests/navigation/exclude/non-excluded-grandchild.md new file mode 100644 index 0000000..6fc2dd1 --- /dev/null +++ b/docs/tests/navigation/exclude/non-excluded-grandchild.md @@ -0,0 +1,17 @@ +--- +layout: default +title: Non-excluded Grandchild +parent: Non-excluded Child +grand_parent: Non-excluded +nav_exclude: false +--- +# Non-excluded Grandchild + +This grandchild page is explicitly not excluded, and neither is its parent page nor its grandparent page, so it should appear in the navigation. + +```yaml +title: Non-excluded Grandchild of Excluded +parent: Non-excluded Child +grand_parent: Excluded +nav_exclude: false +``` diff --git a/docs/tests/navigation/exclude/non-excluded.md b/docs/tests/navigation/exclude/non-excluded.md new file mode 100644 index 0000000..849c4f2 --- /dev/null +++ b/docs/tests/navigation/exclude/non-excluded.md @@ -0,0 +1,14 @@ +--- +layout: default +title: Non-excluded +has_children: true +nav_exclude: false +--- +# Non-excluded + +This top-level page is explicitly not excluded, and should appear in the navigation. + +```yaml +title: Non-excluded +nav_exclude: false +``` diff --git a/docs/tests/navigation/exclude/untitled.md b/docs/tests/navigation/exclude/untitled.md new file mode 100644 index 0000000..ff61925 --- /dev/null +++ b/docs/tests/navigation/exclude/untitled.md @@ -0,0 +1,6 @@ +--- +layout: default +--- +# Untitled + +This page has no `title`, and should not appear in the navigation. diff --git a/docs/tests/navigation/grandparent/a.md b/docs/tests/navigation/grandparent/a.md new file mode 100644 index 0000000..23bed50 --- /dev/null +++ b/docs/tests/navigation/grandparent/a.md @@ -0,0 +1,14 @@ +--- +layout: default +title: A +has_children: true +--- + +# A + +A top-level page + +```yaml +title: A +has_children: true +``` diff --git a/docs/tests/navigation/grandparent/b.md b/docs/tests/navigation/grandparent/b.md new file mode 100644 index 0000000..7973bf0 --- /dev/null +++ b/docs/tests/navigation/grandparent/b.md @@ -0,0 +1,14 @@ +--- +layout: default +title: B +has_children: true +--- + +# B + +A top-level page + +```yaml +title: B +has_children: true +``` diff --git a/docs/tests/navigation/grandparent/ca.md b/docs/tests/navigation/grandparent/ca.md new file mode 100644 index 0000000..525428e --- /dev/null +++ b/docs/tests/navigation/grandparent/ca.md @@ -0,0 +1,16 @@ +--- +layout: default +title: C +parent: A +has_children: true +--- + +# C + +A child of page A, and parent of page D + +```yaml +title: C +parent: A +has_children: true +``` diff --git a/docs/tests/navigation/grandparent/cb.md b/docs/tests/navigation/grandparent/cb.md new file mode 100644 index 0000000..1baa41b --- /dev/null +++ b/docs/tests/navigation/grandparent/cb.md @@ -0,0 +1,16 @@ +--- +layout: default +title: C +parent: B +has_children: true +--- + +# C + +A child of page B, and parent of page D + +```yaml +title: C +parent: B +has_children: true +``` diff --git a/docs/tests/navigation/grandparent/dca.md b/docs/tests/navigation/grandparent/dca.md new file mode 100644 index 0000000..5ff7584 --- /dev/null +++ b/docs/tests/navigation/grandparent/dca.md @@ -0,0 +1,16 @@ +--- +layout: default +title: D +parent: C +grand_parent: A +--- + +# D + +A grandchild of page A + +```yaml +title: D +parent: C +grand_parent: A +``` diff --git a/docs/tests/navigation/grandparent/dcb.md b/docs/tests/navigation/grandparent/dcb.md new file mode 100644 index 0000000..567025d --- /dev/null +++ b/docs/tests/navigation/grandparent/dcb.md @@ -0,0 +1,16 @@ +--- +layout: default +title: D +parent: C +grand_parent: B +--- + +# D + +A grandchild of page B + +```yaml +title: D +parent: C +grand_parent: B +``` diff --git a/docs/tests/navigation/index.md b/docs/tests/navigation/index.md new file mode 100644 index 0000000..50587d8 --- /dev/null +++ b/docs/tests/navigation/index.md @@ -0,0 +1,28 @@ +--- +layout: default +title: Navigation +parent: Tests +--- + +# Navigation + +## Parent page disambiguation + +- [Page A](grandparent/a/) has a child [page with title C](grandparent/ca/), and a grandchild [page with title D](grandparent/dca/). +- [Page B](grandparent/b/) has a child [page with title C](grandparent/cb/), and a grandchild [page with title D](grandparent/dcb/). +- The grandchild pages specify their parent and grandparent pages, so there is no ambiguity. + +## Page exclusion + +- An [untitled page](exclude/untitled/) is excluded from the navigation. +- An excluded [top level page](exclude/excluded/), [child page](exclude/excluded-child/), or [grandchild page](exclude/excluded-grandchild/) does not appear. +- A non-excluded [top level page](exclude/non-excluded/) appears; and a non-excluded [child page](exclude/non-excluded-child/) or [grandchild page](exclude/non-excluded-grandchild/) appears if its parent appears. +- A non-excluded child page or grandchild page does not appear if its parent is excluded. + +## Page order + +- [Default](order/default/), using `title` instead of `nav_order` fields. +- [Strings](order/strings/), lexicographically ordered, possibly case-insensitively. +- [Integers](order/integers/), numerically ordered. +- [Floats](order/floats/), numerically ordered. +- [Mixture](order/mixture/), with numbers before strings. diff --git a/docs/tests/navigation/order/default/10.md b/docs/tests/navigation/order/default/10.md new file mode 100644 index 0000000..bd6fbb8 --- /dev/null +++ b/docs/tests/navigation/order/default/10.md @@ -0,0 +1,14 @@ +--- +layout: default +title: "10" +parent: Default +grand_parent: Order +--- + +# 10 + +```yaml +title: "10" +parent: Default +grand_parent: Order +``` diff --git a/docs/tests/navigation/order/default/2.md b/docs/tests/navigation/order/default/2.md new file mode 100644 index 0000000..5e2792b --- /dev/null +++ b/docs/tests/navigation/order/default/2.md @@ -0,0 +1,14 @@ +--- +layout: default +title: "2" +parent: Default +grand_parent: Order +--- + +# 2 + +```yaml +title: "2" +parent: Default +grand_parent: Order +``` diff --git a/docs/tests/navigation/order/default/a.md b/docs/tests/navigation/order/default/a.md new file mode 100644 index 0000000..a122e97 --- /dev/null +++ b/docs/tests/navigation/order/default/a.md @@ -0,0 +1,14 @@ +--- +layout: default +title: A +parent: Default +grand_parent: Order +--- + +# A + +```yaml +title: A +parent: Default +grand_parent: Order +``` diff --git a/docs/tests/navigation/order/default/aa-lower.md b/docs/tests/navigation/order/default/aa-lower.md new file mode 100644 index 0000000..43957d6 --- /dev/null +++ b/docs/tests/navigation/order/default/aa-lower.md @@ -0,0 +1,14 @@ +--- +layout: default +title: aa +parent: Default +grand_parent: Order +--- + +# aa + +```yaml +title: aa +parent: Default +grand_parent: Order +``` diff --git a/docs/tests/navigation/order/default/aa.md b/docs/tests/navigation/order/default/aa.md new file mode 100644 index 0000000..081bcfc --- /dev/null +++ b/docs/tests/navigation/order/default/aa.md @@ -0,0 +1,14 @@ +--- +layout: default +title: Aa +parent: Default +grand_parent: Order +--- + +# Aa + +```yaml +title: Aa +parent: Default +grand_parent: Order +``` diff --git a/docs/tests/navigation/order/default/index.md b/docs/tests/navigation/order/default/index.md new file mode 100644 index 0000000..d672d77 --- /dev/null +++ b/docs/tests/navigation/order/default/index.md @@ -0,0 +1,15 @@ +--- +layout: default +title: Default +parent: 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). diff --git a/docs/tests/navigation/order/floats/-1.1.md b/docs/tests/navigation/order/floats/-1.1.md new file mode 100644 index 0000000..3466e76 --- /dev/null +++ b/docs/tests/navigation/order/floats/-1.1.md @@ -0,0 +1,16 @@ +--- +layout: default +title: "-1.1" +nav_order: -1.1 +parent: Floats +grand_parent: Order +--- + +# -1.1 + +```yaml +title: "-1.1" +nav_order: -1.1 +parent: Floats +grand_parent: Order +``` diff --git a/docs/tests/navigation/order/floats/0.0.md b/docs/tests/navigation/order/floats/0.0.md new file mode 100644 index 0000000..6c545ba --- /dev/null +++ b/docs/tests/navigation/order/floats/0.0.md @@ -0,0 +1,16 @@ +--- +layout: default +title: "0.0" +nav_order: 0.0 +parent: Floats +grand_parent: Order +--- + +# 0.0 + +```yaml +title: "0.0" +nav_order: 0.0 +parent: Floats +grand_parent: Order +``` diff --git a/docs/tests/navigation/order/floats/10.0.md b/docs/tests/navigation/order/floats/10.0.md new file mode 100644 index 0000000..fc648c4 --- /dev/null +++ b/docs/tests/navigation/order/floats/10.0.md @@ -0,0 +1,16 @@ +--- +layout: default +title: "10.0" +nav_order: 10.0 +parent: Floats +grand_parent: Order +--- + +# 10.0 + +```yaml +title: "10.0" +nav_order: 10.0 +parent: Floats +grand_parent: Order +``` diff --git a/docs/tests/navigation/order/floats/2.2222.md b/docs/tests/navigation/order/floats/2.2222.md new file mode 100644 index 0000000..8050d7b --- /dev/null +++ b/docs/tests/navigation/order/floats/2.2222.md @@ -0,0 +1,16 @@ +--- +layout: default +title: "2.2222" +nav_order: 2.2222 +parent: Floats +grand_parent: Order +--- + +# 2.2222 + +```yaml +title: "2.2222" +nav_order: 2.2222 +parent: Floats +grand_parent: Order +``` diff --git a/docs/tests/navigation/order/floats/index.md b/docs/tests/navigation/order/floats/index.md new file mode 100644 index 0000000..2a3db37 --- /dev/null +++ b/docs/tests/navigation/order/floats/index.md @@ -0,0 +1,13 @@ +--- +layout: default +title: Floats +parent: 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. diff --git a/docs/tests/navigation/order/index.md b/docs/tests/navigation/order/index.md new file mode 100644 index 0000000..c1b488a --- /dev/null +++ b/docs/tests/navigation/order/index.md @@ -0,0 +1,8 @@ +--- +layout: default +title: Order +has_children: true +nav_order: 110 +--- + +# Order diff --git a/docs/tests/navigation/order/integers/-1.md b/docs/tests/navigation/order/integers/-1.md new file mode 100644 index 0000000..5b6e229 --- /dev/null +++ b/docs/tests/navigation/order/integers/-1.md @@ -0,0 +1,16 @@ +--- +layout: default +title: "-1" +nav_order: -1 +parent: Integers +grand_parent: Order +--- + +# -1 + +```yaml +title: "-1" +nav_order: -1 +parent: Integers +grand_parent: Order +``` diff --git a/docs/tests/navigation/order/integers/0.md b/docs/tests/navigation/order/integers/0.md new file mode 100644 index 0000000..f97f599 --- /dev/null +++ b/docs/tests/navigation/order/integers/0.md @@ -0,0 +1,16 @@ +--- +layout: default +title: "0" +nav_order: 0 +parent: Integers +grand_parent: Order +--- + +# 0 + +```yaml +title: "0" +nav_order: 0 +parent: Integers +grand_parent: Order +``` diff --git a/docs/tests/navigation/order/integers/10.md b/docs/tests/navigation/order/integers/10.md new file mode 100644 index 0000000..181bffb --- /dev/null +++ b/docs/tests/navigation/order/integers/10.md @@ -0,0 +1,16 @@ +--- +layout: default +title: "10" +nav_order: 10 +parent: Integers +grand_parent: Order +--- + +# 10 + +```yaml +title: "10" +nav_order: 10 +parent: Integers +grand_parent: Order +``` diff --git a/docs/tests/navigation/order/integers/2.md b/docs/tests/navigation/order/integers/2.md new file mode 100644 index 0000000..51c76c7 --- /dev/null +++ b/docs/tests/navigation/order/integers/2.md @@ -0,0 +1,16 @@ +--- +layout: default +title: "2" +nav_order: 2 +parent: Integers +grand_parent: Order +--- + +# 2 + +```yaml +title: "2" +nav_order: 2 +parent: Integers +grand_parent: Order +``` diff --git a/docs/tests/navigation/order/integers/index.md b/docs/tests/navigation/order/integers/index.md new file mode 100644 index 0000000..674c841 --- /dev/null +++ b/docs/tests/navigation/order/integers/index.md @@ -0,0 +1,13 @@ +--- +layout: default +title: Integers +parent: 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. diff --git a/docs/tests/navigation/order/mixture/-1.1.md b/docs/tests/navigation/order/mixture/-1.1.md new file mode 100644 index 0000000..60b8a60 --- /dev/null +++ b/docs/tests/navigation/order/mixture/-1.1.md @@ -0,0 +1,16 @@ +--- +layout: default +title: "-1.1" +nav_order: -1.1 +parent: Mixture +grand_parent: Order +--- + +# -1.1 + +```yaml +title: "-1.1" +nav_order: -1.1 +parent: Mixture +grand_parent: Order +``` diff --git a/docs/tests/navigation/order/mixture/-1.md b/docs/tests/navigation/order/mixture/-1.md new file mode 100644 index 0000000..81c247f --- /dev/null +++ b/docs/tests/navigation/order/mixture/-1.md @@ -0,0 +1,16 @@ +--- +layout: default +title: "-1" +nav_order: -1 +parent: Mixture +grand_parent: Order +--- + +# -1 + +```yaml +title: "-1" +nav_order: -1 +parent: Mixture +grand_parent: Order +``` diff --git a/docs/tests/navigation/order/mixture/0.0.md b/docs/tests/navigation/order/mixture/0.0.md new file mode 100644 index 0000000..46ea906 --- /dev/null +++ b/docs/tests/navigation/order/mixture/0.0.md @@ -0,0 +1,16 @@ +--- +layout: default +title: "0.0" +nav_order: 0.0 +parent: Mixture +grand_parent: Order +--- + +# 0.0 + +```yaml +title: "0.0" +nav_order: 0.0 +parent: Mixture +grand_parent: Order +``` diff --git a/docs/tests/navigation/order/mixture/0.md b/docs/tests/navigation/order/mixture/0.md new file mode 100644 index 0000000..5fb96d8 --- /dev/null +++ b/docs/tests/navigation/order/mixture/0.md @@ -0,0 +1,16 @@ +--- +layout: default +title: "0" +nav_order: 0 +parent: Mixture +grand_parent: Order +--- + +# 0 + +```yaml +title: "0" +nav_order: 0 +parent: Mixture +grand_parent: Order +``` diff --git a/docs/tests/navigation/order/mixture/10.0.md b/docs/tests/navigation/order/mixture/10.0.md new file mode 100644 index 0000000..4f137a8 --- /dev/null +++ b/docs/tests/navigation/order/mixture/10.0.md @@ -0,0 +1,16 @@ +--- +layout: default +title: "10.0" +nav_order: 10.0 +parent: Mixture +grand_parent: Order +--- + +# 10.0 + +```yaml +title: "10.0" +nav_order: 10.0 +parent: Mixture +grand_parent: Order +``` diff --git a/docs/tests/navigation/order/mixture/10.md b/docs/tests/navigation/order/mixture/10.md new file mode 100644 index 0000000..03c7c88 --- /dev/null +++ b/docs/tests/navigation/order/mixture/10.md @@ -0,0 +1,14 @@ +--- +layout: default +title: "10" +parent: Mixture +grand_parent: Order +--- + +# 10 + +```yaml +title: "10" +parent: Mixture +grand_parent: Order +``` diff --git a/docs/tests/navigation/order/mixture/2.2222.md b/docs/tests/navigation/order/mixture/2.2222.md new file mode 100644 index 0000000..b8d74fb --- /dev/null +++ b/docs/tests/navigation/order/mixture/2.2222.md @@ -0,0 +1,16 @@ +--- +layout: default +title: "2.2222" +nav_order: 2.2222 +parent: Mixture +grand_parent: Order +--- + +# 2.2222 + +```yaml +title: "2.2222" +nav_order: 2.2222 +parent: Mixture +grand_parent: Order +``` diff --git a/docs/tests/navigation/order/mixture/2.md b/docs/tests/navigation/order/mixture/2.md new file mode 100644 index 0000000..22e118b --- /dev/null +++ b/docs/tests/navigation/order/mixture/2.md @@ -0,0 +1,14 @@ +--- +layout: default +title: "2" +parent: Mixture +grand_parent: Order +--- + +# 2 + +```yaml +title: "2" +parent: Mixture +grand_parent: Order +``` diff --git a/docs/tests/navigation/order/mixture/a.md b/docs/tests/navigation/order/mixture/a.md new file mode 100644 index 0000000..8d36765 --- /dev/null +++ b/docs/tests/navigation/order/mixture/a.md @@ -0,0 +1,14 @@ +--- +layout: default +title: A +parent: Mixture +grand_parent: Order +--- + +# A + +```yaml +title: A +parent: Mixture +grand_parent: Order +``` diff --git a/docs/tests/navigation/order/mixture/aa-lower.md b/docs/tests/navigation/order/mixture/aa-lower.md new file mode 100644 index 0000000..12a8631 --- /dev/null +++ b/docs/tests/navigation/order/mixture/aa-lower.md @@ -0,0 +1,16 @@ +--- +layout: default +title: aa +nav_order: "aa" +parent: Mixture +grand_parent: Order +--- + +# aa + +```yaml +title: aa +nav_order: "aa" +parent: Mixture +grand_parent: Order +``` diff --git a/docs/tests/navigation/order/mixture/aa.md b/docs/tests/navigation/order/mixture/aa.md new file mode 100644 index 0000000..d826339 --- /dev/null +++ b/docs/tests/navigation/order/mixture/aa.md @@ -0,0 +1,16 @@ +--- +layout: default +title: Aa +nav_order: "Aa" +parent: Mixture +grand_parent: Order +--- + +# Aa + +```yaml +title: Aa +nav_order: "Aa" +parent: Mixture +grand_parent: Order +``` diff --git a/docs/tests/navigation/order/mixture/index.md b/docs/tests/navigation/order/mixture/index.md new file mode 100644 index 0000000..1d45bc7 --- /dev/null +++ b/docs/tests/navigation/order/mixture/index.md @@ -0,0 +1,11 @@ +--- +layout: default +title: Mixture +parent: 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. diff --git a/docs/tests/navigation/order/strings/10.md b/docs/tests/navigation/order/strings/10.md new file mode 100644 index 0000000..4bc8b59 --- /dev/null +++ b/docs/tests/navigation/order/strings/10.md @@ -0,0 +1,16 @@ +--- +layout: default +title: "10" +nav_order: "10" +parent: Strings +grand_parent: Order +--- + +# 10 + +```yaml +title: "10" +nav_order: "10" +parent: Strings +grand_parent: Order +``` diff --git a/docs/tests/navigation/order/strings/2.md b/docs/tests/navigation/order/strings/2.md new file mode 100644 index 0000000..be13a98 --- /dev/null +++ b/docs/tests/navigation/order/strings/2.md @@ -0,0 +1,16 @@ +--- +layout: default +title: "2" +nav_order: "2" +parent: Strings +grand_parent: Order +--- + +# 2 + +```yaml +title: "2" +nav_order: "2" +parent: Strings +grand_parent: Order +``` diff --git a/docs/tests/navigation/order/strings/a.md b/docs/tests/navigation/order/strings/a.md new file mode 100644 index 0000000..71dd447 --- /dev/null +++ b/docs/tests/navigation/order/strings/a.md @@ -0,0 +1,16 @@ +--- +layout: default +title: A +nav_order: A +parent: Strings +grand_parent: Order +--- + +# A + +```yaml +title: A +nav_order: A +parent: Strings +grand_parent: Order +``` diff --git a/docs/tests/navigation/order/strings/aa-lower.md b/docs/tests/navigation/order/strings/aa-lower.md new file mode 100644 index 0000000..ea9c10b --- /dev/null +++ b/docs/tests/navigation/order/strings/aa-lower.md @@ -0,0 +1,16 @@ +--- +layout: default +title: aa +nav_order: "aa" +parent: Strings +grand_parent: Order +--- + +# aa + +```yaml +title: aa +nav_order: "aa" +parent: Strings +grand_parent: Order +``` diff --git a/docs/tests/navigation/order/strings/aa.md b/docs/tests/navigation/order/strings/aa.md new file mode 100644 index 0000000..1daeb04 --- /dev/null +++ b/docs/tests/navigation/order/strings/aa.md @@ -0,0 +1,16 @@ +--- +layout: default +title: Aa +nav_order: "Aa" +parent: Strings +grand_parent: Order +--- + +# Aa + +```yaml +title: Aa +nav_order: "Aa" +parent: Strings +grand_parent: Order +``` diff --git a/docs/tests/navigation/order/strings/index.md b/docs/tests/navigation/order/strings/index.md new file mode 100644 index 0000000..3eb5bc5 --- /dev/null +++ b/docs/tests/navigation/order/strings/index.md @@ -0,0 +1,13 @@ +--- +layout: default +title: Strings +parent: 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). diff --git a/docs/ui-components/linenos.md b/docs/ui-components/linenos.md index b13e6c9..a81d511 100644 --- a/docs/ui-components/linenos.md +++ b/docs/ui-components/linenos.md @@ -27,7 +27,7 @@ following configuration option: kramdown: syntax_highlighter_opts: block: - line_numbers: false + line_numbers: true {% endhighlight %} Line numbers can then be suppressed locally using Liquid tags (_without_ the diff --git a/just-the-docs.gemspec b/just-the-docs.gemspec index 0c4d3a3..6d6d47e 100644 --- a/just-the-docs.gemspec +++ b/just-the-docs.gemspec @@ -7,7 +7,7 @@ Gem::Specification.new do |spec| spec.email = ["patrick.marsceill@gmail.com"] spec.summary = %q{A modern, highly customizable, and responsive Jekyll theme for documention with built-in search.} - spec.homepage = "https://github.com/pmarsceill/just-the-docs" + spec.homepage = "https://github.com/pdmosses/just-the-docs" spec.license = "MIT" spec.files = `git ls-files -z`.split("\x0").select { |f| f.match(%r{^(assets|bin|_layouts|_includes|lib|Rakefile|_sass|LICENSE|README)}i) }