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

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

Основные

Задаются базовые параметры каталога:

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

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

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

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

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

  • Язык разметки статей — формат хранения статей (например, XML). По умолчанию используется расширенный синтаксис Markdown. После смены формата и сохранения все статьи будут отформатированы автоматически, затем изменения нужно опубликовать.

Внешний вид

Настраивается отображение каталога на главной:

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

  • Стиль — цветовая тема плашки каталога.

  • Логотип для светлой темы — логотип для светлой темы интерфейса. Отображается в обеих темах, если нет логотипа для темной. Выводится в правом верхнем углу карточки каталога.

  • Логотип для темной темы — логотип для темной темы интерфейса.

В блоке Предпросмотр карточки сразу видно, как каталог будет выглядеть для светлой и темной темы.

Чтобы задать логотип, кликните поле Логотип для светлой темы или Логотип для темной темы и выберите вариант:

  • Иконки — иконка из библиотеки Lucide в любом цвете. Подробнее в статье.

  • Эмодзи — эмодзи.

  • Загрузить — собственное изображение.

Также можно нажать кнопку Выбрать случайное значение — она подберет логотип случайным образом.

Иконки

Загружаются SVG-иконки, которые будут доступны в статьях. Подробнее в статье Иконки.

Git LFS

Указываются паттерны файлов в поле Отслеживаемые файлы LFS, чтобы такие файлы хранились через LFS и не увеличивали размер Git-истории. Подробнее в статье Git LFS.

Память

Отображается локальное использование хранилища. Используйте очистку, если локальный размер каталога заметно вырос или синхронизация стала медленнее.