Skip to content

Add project: mkdocs-repo-docs#399

Open
killrazor wants to merge 2 commits intomkdocs:mainfrom
killrazor:add-repo-docs
Open

Add project: mkdocs-repo-docs#399
killrazor wants to merge 2 commits intomkdocs:mainfrom
killrazor:add-repo-docs

Conversation

@killrazor
Copy link
Copy Markdown

@killrazor killrazor commented Apr 9, 2026

Adds mkdocs-repo-docs to the nav-pages category.

What it does: Auto-discovers markdown files scattered throughout a repository (README files next to code, docs in component directories, files in dotfile directories like .github/) and includes them in the MkDocs documentation site.

Key features:

  • Stages repo files into docs/_repo/ at build time
  • Handles dotfile directories that MkDocs normally excludes
  • Directory and file renaming for clean nav
  • Footer injection with source path links
  • Configurable nav section positioning
  • Live reload for local development

PyPI: https://pypi.org/project/mkdocs-repo-docs/
GitHub: https://github.com/killrazor/mkdocs-repo-docs
License: MIT


Also fixes the Zettelkasten theme entry point name (zettelkasten-solarized-light to zettelkasten) which has been causing check_projects.py to fail.

Checklist:

  • I have read the CONTRIBUTING guidelines.
  • I have not modified the README.md file. Projects are only supposed to be added or updated within the projects.yaml file since the README.md file is automatically generated.

@killrazor killrazor changed the title Add mkdocs-repo-docs plugin Add project: mkdocs-repo-docs Apr 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant