You're Invited:Meet the Socket Team at BlackHat and DEF CON in Las Vegas, Aug 4-6.RSVP
Socket
Book a DemoInstallSign in
Socket

mkdocs-pagetree-plugin

Package Overview
Dependencies
Maintainers
1
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

mkdocs-pagetree-plugin

MkDocs plugin that allows you to display the page tree

0.0.17
pipPyPI
Maintainers
1

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.

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]

FAQs

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts