Stats
Actions
Tags
From wf
Generate and maintain project documentation using Material for MkDocs and mkdocstrings. Use when creating API references, building documentation sites, or writing user guides.
How this skill is triggered — by the user, by Claude, or both
Slash command
/wf:documentationThe summary Claude sees in its skill listing — used to decide when to auto-load this skill
Generate and maintain documentation using Material for MkDocs and mkdocstrings. For full MkDocs configuration and the API reference generator script see [mkdocs.md](./mkdocs.md). For docstring conventions see the **conventions** skill.
Generate and maintain documentation using Material for MkDocs and mkdocstrings. For full MkDocs configuration and the API reference generator script see mkdocs.md. For docstring conventions see the conventions skill.
Use when setting up a documentation site, generating API docs from code, writing user guides, or creating architecture documentation. Not for inline code comments or commit messages.
| Tool | Purpose |
|---|---|
| Material for MkDocs | Documentation site theme |
| mkdocstrings | Auto-generate API docs from docstrings |
| mkdocs-gen-files | Generate pages programmatically |
| mkdocs-literate-nav | Navigation from markdown |
| mkdocs-section-index | Section index pages |
${PROJECT_NAME}/
├── docs/
│ ├── index.md # Homepage
│ ├── getting-started.md # Quick start guide
│ ├── user-guide/ # User documentation
│ ├── reference/ # Auto-generated API docs
│ ├── development/ # Developer docs
│ └── scripts/
│ └── gen_ref_pages.py # API docs generator script
├── mkdocs.yml # MkDocs configuration
└── pyproject.toml
uv sync --group docs # Install docs dependencies
uv run mkdocs serve # Local dev server with hot reload
uv run mkdocs build --strict # Build static site
uv run mkdocs gh-deploy --force # Deploy to GitHub Pages
!!! note
This is a note.
!!! warning
This is a warning.
??? info "Collapsible"
Collapsed by default.
```python
result = process() # (1)!
1. This annotation explains the line
```
See [`fetch_data`][${PROJECT_NAME}.services.api.fetch_data] for details.
The [`Config`][${PROJECT_NAME}.core.config.Config] class handles settings.
npx claudepluginhub mesca/claude-plugins --plugin wfGuides MkDocs Material setup with Diataxis framework, mkdocstrings and Griffe for API reference pages, Google-style docstrings, nav structure, code example testing, and deployment to GitHub Pages or ReadTheDocs.
Generates documentation from code including API references, developer guides, READMEs, and architecture overviews. Matches existing styles and avoids overwriting in brownfield codebases.