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
Metadata
1 maintainer
Release files for mkdocs-pagetree-plugin 0.0.17
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| mkdocs_pagetree_plugin-0.0.17.tar.gz | 13.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mkdocs_pagetree_plugin-0.0.17-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 26.5 kB
Release files / mkdocs_pagetree_plugin-0.0.17.tar.gz
| Download URL | mkdocs_pagetree_plugin-0.0.17.tar.gz |
|---|---|
| Size | 13.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
980fee9d44fc327b847d56f27d6869d97d578f10891248fe4343266a8463601e
|
|
BLAKE2b-256 checksum How to use checksums |
04dff3362706a562dea1c439c15c854244f9fad0ca97c65d901468781c02b072
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Release files / mkdocs_pagetree_plugin-0.0.17-py3-none-any.whl
| Download URL | mkdocs_pagetree_plugin-0.0.17-py3-none-any.whl |
|---|---|
| Size | 13.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
861016a33d37e05c9ffe382f06471eb5664833fb4713bf4f51e11e28e825b5bf
|
|
BLAKE2b-256 checksum How to use checksums |
f5817fda21890e998b9756d18e3980ed62711f14d0a928568aae2116f279d64b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
