{"repo":"oprypin/mkdocs-literate-nav","free":true,"listed":false,"github":"https://github.com/oprypin/mkdocs-literate-nav","clone":"git clone https://github.com/oprypin/mkdocs-literate-nav.git","description":"MkDocs plugin to specify the navigation in Markdown instead of YAML","language":"Python","stars":103,"topics":["mkdocs","mkdocs-plugin","markdown","nav"],"license":"MIT","category":"docs-static-sites","readme_excerpt":"mkdocs-literate-nav [Plugin][] for [ProperDocs][] to specify the navigation in Markdown instead of YAML Works well with [section-index][] and [gen-files][] . Supplants [awesome-pages][] . [properdocs]: https://github.com/ProperDocs/properdocs#readme [plugin]: https://properdocs.org/user-guide/plugins/ [section-index]: https://oprypin.github.io/mkdocs-section-index/ [gen-files]: https://oprypin.github.io/mkdocs-gen-files/ [awesome-pages]: https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin Usage Activate the plugin in properdocs.yml : and drop the nav section if it's present there; it will be ignored now. (Unless you want to keep it?) To get this navigation, create the file SUMMARY.md : (old YAML equivalent:) Frob Baz Borgs Bar Foo IMPORTANT: The nav file must be put inside the [ docs directory][docs dir] -- at the root of it. So, the plugin lets you specify your site's navigation with lists of links that are parsed according to normal Markdown rules. Note that, the way we wrote the Markdown, a section seems to also have a page associated with it. ProperDocs doesn't actually support that, and neither is it representable in YAML directly, so the plugin tries to do the next best thing: include the link as the first page of the section. However, this structure is perfectly suited for the [section-index][] plugin, which actually makes that work. Or you could just not associate a link with sections: To get this navigation, create the file SUMMARY.md : (old YAML equivalent:) ","default_branch":null,"files":null,"tree":[],"storefront":"/r/oprypin","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/oprypin/mkdocs-literate-nav/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}