Основные параметры

Параметры каталога хранятся в репозитории в файле .doc-root.yaml. Настройки каталога публикуются вместе со статьями.

  • Название каталога — отображается на главной и в левом углу над навигацией.

  • Название репозитория — отображается в cсылках и в Git-хранилище. После публикации нового каталога в хранилище этот параметр изменить нельзя. Если каталог загружен из хранилища — параметр также заблокирован для изменения.

  • Директория — относительный путь в репозитории до папки, в которой будут находиться статьи. Если не заполнять, папка со статьями добавится в корень папки репозитория. Например, папка с репозиторием называется some-catalog. Если указать resources/docs/v1, то вся документация перенесется по пути some-catalog/resources/docs/v1 и Gramax будет читать именно из этой папки.

  • Основной язык — указывается, если для каталога будут добавлены версии на других языках.

  • Версии — добавляет переключатель версии документации на портале для чтения.

  • Отображение на главной — настройки стилей для плашки с каталогом на главной.