# markdown-gfm

Правило задаёт Copilot синтаксис GitHub Flavored Markdown, когда он пишет или проверяет файлы .md. Пригодится, если документация должна проходить рендер на GitHub без сюрпризов.

- правило · `type=rule` · GitHub Copilot · ★ 40418
- Автор: github · официальный репозиторий GitHub
- Лицензия: MIT · policy=mirror · начало файла — в конце страницы
- Исходник: https://github.com/github/awesome-copilot/tree/HEAD/instructions/markdown-gfm.instructions.md
- Обновлён: 2026-10-23
- HTML: https://affpapa.org/nevibecode/rules/markdown-gfm

## Что делает

Правило включается на файлы по маске `**/*.md`. Внутри — свод правил GFM: заголовки ATX и Setext, тематические разрывы, блоки кода с отступом и в ограждении, HTML-блоки семи типов, ссылочные определения, таблицы, цитаты, списки и пункты-задачи. Отдельный раздел разбирает инлайны: экранирование обратным слешем, сущности, код-спаны, выделение, зачёркивание, ссылки, картинки и автоссылки.

В конце идёт чек-лист проверки. В нём, например, требуется указывать язык у ограждённого блока кода и следить, чтобы у таблицы совпадало число колонок в шапке и разделителе. Для внутрисловного выделения предписано `*`, а `_` — только на границах слов. Зачёркивание — ровно `~~`, три тильды и больше его не создают.

Спецификация GFM упомянута как справочная, скачивать её правило не велит. Есть и жёсткое ограничение: теги `<script>`, `<style>`, `<title>`, `<textarea>`, `<xmp>`, `<iframe>`, `<noembed>`, `<noframes>` и `<plaintext>` в выводе запрещены — у них ведущий `<` заменяется на `&lt;`. Если документация собирается в статический сайт, это стоит держать в голове.

## Требования
- Работает с: GitHub

## Установка

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

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

### Claude Code

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

### Codex

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

### Cursor

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

### Windsurf (Devin Desktop)

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

### Cline

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

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

## Когда брать
- проверить `.md` на соответствие спецификации GFM
- поймать таблицу с разным числом колонок в шапке и разделителе
- запретить в разметке теги вроде `<script>` и `<iframe>`
- выбрать между `*` и `_` для выделения внутри слова
- проставить язык у ограждённого блока кода

## Примеры запросов агенту
- Проверь `README.md` по правилам GFM и покажи, где разметка сломается при рендере на GitHub
- Поправь таблицу в `docs/api.md`: колонки в шапке и разделителе должны совпадать
- Перепиши этот фрагмент так, чтобы внутрисловное выделение шло через `*`, а не через `_`

Из того же набора: [github/awesome-copilot](https://affpapa.org/nevibecode/by/github/awesome-copilot.md) — 928 карточек

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

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