# markdown-documentation

Скилл задаёт агенту правила оформления Markdown: README, вики, страницы документации. Пригодится, когда тексты пишет модель и их надо привести к одному виду.

- скилл · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode · 1300 установок · ★ 371
- Автор: aj-geddes
- Лицензия: MIT · policy=mirror · начало файла — в конце страницы
- Исходник: https://github.com/aj-geddes/useful-ai-prompts/tree/HEAD/skills/markdown-documentation/SKILL.md
- Обновлён: 2026-03-04
- HTML: https://affpapa.org/nevibecode/skills/markdown-documentation

## Что делает

Скилл описывает синтаксис обычного Markdown и GitHub Flavored Markdown: заголовки, списки, ссылки и картинки, таблицы, блоки кода, сворачиваемые секции, врезки-алерты и диаграммы Mermaid. Внутри — справочники в каталоге `references/`, по одному на тему: `text-formatting.md`, `lists.md`, `links-and-images.md`, `extended-syntax-github-flavored-markdown.md`, `collapsible-sections.md`, `alerts-and-callouts.md`, `mermaid-diagrams.md`.

Отдельный блок — практики. Советует давать ссылкам описательный текст, добавлять alt к картинкам, указывать язык у блоков кода, держать строку в пределах 80–100 символов и ставить оглавление в длинные документы. Чего избегать: ссылок вида «click here», абсолютных путей к локальным файлам, картинок вместо текста и простыней без разрывов.

Скилл ставится в Claude, Codex, Cursor, GitHub Copilot, Gemini CLI и OpenCode. Для Claude файл ложится в `~/.claude/skills/markdown-documentation/SKILL.md`, для Cursor — в `.cursor/skills/markdown-documentation/SKILL.md`, для Copilot — в `.github/skills/markdown-documentation/SKILL.md`. Если документация у вас на русском, английские примеры из справочников придётся адаптировать самому — скилл про синтаксис, а не про язык текста.

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

## Установка

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

1. **Через Skills CLI (Vercel)**
```bash
npx skills add aj-geddes/useful-ai-prompts --skill markdown-documentation -a claude-code
```

2. **Вручную: положить файлы**
- Файл: `~/.claude/skills/markdown-documentation/SKILL.md` — Папка скилла целиком; для одного проекта — .claude/skills/markdown-documentation/

### Codex

1. **Через Skills CLI (Vercel)**
```bash
npx skills add aj-geddes/useful-ai-prompts --skill markdown-documentation -a codex
```

2. **Вручную: положить файлы**
- Файл: `.agents/skills/markdown-documentation/SKILL.md` — Для всех проектов — ~/.agents/skills/

### Cursor

1. **Через Skills CLI (Vercel)**
```bash
npx skills add aj-geddes/useful-ai-prompts --skill markdown-documentation -a cursor
```

2. **Вручную: положить файлы**
- Файл: `.cursor/skills/markdown-documentation/SKILL.md` — Cursor читает и .agents/skills/, и .claude/skills/

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install aj-geddes/useful-ai-prompts markdown-documentation
```

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

### Gemini CLI

1. **Через Skills CLI (Vercel)**
```bash
npx skills add aj-geddes/useful-ai-prompts --skill markdown-documentation -a gemini-cli
```

2. **Командой платформы**
```bash
gemini skills install https://github.com/aj-geddes/useful-ai-prompts --path skills/markdown-documentation
```

### Windsurf (Devin Desktop)

**Вручную: положить файлы**
- Файл: `.devin/skills/markdown-documentation/SKILL.md` — Старый путь .windsurf/skills/ тоже читается

### OpenCode

**Через Skills CLI (Vercel)**
```bash
npx skills add aj-geddes/useful-ai-prompts --skill markdown-documentation -a opencode
```

### Claude.ai

**Claude.ai**
- Упакуйте папку в zip и загрузите в Settings → Capabilities → Skills

Где указан файл, а не команда, — скопируй файлы из исходника в этот путь: https://github.com/aj-geddes/useful-ai-prompts/tree/HEAD/skills/markdown-documentation/SKILL.md

## Когда брать
- написать README для нового репозитория
- привести разрозненные страницы документации к одному стилю
- оформить таблицу и блоки кода в вики GitHub
- добавить оглавление и alt-тексты в длинный документ
- починить ссылки и разметку перед публикацией

## Примеры запросов агенту
- Напиши README для этого проекта по правилам скилла markdown-documentation
- Оформи таблицу сравнения методов в GitHub Flavored Markdown
- Проверь мою страницу документации на ошибки разметки и ссылки

## Похожие
- [documentation](https://affpapa.org/nevibecode/skills/documentation.md) — скилл · 10300 установок
- [code-documentation](https://affpapa.org/nevibecode/skills/code-documentation.md) — скилл · 1900 установок
- [technical-documentation](https://affpapa.org/nevibecode/skills/technical-documentation.md) — скилл · 1400 установок
- [documentation-engineer](https://affpapa.org/nevibecode/skills/documentation-engineer.md) — скилл · 711 установок
- [170-java-documentation](https://affpapa.org/nevibecode/skills/170-java-documentation.md) — скилл · 359 установок
- [convert-documents-to-markdown](https://affpapa.org/nevibecode/skills/convert-documents-to-markdown.md) — скилл · 12500 установок

Из того же набора: [aj-geddes/useful-ai-prompts](https://affpapa.org/nevibecode/by/aj-geddes/useful-ai-prompts.md) — 118 карточек

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

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