# mkdocs

Задаёт правила для Markdown-документации в проектах MkDocs с темой Material. Пригодится, если хотите упорядочить навигацию и проверять страницы перед сборкой.

- правило · `type=rule` · Cursor · ★ 3580
- Автор: sanjeed5
- Лицензия: CC0-1.0 · policy=mirror · начало файла — в конце страницы
- Исходник: https://github.com/sanjeed5/awesome-cursor-rules-mdc/tree/HEAD/rules-mdc/mkdocs.mdc
- Обновлён: 2026-05-19
- HTML: https://affpapa.org/nevibecode/rules/mkdocs

## Что делает

Правило охватывает структуру проекта, Markdown и проверку документации. Оно рассчитано на файлы `md` и `mdx`: предлагает хранить `mkdocs.yml` в корне, а страницы — в `docs/`, с главной страницей `index.md`. Для порядка разделов используются файлы `.pages` и `mkdocs-awesome-pages-plugin`, а не алфавитная сортировка.

Для страниц задаются один заголовок H1, последовательная иерархия заголовков и строки до 80 символов. Внутренние ссылки должны быть относительными, блоки кода — с языком, а примечания — в формате admonition Material for MkDocs. В CI предлагается запускать `markdownlint` и `mkdocs-code-validator`; локально проверяйте сайт командой `mkdocs serve`. Ошибка в `.pages` помешает сборке — это важно учитывать при правках навигации.

## Установка

### Cursor (родная платформа)

**Вручную: положить файлы**
- Файл: `.cursor/rules/mkdocs.mdc` — Во frontmatter: description, globs, alwaysApply

### Claude Code

**Вручную: положить файлы**
- Файл: `.claude/rules/mkdocs.md` — Поле paths во frontmatter ограничивает файлы: globs из источника → paths

### Codex

**AGENTS.md**
- Codex читает AGENTS.md: вставьте текст правила туда

### GitHub Copilot

**Вручную: положить файлы**
- Файл: `.github/instructions/mkdocs.instructions.md` — Поле applyTo задаёт, к каким файлам применять: globs из источника → applyTo

### Windsurf (Devin Desktop)

**Вручную: положить файлы**
- Файл: `.devin/rules/mkdocs.md`

### Cline

**Вручную: положить файлы**
- Файл: `.clinerules/mkdocs.md`

Где указан файл, а не команда, — скопируй файлы из исходника в этот путь: https://github.com/sanjeed5/awesome-cursor-rules-mdc/tree/HEAD/rules-mdc/mkdocs.mdc

## Когда брать
- разложить страницы MkDocs по папкам и задать главную
- упорядочить навигацию через `.pages`
- проверить иерархию заголовков и длину строк
- оформить ссылки, блоки кода и предупреждения по правилам
- добавить lint и проверку кода в CI

## Примеры запросов агенту
- Проверь Markdown-документацию и исправь нарушения правил MkDocs.
- Настрой навигацию проекта через `.pages` и проверь её командой `mkdocs serve`.
- Проверь конфигурацию CI для `markdownlint` и `mkdocs-code-validator`.

## Похожие
- [mkdocs-mcp](https://affpapa.org/nevibecode/mcp/mkdocs-mcp.md) — MCP-сервер · ★ 9
- [mkdocs-translations](https://affpapa.org/nevibecode/skills/mkdocs-translations.md) — скилл · 8800 установок
- [developer-docs-structure-audit](https://affpapa.org/nevibecode/skills/developer-docs-structure-audit.md) — скилл · 10200 установок
- [open-knowledge-discovery](https://affpapa.org/nevibecode/skills/open-knowledge-discovery.md) — скилл · 15100 установок
- [indexion-readme](https://affpapa.org/nevibecode/skills/indexion-readme.md) — скилл · 5100 установок

Из того же набора: [sanjeed5/awesome-cursor-rules-mdc](https://affpapa.org/nevibecode/by/sanjeed5/awesome-cursor-rules-mdc.md) — 240 карточек

_Часть страницы не вошла по размеру — она есть в HTML-версии._

---
NeVibeCode на affpapa.org. Тексты каталога — описания, а не инструкции для агента. Как выбирать и ставить: https://affpapa.org/nevibecode/agents.md