In this example, I have a book-like documentation and it has three chapters:
These would go into separate directories (with sub-pages each ...). The file layout would look like this:
doc/
advanced-use/
basic-use/
intro/
By default, mkdocs and mkdocs-material will order alphabetically, so chapters would end up in the order shown in the file layout above.
Things I know about, but would like to avoid:
nav
setting in mkdocs.yml
: I specifically wish to avoid setting nav
, because then I would have to manually list every single page.I am looking for a way similar to jekyll's/just-the-docs' nav_order
variable, which can be specified in the frontmatter metadata.
I found a plugin to mkdocs that does exactly what I was looking for:
You add a weight
property to your frontmatter, and it takes care of sorting the navigation. It even keeps "previous"/"next" intact. It also deals with section index pages out of the box.