mkdocs-pagetree-plugin

MkDocs plugin that allows you to display the page tree. Like sitemap.xml, but for humans.

Demo & Docs

https://tombreit.github.io/mkdocs-pagetree-plugin/

Setup

Install the plugin PyPI package:

pip install mkdocs-pagetree-plugin

Configure mkdocs.yml:

plugins:
  - pagetree

Usage

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).

Development

git clone git@github.com:tombreit/mkdocs-pagetree-plugin.git
cd mkdocs-pagetree-plugin
pip install --editable .[dev]

Tests

git clone git@github.com:tombreit/mkdocs-pagetree-plugin.git
cd mkdocs-pagetree-plugin
pip install --editable .[dev]
pytest