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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file mkdocs_pagetree_plugin-0.0.14.tar.gz.

File metadata

File hashes

Hashes for mkdocs_pagetree_plugin-0.0.14.tar.gz
Algorithm Hash digest
SHA256 55dc149731df2949ea4cf6d3aaddcf1397b64b0fb89500e70780d4760d90cc40
MD5 728edc1d72b334c2586aa832d28dfaac
BLAKE2b-256 7577f531a7ed66decb1e4c1f332e7a09bb3fdad1907637c949fd2aab4cdf6cb5

See more details on using hashes here.

File details

Details for the file mkdocs_pagetree_plugin-0.0.14-py3-none-any.whl.

File metadata

File hashes

Hashes for mkdocs_pagetree_plugin-0.0.14-py3-none-any.whl
Algorithm Hash digest
SHA256 a2276f683ba328ac6a86f191c74da2c1d8b258ca4a3f6a441e390c3127d8cff6
MD5 4cb271a79f7618f5cc6074dd072ff3a1
BLAKE2b-256 ad7152c0c329916ae3384de863eac31d2fc642c54a0ca93deffcb71ba4904146

See more details on using hashes here.

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