mkdocs

What problem does it solve?

This Skill provides practical guidelines to structure, author, and maintain documentation with MkDocs, emphasizing clarity, navigation, and quality.

Core Features & Use Cases

• Docs structure: Organize content in docs/ with a clean index and sub-pages.
• Navigation as code: Define site structure via mkdocs.yml nav to create predictable, versioned docs.
• Theming & plugins: Use themes and plugins to tailor branding and functionality.
• Quality practices: Testing docs, linking images, and keeping files small and focused.

Quick Start

Create a minimal MkDocs project with docs/index.md and mkdocs.yml to generate a basic site.