Docsbook
Обзор

Интеграция с GitHub

Позвольте читателям сразу переходить к редактированию любой страницы на GitHub — делая вклад сообщества легким.

Настройки#

Настройка Что она делает
Показывать "Редактировать на GitHub" Добавляет ссылку "Редактировать" внизу каждой страницы
Базовый URL для редактирования на GitHub Базовый путь для ссылки редактирования

Как включить#

  1. Откройте ваш сайт документации.
  2. Наведите указатель → Дизайн → вкладка Контент.
  3. Включите Показывать "Редактировать на GitHub".
  4. Установите URL базового репозитория GitHub для редактирования (см. ниже).
  5. Сохраните.

Установка базового URL редактирования#

Базовый URL редактирования сообщает Docsbook, куда отправлять читателей при нажатии на "Редактировать на GitHub".

Формат:

https://github.com/{username}/{repo}/edit/{branch}/{docs-folder}

Примеры:

Репозиторий Расположение документации Базовый URL редактирования
myname/my-repo Корень репозитория https://github.com/myname/my-repo/edit/main
myname/my-repo Папка /docs https://github.com/myname/my-repo/edit/main/docs
myname/my-repo Ветка master https://github.com/myname/my-repo/edit/master

Docsbook автоматически добавляет к этому базовому URL путь к текущей странице.

Если вы оставите это поле пустым, Docsbook использует разумное значение по умолчанию, основанное на вашем репозитории.

Почему включить это?#

Для проектов с открытым исходным кодом, ссылка "Редактировать на GitHub" необходима — она позволяет участникам сообщества исправлять опечатки, уточнять объяснения и улучшать примеры в один клик.

Для документации команды, она позволяет любому члену команды предлагать улучшения, не зная, как работает Docsbook — они просто редактируют файл напрямую на GitHub.

Превратите своих читателей в соавторов. Подключить репозиторий GitHub →

Работает на Docsbook