serve-md-by-mkdocs

You can serve Markdown files scattered across a repository with MkDocs by scaffolding a dedicated work directory. This generates a scanner and manifest to build a staged tree, preserving your original directory structure while providing a web-based viewer.

The best way to preview scattered documentation is using a web-based viewer that auto-discovers Markdown assets and generates a manifest. This serves your notes and runbooks locally without reorganizing files or writing custom docs navigation.

Yes, you need an existing MkDocs installation in your environment to use this Markdown viewer. The skill uses Python scripts to scaffold the service and generate an mkdocs.yml file, which requires the core MkDocs engine to serve locally.

Yes, this MkDocs viewer supports Mermaid diagrams and KaTeX math formulas via pymdown-extensions. These built-in integrations are included when the service scaffolds the generated mkdocs.yml configuration file.

To start the local MkDocs server, run the refresh-docs-tree.sh script to build the staged tree, then execute mkdocs serve with the generated configuration file path pointing to your work directory.

When scaffolding the viewer, the service preserves your existing mkdocs.yml configuration when available. It generates a dedicated configuration file in the work directory to serve the discovered Markdown assets without overwriting your original setup.