MkDocs plugin that allows you to display the page tree. Like sitemap.xml
, but for humans.
https://tombreit.github.io/mkdocs-pagetree-plugin/
Install the plugin PyPI package:
pip install mkdocs-pagetree-plugin
Configure mkdocs.yml
:
plugins:
- pagetree
Use {{ pagetree }}
in your Markdown page(s) where the page tree should be rendered.
The {{ pagetree }}
could be limited to only render children
, siblings
or subtree
pages (docs).
git clone [email protected]:tombreit/mkdocs-pagetree-plugin.git
cd mkdocs-pagetree-plugin
pip install --editable .[dev]