# write-docs

Скилл для правки документации GitBook прямо в файлах: markdown-страницы, SUMMARY.md, блоки hint и tabs, переменные. Пригодится, когда сайт документации синхронизирован с Git, а не редактируется в веб-интерфейсе.

- скилл · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode · 693 установки · ★ 20
- Автор: GitbookIO
- Лицензия: MIT · policy=mirror · начало файла — в конце страницы
- Исходник: https://github.com/GitbookIO/gitbook-skills/tree/HEAD/skills/write-docs/SKILL.md
- Обновлён: 2026-09-24
- HTML: https://affpapa.org/nevibecode/skills/write-docs

## Что делает

Скилл включается, когда вы работаете с документацией GitBook как с обычными файлами: в Git-синхронизированном репозитории (GitHub, GitLab), в локальном редакторе markdown или в IDE. Агент получает шпаргалку по структуре: страницы, пространства, коллекции, файл `.gitbook.yaml`, каталоги `.gitbook/assets/` и `.gitbook/includes/`, переменные пространства в `.gitbook/vars.yaml`.

Внутри — таблица выбора блоков. Для последовательных шагов берётся `{% stepper %}`, для альтернатив по платформам — `{% tabs %}`, для предупреждений — `{% hint %}` со стилями info, warning, danger, success. Есть разбор frontmatter: `description`, `icon`, `hidden`, `vars`, настройки `layout` с шириной страницы и оглавлением. Переменные подставляются выражениями вида `<code class="expression">space.vars.variableName</code>`.

Отдельный раздел — грабли. Относительные ссылки не работают между пространствами, форма `/spaces/<spaceId>/pages/<pageId>` невалидна, а `description:` со двоеточием или решёткой без кавычек роняет Git Sync молча, без сообщения об ошибке. Это повод проверять frontmatter после правок. Переименовали заголовок страницы — обновите и текст ссылки в SUMMARY.md, сам он не подтянется. Спецификации OpenAPI в markdown не встраиваются: их загружают через UI, API, MCP или CLI.

## Установка

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

1. **Через Skills CLI (Vercel)**
```bash
npx skills add GitbookIO/gitbook-skills --skill write-docs -a claude-code
```

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

### Codex

1. **Через Skills CLI (Vercel)**
```bash
npx skills add GitbookIO/gitbook-skills --skill write-docs -a codex
```

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

### Cursor

1. **Через Skills CLI (Vercel)**
```bash
npx skills add GitbookIO/gitbook-skills --skill write-docs -a cursor
```

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

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install GitbookIO/gitbook-skills write-docs
```

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

### Gemini CLI

1. **Через Skills CLI (Vercel)**
```bash
npx skills add GitbookIO/gitbook-skills --skill write-docs -a gemini-cli
```

2. **Командой платформы**
```bash
gemini skills install https://github.com/GitbookIO/gitbook-skills --path skills/write-docs
```

### Windsurf (Devin Desktop)

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

### OpenCode

**Через Skills CLI (Vercel)**
```bash
npx skills add GitbookIO/gitbook-skills --skill write-docs -a opencode
```

### Claude.ai

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

Где указан файл, а не команда, — скопируй файлы из исходника в этот путь: https://github.com/GitbookIO/gitbook-skills/tree/HEAD/skills/write-docs/SKILL.md

## Когда брать
- собрать новую страницу документации GitBook из markdown-файла
- поправить SUMMARY.md после переименования страницы
- вставить блок hint или tabs в существующую страницу
- настроить переменные пространства в vars.yaml
- проверить ссылки между пространствами перед коммитом

## Примеры запросов агенту
- добавь в getting-started/installation.md блок с шагами установки через stepper
- обнови SUMMARY.md: страница quickstart.md переименована в «Быстрый старт»
- сделай в api-reference/authentication.md вкладки для двух языков и hint с предупреждением

## Похожие
- [docs-write](https://affpapa.org/nevibecode/skills/docs-write.md) — скилл · 2100 установок
- [qt-cpp-docs](https://affpapa.org/nevibecode/skills/qt-cpp-docs.md) — скилл · 782 установки
- [qt-qml-docs](https://affpapa.org/nevibecode/skills/qt-qml-docs.md) — скилл · 717 установок
- [backend-to-frontend-handoff-docs](https://affpapa.org/nevibecode/skills/backend-to-frontend-handoff-docs.md) — скилл · 164 установки
- [update-docs](https://affpapa.org/nevibecode/commands/update-docs.md) — команда · 3861 установка
- [project-docs](https://affpapa.org/nevibecode/skills/project-docs.md) — скилл · 1200 установок

## Другие версии с тем же именем
- [write-docs · tldraw](https://affpapa.org/nevibecode/skills/tldraw-write-docs.md) — 486 установок

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

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