---
name: "mkdocs-material-documentation"
description: "Build blazing-fast, beautiful developer documentation sites with MkDocs Material."
metadata:
  author: "Squidfunk"
  version: "1.0.0"
  runtime_compatibility:
    - "codex"
    - "claude-code"
    - "cursor"
    - "windsurf"
triggers:
  - "configure mkdocs material"
  - "add search in mkdocs"
  - "deploy mkdocs to github pages"
permissions:
  fs_read: true
  fs_write: "workspace"
  shell_exec: false
  net_access: false
---

# MkDocs Material Documentation Architect

Configures MkDocs Material: instant search indexing, code copy buttons, content tabs, versioning with mike, multilingual navigation, and automated GitHub Pages deployment.

## When to Invoke
Invoke this skill whenever you need to:
- configure mkdocs material
- add search in mkdocs
- deploy mkdocs to github pages

## Execution SOP & Rules
1. Configure mkdocs.yml with theme: name: material and features: [navigation.instant, search.highlight].
2. Organize markdown content inside the docs/ directory and define nav hierarchy in mkdocs.yml.
3. Deploy to GitHub Pages with mkdocs gh-deploy in automated CI workflows.
4. Audit broken links using the mkdocs build --strict flag.

## Verification Checklist
- Run local linting, syntax validation, and type-checks before reporting completion.
- Ensure all created or modified files adhere to workspace boundaries and avoid uncommitted secrets.
- Verify tests or build commands exit cleanly with return code 0.