Skip to main content

MkDocs plugin that allows you to display the page tree

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mkdocs_pagetree_plugin-0.0.14.tar.gz (14.6 kB view hashes)

Uploaded Source

Built Distribution

mkdocs_pagetree_plugin-0.0.14-py3-none-any.whl (11.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page