Project Book

This feature is available on gitflic.ru

---

The project book allows you to create detailed documentation from your project. This documentation can be created either as a separate repository or within the project itself.

To create a book, go to the project settings and open the "Book" tab. Add a text identifier for your book, specify the starting file, and click "Create Book." You will receive a link to your book, which can be added to the project description so users can quickly access it.

To initialize the book page, you need to add SUMMARY.md to the project to create the table of contents.

Formatting SUMMARY.md

SUMMARY.md should be filled out as follows: the file may contain headings and must include links to files, formatted using Markdown. An example of the table of contents is below:

# Documentation 

* [Introduction](README.md)

## Section 1
* [Article 1](file1.md)
* [Article 2](file2.md)
* [Subsection]()
    * [Article 3](folder/file3.md)
    * [Article 4](folder/file4.md)

Documentation files can be located either in the root or in a folder. The path in the link can be specified relative to the file with the headings, as shown in the example.

Automated translation!

This page was translated using automatic translation tools. The text may contain inaccuracies.