Commit Graph

27 Commits

Author SHA1 Message Date
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 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 591a3c2351 Update navigation-structure.md
Clarifications
2020-08-13 16:48:45 +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
Patrick Marsceill 1bdd849d86
Update navigation-structure.md 2020-06-30 13:58:26 -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
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
Patrick Marsceill ff5047e523
Fix outdated docs
closes #266
2020-05-01 14:55:40 -04:00
Peter Mosses 561f930e83
Update navigation-structure.md
Deleted a spurious line from a previous version.
2020-04-28 17:33:59 +02:00
Patrick Marsceill 41a74d247d
Update docs/navigation-structure.md
Co-Authored-By: Peter Mosses <18308236+pdmosses@users.noreply.github.com>
2020-04-28 10:58:07 -04:00
PLanCompS c46ccd3484 Made case-insenstive sorting the default
Added a configuration option to determine whether the sort order is case-sensitive.
The default is case-insensitive.

To test:
- open `/just-the-docs/docs/utilities/` in the browser,
  and check that the navigation links in `Utilities` are sorted alphabetically;
- in `docs/utilities/layout.md', change the preamble to `title: layout`,
  and check that the  links in `Utilities` are still sorted alphabetically;
- add `nav_sort: case_sensitive` in the configuration file,
  and check that the link to `layout` is now listed last under `Utilities`.
2020-04-25 14:53:45 +02:00
Peter Mosses 06853e895a Update navigation-structure.md
Added documentation of default nav order.
2019-10-11 23:02:19 +01:00
Manu de37d60720 Recommend using index.md as parent page for sections
Using `index.md` as name for the parent page within a section allows lazy developers
to skip defining `permalink`. This is already working and this PR just updates the documentation.
2019-08-15 09:38:44 +08:00
EricFromCanada 71ba32e131 Additional text fixes 2019-01-15 20:48:48 -05:00
EricFromCanada ae5bcfe361 Fix grammar and capitalization 2019-01-14 14:43:29 -05:00
EricFromCanada ff49d02f83 Make spacing consistent 2019-01-14 14:43:16 -05:00
Patrick Marsceill d5d1ddbd92
Docs update 2018-12-16 15:27:25 -05:00
Patrick Marsceill 555dfae410
Make TOC on parent pages optional 2018-12-16 14:27:44 -05:00
Patrick Marsceill c20129c32c
update docs for nav / page strucutre 2018-11-19 16:26:22 -05:00
Patrick Marsceill dac6e45451
Update docs 2018-11-19 13:50:54 -05:00
Patrick Marsceill 4814fbce64
Content cleanup 2018-11-16 14:55:20 -05:00
Patrick Marsceill 379a976387
Add docs for nav exclude 2018-11-16 13:57:49 -05:00
Patrick Marsceill e41c1701a5
Bump nav order for new docs 2018-11-16 11:47:14 -05:00
Patrick Marsceill f7da9a9dd9
final shit for release 2017-04-08 18:51:14 -04:00
Patrick Marsceill e581397758
Initial commit 2017-03-26 21:09:19 -04:00
Patrick Marsceill 594385ae7b
initial commit 2017-03-24 09:47:37 -04:00