Claude-skill-registry-data mkdocs-documentation

MkDocs Material documentation management. This skill should be used when writing, formatting, or validating documentation in docs/. Covers admonitions, Mermaid diagrams, code blocks with annotations, content tabs, navigation setup, and mkdocs testing. Always check project-specific docs at docs/dev/ai/skills/ and docs/dev/ai/agents/ for project-specific Claude skill and Claude agent documentation when available.

install
source · Clone the upstream repo
git clone https://github.com/majiayu000/claude-skill-registry-data
Claude Code · Install into ~/.claude/skills/
T=$(mktemp -d) && git clone --depth=1 https://github.com/majiayu000/claude-skill-registry-data "$T" && mkdir -p ~/.claude/skills && cp -r "$T/data/mkdocs-documentation" ~/.claude/skills/majiayu000-claude-skill-registry-data-mkdocs-documentation && rm -rf "$T"
manifest: data/mkdocs-documentation/SKILL.md
source content

MkDocs Material Documentation

Write and maintain documentation using MkDocs Material in the

docs/
directory.

Project-Specific Claude Documentation

Always check first for project-specific Claude configurations:

  • docs/dev/ai/skills/SKILL-NAME.md
    - Project-specific Claude skill docs
  • docs/dev/ai/agents/AGENT-NAME.md
    - Project-specific Claude agent docs

These take precedence over general patterns.

Quick Reference

TaskReference
Callout boxesadmonitions.md
Flowcharts, diagramsdiagrams.md
Syntax highlightingcode-blocks.md
Multi-option examplescontent-tabs.md
Links, nav structurenavigation.md
Build, validatetesting.md

Common Patterns

Admonition with Code

!!! example "Usage"

    ```python
    from module import func
    func()
    ```

Tabbed Installation

=== "pip"

    ```bash
    pip install package
    ```

=== "poetry"

    ```bash
    poetry add package
    ```

Feature Documentation

## Feature Name

!!! info "Requirements"
    List prerequisites here.

### Configuration

```yaml
setting: value

Usage

Description with examples.

!!! warning Important caveats.


## Workflow

1. **Write content** - Use references for formatting syntax
2. **Preview** - `mkdocs serve` for live reload
3. **Validate** - `mkdocs build --strict` catches issues
4. **Document Claude features** - Update `docs/dev/ai/skills/` or `docs/dev/ai/agents/` if adding project-specific Claude skills or agents

## Validation Commands

```bash
# Dev server with live reload
mkdocs serve

# Strict build (CI validation)
mkdocs build --strict

# Quick dirty reload during editing
mkdocs serve --dirty