How do I install the Mkdocs Documentation skill?

Run npx skillmds add majiayu000/mkdocs-documentation in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

Is Mkdocs Documentation safe to use?

This skill has not completed SkillMD's automated safety review yet. Capability flags: docs only. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with Mkdocs Documentation?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is Mkdocs Documentation free to use?

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

Who published Mkdocs Documentation?

majiayu000 (@majiayu000) published this skill. Their other Agent Skills are listed on their SkillMD profile.

Mkdocs Documentation by majiayu000 — Agent Skill

Name: Mkdocs Documentation
Rating: 4.2 (5 reviews)
Author: majiayu000

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.

majiayu000 0684fd5 2 files · 3.2 KB Updated Sep 9, 2026 567 repo stars

File contents

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

Task	Reference
Callout boxes	admonitions.md
Flowcharts, diagrams	diagrams.md
Syntax highlighting	code-blocks.md
Multi-option examples	content-tabs.md
Links, nav structure	navigation.md
Build, validate	testing.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

---name: mkdocs-documentationdescription: 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.--- # 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 | Task | Reference | |------|-----------| | Callout boxes | [admonitions.md](references/admonitions.md) | | Flowcharts, diagrams | [diagrams.md](references/diagrams.md) | | Syntax highlighting | [code-blocks.md](references/code-blocks.md) | | Multi-option examples | [content-tabs.md](references/content-tabs.md) | | Links, nav structure | [navigation.md](references/navigation.md) | | Build, validate | [testing.md](references/testing.md) | ## Common Patterns ### Admonition with Code ```markdown !!! example "Usage" ```python from module import func func() ``` ``` ### Tabbed Installation ````markdown === "pip" ```bash pip install package ``` === "poetry" ```bash poetry add package ``` ```` ### Feature Documentation ```markdown ## 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 ```

Frequently asked questions