https://github.com/tombreit/mkdocs-pagetree-plugin

MkDocs plugin that allows you to display the page tree. Like `sitemap.xml`, but for humans.
https://github.com/tombreit/mkdocs-pagetree-plugin

mkdocs-plugin

Last synced: 24 days ago
JSON representation

MkDocs plugin that allows you to display the page tree. Like `sitemap.xml`, but for humans.

• Host: GitHub
• URL: https://github.com/tombreit/mkdocs-pagetree-plugin
• Owner: tombreit
• License: mit
• Created: 2023-11-26T08:35:39.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-05-14T15:27:52.000Z (7 months ago)
• Last Synced: 2024-11-11T23:47:20.482Z (about 1 month ago)
• Topics: mkdocs-plugin
• Language: JavaScript
• Homepage: https://tombreit.github.io/mkdocs-pagetree-plugin/
• Size: 827 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


# mkdocs-pagetree-plugin

[MkDocs](https://www.mkdocs.org/) plugin that allows you to display the page tree. Like `sitemap.xml`, but for humans.

[![PyPI - Version](https://img.shields.io/pypi/v/mkdocs-pagetree-plugin?color=rgb(17%2C%20148%2C%20223)&link=https%3A%2F%2Fpypi.org%2Fproject%2Fmkdocs-pagetree-plugin%2F)](https://pypi.org/project/mkdocs-pagetree-plugin/)

[![REUSE status](https://api.reuse.software/badge/github.com/tombreit/mkdocs-pagetree-plugin)](https://api.reuse.software/info/github.com/tombreit/mkdocs-pagetree-plugin)

[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)

![pre-commit enabled](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)

## Demo & Docs

https://tombreit.github.io/mkdocs-pagetree-plugin/

## Setup

Install the plugin [PyPI package](https://pypi.org/project/mkdocs-pagetree-plugin/):

```bash

pip install mkdocs-pagetree-plugin

```

Configure `mkdocs.yml`:

```yaml

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](https://tombreit.github.io/mkdocs-pagetree-plugin/#notes)).

## Development

```bash

git clone [email protected]:tombreit/mkdocs-pagetree-plugin.git

cd mkdocs-pagetree-plugin

pip install --editable .[dev]

```