Простой проект документации с YFM
Структура проекта
Основной проект содержит несколько конфигурационных файлов и страницы с фактическим содержанием. Оба конфигурационных файла и markdown организованы в следующую структуру:
input-folder
|-- .yfm (конфигурационный файл для всего проекта)
|-- toc.yaml (оглавление)
|-- presets.yaml (предустановки для переменных)
|-- index.yaml (индексная страница)
|-- pages (страницы с контентом)
|-- faq.md
|-- how-to.md
|-- _assets (директория с изображениями)
|-- image1.png
|-- image2.png
|-- _includes (директория для многократно используемого контента)
|-- faq_shared_block.md
Эта структура позволяет организовать документацию в формате YFM для более удобного редактирования и согласования.
Была ли статья полезна?
Предыдущая
Следующая