Руководства — это Markdown-страницы рядом со справочником API: быстрый старт, аутентификация, пагинация и так далее. Они принадлежат версии и выходят вместе с ней. Сама публикация описана в разделе
.
Откройте версию, перейдите на вкладку
Руководства
и нажмите
Добавить руководство
:
- Заголовок — то, что видят читатели.
- Адрес — ссылка для читателей
/v/{версия}/guides/{slug}/. Уникален в пределах версии. - Краткое описание — одно-два предложения для навигации и поиска.
- Содержимое — Markdown, как в статьях базы знаний: выноски, загрузка файлов через
asset:, автоматическое оглавление; справа от редактора — рендер сервера. Синтаксис описан в разделе . - Родительское руководство — вложите руководство в другое из той же версии или оставьте на верхнем уровне.
В шапке видно, сколько руководств на версию допускает ваш тариф.
У руководства нет собственного состояния публикации: на сайте то, что записал последний снимок версии. Единственный элемент управления — переключатель
Включить в следующую публикацию
в форме и в меню каждой строки списка. Выключите его, чтобы придержать черновик, пока остальная версия выходит; включите, когда он готов. На вкладке
Публикация
видно, сколько руководств включено.
Список показывает дерево руководств так, как его получат читатели. Используйте
Переместить выше
и
Переместить ниже
в меню строки, чтобы поменять порядок среди соседей; чтобы перенести руководство под другого родителя, откройте его и измените
Родительское руководство. Новая расстановка выйдет со следующей публикацией.
Каждое сохранение создаёт ревизию; необязательный
Комментарий к изменению в разделе
Расширенные настройки
сохраняется вместе с ней — там же
SEO-заголовок и
SEO-описание. Список
Ревизии
под редактором показывает их все;
Откатиться к этой
записывает старую ревизию как новейший черновик — история никогда не переписывается.
Удалить
в меню строки убирает руководство из рабочего пространства. Читатели продолжают видеть текущий снимок, пока версия не опубликована снова, — с сайта ничего не исчезает случайно.