Структура #
Структура можеть быть с языками, или же без них:
Без языков
- config.yaml
- nav.yaml
- Ассеты (картинки и прочее)
- Файлы документации .md
С языками
- config.yaml
- Общие ассеты (картинки и прочее)
- Папка языка ru,en,...
- nav.yaml
- Ассеты (картинки и прочее)
- Файлы документации .md
Содержание файлов #
Система генерирует документацию по следующим 4ем типам файлов:
config.yaml #
- Корневой файл конфигурации config.yaml, например:
"language: en\n\nlanguages:\n - label: English\n flag: en\n code: en\n - label: Русский\n flag: ru\n code: ru\n\nassets: \"**/*.svg\"\n\nredirects:\n - from: subfolder/test2\n to: /test2\n - from: subfolder/test3\n to: /test3\n - from: subfolder/tables/multiline\n to: /index\n - from: subfolder/tables/gfm\n to: /index"
language: en
languages:
- label: English
flag: en
code: en
- label: Русский
flag: ru
code: ru
assets: "**/*.svg"
redirects:
- from: subfolder/test2
to: /test2
- from: subfolder/test3
to: /test3
- from: subfolder/tables/multiline
to: /index
- from: subfolder/tables/gfm
to: /indexАссеты .jpeg, ... #
- Далее идут файлы ассетов, указанные в config.yaml
Файлы документации Markdown .md #
- Файлы документации в формате .md
nav.yaml #
- Файл навигации в корне nav.yaml, или внутри папки каждого языка ru/nav.yaml, например:
"title:\n href: \"/\"\n image: \"/api/assets/images/logo.svg\"\n\nlocale:\n heading: \"In the article:\"\n prev: \"Next\"\n next: \"Previous\"\n search: \"Search...\"\n\nvars:\n canSeeExamples: true\n\ntop:\n - label: Google\n href: https://google.com\n - label: Overview\n href: index\n - label: Quick start\n href: quick\n\nleft:\n - label: Quick start\n href: quick\n - label: Markdown\n href: markdown\n items:\n - label: Syntax\n expanded: true\n open: true\n items:\n - label: Index\n href: subfolder/index\n - label: Overview\n href: subfolder/test\n - label: Tables\n open: true\n items:\n - label: Overview\n href: subfolder/tables/overview\n - label: Examples\n href: subfolder/tables/examples\n - label: Settings\n href: settings\n\nhidden:\n - subfolder/tables/multiline"
title:
href: "/"
image: "/api/assets/images/logo.svg"
locale:
heading: "In the article:"
prev: "Next"
next: "Previous"
search: "Search..."
vars:
canSeeExamples: true
top:
- label: Google
href: https://google.com
- label: Overview
href: index
- label: Quick start
href: quick
left:
- label: Quick start
href: quick
- label: Markdown
href: markdown
items:
- label: Syntax
expanded: true
open: true
items:
- label: Index
href: subfolder/index
- label: Overview
href: subfolder/test
- label: Tables
open: true
items:
- label: Overview
href: subfolder/tables/overview
- label: Examples
href: subfolder/tables/examples
- label: Settings
href: settings
hidden:
- subfolder/tables/multilineВсе страницы генерируются исключительно по описанию их в nav.yaml файлах. Для того, чтобы страницу из навигации, достаточно добавить маршрут в hidden поле.