fw-mkdocs

Community

MkDocs adapter: parse navigation and generate docs.

Authorxiaolai
Version1.0.0
Installs0

System Documentation

What problem does it solve?

MkDocs projects often struggle to keep navigation, theming, and documentation generation aligned as the project grows. This skill provides an adapter to parse MkDocs configuration, validate consistency, and generate templates that conform to Material theme conventions.

Core Features & Use Cases

  • Nav-parsing and mapping: derive a coherent site navigation structure from mkdocs.yml.
  • Theme conventions: ensure Material theme settings and template consistency across docs.
  • Doc-generation templates: provide ready-to-use doc templates to accelerate documentation across modules.
  • Use Case: Automatically scaffold navigation and templates for multi-module MkDocs projects.

Quick Start

Run the MkDocs framework adapter to parse your mkdocs.yml and scaffold navigation-aware docs templates.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 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: fw-mkdocs
Download link: https://github.com/xiaolai/docs-guardian-for-claude/archive/main.zip#fw-mkdocs

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.