# markdown

Задаёт стандарты разметки Markdown и схемы YAML frontmatter для всех файлов .md в проекте. Помогает агенту форматировать тексты без ошибок линтера.

- правило · `type=rule` · Claude Code, Codex, Cursor, GitHub Copilot, Windsurf (Devin Desktop), Cline · ★ 1627 у репозитория
- Автор: microsoft
- Лицензия: MIT · policy=mirror · начало файла — в конце страницы
- Исходник: https://github.com/microsoft/hve-core/tree/HEAD/.github/instructions/hve-core/markdown.instructions.md
- Обновлён: 2026-10-25
- Проверка безопасности: автоматическая, 2026-11-16 (текст) — признаков вредоносного кода не нашли.
- HTML: https://affpapa.org/nevibecode/rules/microsoft-markdown

## Что делает

Правило фиксирует требования к форматированию документов, согласованные с `.markdownlint.json`. Для каждого `.md` файла обязательно наличие YAML frontmatter в начале документа. Набор обязательных полей зависит от типа файла: для документации и корневых файлов нужны `title` и `description`, а для инструкций — `description` и `applyTo`. Даты разрешены строго в формате ISO 8601 (`YYYY-MM-DD`).

В разметке заголовков правило запрещает пропускать уровни и ставить знаки препинания в конце строки. Если во frontmatter уже указано поле `title`, основной текст обязан начинаться сразу со второго уровня `##`: добавление `H1` в таком случае ломает правила MD025 и MD041. Для списков стандарт предписывает маркер `*` и отступ в два пробела для вложенных пунктов.

## Установка

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

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

### Claude Code

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

### Codex

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

### Cursor

**Вручную: положить файлы**
- Файл: `.cursor/rules/markdown.mdc` — Во frontmatter: description, globs, alwaysApply. applyTo из источника → globs, иначе правило само не подключится

### Windsurf (Devin Desktop)

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

### Cline

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

Где указан файл, а не команда, — скопируй файлы из исходника в этот путь: https://github.com/microsoft/hve-core/tree/HEAD/.github/instructions/hve-core/markdown.instructions.md

## Когда брать
- оформить YAML frontmatter по схемам репозитория
- предотвратить ошибки MD025 и MD041 при наличии заголовка во frontmatter
- привести списки и заголовки к единому стилю markdownlint
- стандартизировать формат дат в метаданных документов

## Примеры запросов агенту
- Создай файл `docs/setup.md` со структурой разделов и нужным frontmatter
- Проверь заголовки и списки в `README.md` на соответствие стилю markdownlint
- Добавь метаданные с датой и кратким описанием в начало `docs/api.md`

## Похожие
- [documentation-standards](https://affpapa.org/nevibecode/skills/documentation-standards.md) — скилл · 1 установка
- [obsidian-markdown](https://affpapa.org/nevibecode/skills/agricidaniel-obsidian-markdown.md) — скилл · 593 установки
- [cmux-markdown](https://affpapa.org/nevibecode/skills/cmux-markdown.md) — скилл · 7900 установок
- [markdown-mermaid-writing](https://affpapa.org/nevibecode/skills/markdown-mermaid-writing.md) — скилл · 2300 установок
- [markdown-documentation](https://affpapa.org/nevibecode/skills/markdown-documentation.md) — скилл · 1300 установок
- [verifying-markdown-formatting](https://affpapa.org/nevibecode/skills/verifying-markdown-formatting.md) — скилл · 446 установок

## Другие версии с тем же именем
- [markdown · github](https://affpapa.org/nevibecode/rules/markdown.md) — ★ 41430 у репозитория

Из того же набора: [microsoft/hve-core](https://affpapa.org/nevibecode/by/microsoft/hve-core.md) — 148 карточек

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

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