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

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

Основные

Задаются название каталога и его отображение на главной:

  • Название каталога — отображается в списке каталогов, на карточке и в интерфейсе редактора.

  • Описание — короткий текст в карточке каталога на главной. Может использоваться в поиске по каталогам.

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

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

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

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

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

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

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

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

Репозиторий

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

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

Языки и версии

  • Мультиязычность → Основной язык — указывается, если для каталога будут добавлены версии на других языках. После выбора изменить его в настройках каталога нельзя — только в файле конфигурации.

  • Версионирование → Версии — добавляет переключатель версии документации на портале для чтения. Версии — это ветки или теги, задаются glob-паттернами, например v19.* или release-*.

Библиотека иконок

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

Расширенные

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

  • Переформатировать каталог — приводит все файлы каталога к тому виду, в котором Gramax сохраняет статьи сам. Текст статей не меняется — меняется только разметка, а следующие правки затрагивают в файле только то, что вы исправили. После переформатирования Gramax покажет, какие статьи изменились, а какие не удалось прочитать.

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

Git LFS

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

  • Хранить новые вложения в LFS — изображения, видео и файлы, которые вы добавляете в статьи, сохраняются в Git LFS. Когда опция включена, вместо списка паттернов доступно поле Исключения — маски файлов, которые в LFS не попадают.

  • Автоматически загружать файлы LFS — все файлы LFS загружаются при синхронизации каталога, а не при открытии статьи.

  • Отслеживаемые файлы LFS — паттерны файлов, которые хранятся через LFS, например *.jpg, *.png, *.zip.

Хранилище

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