serve-md-by-mkdocs
CommunityBrowse Markdown across a repo with MkDocs.
Authorigamenovoer
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill provides a quick, web-based viewer for Markdown scattered across a repository by serving them with MkDocs while preserving the original directory structure.
Core Features & Use Cases
- Web-based Markdown viewer: browse notes, runbooks, and docs across a project without moving files.
- Dedicated work directory scaffolding: auto-create a scanner, manifest, and a generated mkdocs.yml (preserving existing config when available).
- Built-in MkDocs integration: Mermaid and KaTeX support via pymdown-extensions, with a simple path for serving locally.
- Use Case: quickly preview scattered documentation in a large codebase without reorganizing assets or writing custom docs nav.
Quick Start
Run the workflow to scaffold the docview service and start MkDocs serve:
- Create or reuse a work directory and run the refresh-docs-tree.sh to build the staged tree.
- Start MkDocs: mkdocs serve -f <work_dir>/mkdocs.yml
Dependency Matrix
Required Modules
None requiredComponents
scripts
💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: serve-md-by-mkdocs Download link: https://github.com/igamenovoer/magic-context/archive/main.zip#serve-md-by-mkdocs Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.