Книга проекта

Функционал доступен на gitflic.ru

Книга проекта позволяет создать подробную документацию из вашего проекта. Данную документацию можно создать как в виде отдельного репозитория, так и в самом проекте.

Для создания книги перейдите в настройки проекта и откройте вкладку "Книга". Добавьте текстовый идентификатор для вашей книги, укажите стартовый файл и нажмите "Создать книгу". Вы получите ссылку на вашу книгу, которую можно добавить к описанию проекта, чтобы пользователи могли быстро перейти к ней.

Для инициализации страницы с книгой в проект необходимо добавить SUMMARY.md для создания оглавления.

Оформление SUMMARY.md

SUMMARY.md наполняется следующим образом: в файле могут присутствовать заголовки и обязательно ссылки на файлы, указанные разметкой Markdown. Пример оформления оглавления ниже

# Документация 

* [Введение](README.md)

## Раздел 1
* [Статья 1](file1.md)
* [Статья 2](file2.md)
* [Подраздел]()
    * [Статья 3](folder/file3.md)
    * [Статья 4](folder/file4.md)

Файлы с документацией можно расположить как в корне, так и папке. Путь в ссылке можно указать относительно файла с заголовками, как указано в примере.