Fw mkdocs

Skill xiaolai/docs-guardian-for-claude/skills/docs-guardian/frameworks/fw-mkdocs

Use when generating or auditing documentation in MkDocs format — covers config, directory structure, frontmatter conventions, and build commands.From its SKILL.md

Install

npx -y skills add xiaolai/docs-guardian-for-claude --skill fw-mkdocs

Assembled from the repository path, not quoted from the project. Check it against their README if it does not work.

One thing to look at

6 stars6 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.

SKILL.md

2.2 KB, as published. Nobody here has run it

MkDocs Framework Adapter

Detection

Detected when mkdocs.yml or mkdocs.yaml exists in project root.

Configuration Parsing

Key fields to extract from mkdocs.yml:

site_name: My Project
docs_dir: docs        # default: docs/
nav:
  - Home: index.md
  - API Reference:
    - Auth: api/auth.md
    - Users: api/users.md
  - Guides:
    - Getting Started: guides/getting-started.md
theme:
  name: material       # most common theme

docs_dir: the documentation root (default docs/)
nav: ordered navigation structure mapping titles to file paths
All paths in nav are relative to docs_dir

Doc Root

Value of docs_dir in mkdocs.yml, defaults to docs/.

Code-to-Doc Mapping

From Nav

Parse nav entries to find existing doc pages. Match source files to doc pages by:

Module name matches page filename
Directory structure mirrors source structure under api/ or reference/

Convention-Based

Source	Doc Candidate
`src/auth/login.ts`	`docs/api/auth.md` or `docs/reference/auth/login.md`
`src/models/user.py`	`docs/api/models/user.md` or `docs/reference/user.md`

Document Template

MkDocs pages use standard Markdown with optional Material theme admonitions:

# Auth Module

Brief description.

## API Reference

### `login(username, password)`

Authenticates a user and returns a session token.

**Parameters:**

| Name | Type | Description |
|------|------|-------------|
| `username` | `str` | The user's login name |
| `password` | `str` | The user's password |

**Returns:** `Session` — An authenticated session object.

!!! warning
    Passwords are transmitted in plaintext unless TLS is configured.

!!! example
    ```python
    session = login("admin", "secret")
    ```

Material Theme Extensions

If using Material theme, docs may include:

!!! note/warning/tip/example admonitions
::: details collapsible sections
{{ var }} Jinja template variables (from mkdocs-macros-plugin)

These are valid MkDocs content — do not flag as quality issues.