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]
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mkdocs_pagetree_plugin-0.0.17.tar.gz.
File metadata
- Download URL: mkdocs_pagetree_plugin-0.0.17.tar.gz
- Upload date:
- Size: 13.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
980fee9d44fc327b847d56f27d6869d97d578f10891248fe4343266a8463601e
|
|
| MD5 |
c60a1c79ff30f7ac9f0819ccca54d4d7
|
|
| BLAKE2b-256 |
04dff3362706a562dea1c439c15c854244f9fad0ca97c65d901468781c02b072
|
File details
Details for the file mkdocs_pagetree_plugin-0.0.17-py3-none-any.whl.
File metadata
- Download URL: mkdocs_pagetree_plugin-0.0.17-py3-none-any.whl
- Upload date:
- Size: 13.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
861016a33d37e05c9ffe382f06471eb5664833fb4713bf4f51e11e28e825b5bf
|
|
| MD5 |
fc091ec118e28dad5bb8f0ee2bfea964
|
|
| BLAKE2b-256 |
f5817fda21890e998b9756d18e3980ed62711f14d0a928568aae2116f279d64b
|
