Skip to content

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

License

Notifications You must be signed in to change notification settings

tombreit/mkdocs-pagetree-plugin

Repository files navigation

mkdocs-pagetree-plugin

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

PyPI - Version REUSE status Ruff pre-commit enabled

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.