{"id":21887652,"url":"https://github.com/tombreit/mkdocs-pagetree-plugin","last_synced_at":"2025-08-03T15:42:26.698Z","repository":{"id":209262324,"uuid":"723617853","full_name":"tombreit/mkdocs-pagetree-plugin","owner":"tombreit","description":"MkDocs plugin that allows you to display the page tree. Like `sitemap.xml`, but for humans.","archived":false,"fork":false,"pushed_at":"2025-03-17T08:50:05.000Z","size":2783,"stargazers_count":7,"open_issues_count":2,"forks_count":3,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-28T19:07:35.658Z","etag":null,"topics":["mkdocs","mkdocs-plugin"],"latest_commit_sha":null,"homepage":"https://tombreit.github.io/mkdocs-pagetree-plugin/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tombreit.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"tombreit"}},"created_at":"2023-11-26T08:35:39.000Z","updated_at":"2025-03-16T21:21:45.000Z","dependencies_parsed_at":"2024-05-14T11:45:44.585Z","dependency_job_id":"3072fc57-9861-40c4-a563-032829fe4040","html_url":"https://github.com/tombreit/mkdocs-pagetree-plugin","commit_stats":null,"previous_names":["tombreit/mkdocs-pagetree-plugin"],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tombreit%2Fmkdocs-pagetree-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tombreit%2Fmkdocs-pagetree-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tombreit%2Fmkdocs-pagetree-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tombreit%2Fmkdocs-pagetree-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tombreit","download_url":"https://codeload.github.com/tombreit/mkdocs-pagetree-plugin/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249048714,"owners_count":21204306,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["mkdocs","mkdocs-plugin"],"created_at":"2024-11-28T11:11:51.881Z","updated_at":"2025-04-15T09:53:29.401Z","avatar_url":"https://github.com/tombreit.png","language":"Python","funding_links":["https://github.com/sponsors/tombreit"],"categories":[],"sub_categories":[],"readme":"\u003c!--\nSPDX-FileCopyrightText: 2023 Thomas Breitner\n\nSPDX-License-Identifier: MIT\n--\u003e\n\n# mkdocs-pagetree-plugin\n\n[MkDocs](https://www.mkdocs.org/) plugin that allows you to display the page tree. Like `sitemap.xml`, but for humans.\n\n[![PyPI - Version](https://img.shields.io/pypi/v/mkdocs-pagetree-plugin?color=rgb(17%2C%20148%2C%20223)\u0026link=https%3A%2F%2Fpypi.org%2Fproject%2Fmkdocs-pagetree-plugin%2F)](https://pypi.org/project/mkdocs-pagetree-plugin/)\n[![REUSE status](https://api.reuse.software/badge/github.com/tombreit/mkdocs-pagetree-plugin)](https://api.reuse.software/info/github.com/tombreit/mkdocs-pagetree-plugin)\n[![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)\n![pre-commit enabled](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit\u0026logoColor=white)\n\n## Demo \u0026 Docs\n\nhttps://tombreit.github.io/mkdocs-pagetree-plugin/\n\n## Setup\n\nInstall the plugin [PyPI package](https://pypi.org/project/mkdocs-pagetree-plugin/):\n\n```bash\npip install mkdocs-pagetree-plugin\n```\n\nConfigure `mkdocs.yml`:\n\n```yaml\nplugins:\n  - pagetree\n```\n\n## Usage\n\nUse `{{ pagetree }}` in your Markdown page(s) where the page tree should be rendered.\n\nThe `{{ pagetree }}` could be limited to only render `children`, `siblings` or `subtree` pages ([docs](https://tombreit.github.io/mkdocs-pagetree-plugin/#options)).\n\n## Development\n\n```bash\ngit clone git@github.com:tombreit/mkdocs-pagetree-plugin.git\ncd mkdocs-pagetree-plugin\npip install --editable .[dev]\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftombreit%2Fmkdocs-pagetree-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftombreit%2Fmkdocs-pagetree-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftombreit%2Fmkdocs-pagetree-plugin/lists"}