Main Parameters

The Catalog Settings window lets you configure catalog parameters and its appearance. Settings are stored in the repository in the .doc-root.yaml file and are published alongside the articles.

Main

Basic catalog parameters:

  • Catalog Title — displayed on the homepage and in the top left corner above the navigation.

  • Repository Title — displayed in links and in the Storage. Once a new catalog is published to the storage, this parameter cannot be changed. If the catalog was loaded from storage, the parameter is also locked.

  • Directory — the relative path in the repository to the folder where articles will be stored. If left empty, the articles folder is added to the root of the repository. For example, if the repository folder is named some-catalog and you specify resources/docs/v1, all documentation will be stored at some-catalog/resources/docs/v1 and Gramax will read from that path.

  • Main Language — specify if versions in other languages will be added to the catalog.

  • Versions — adds a documentation version switcher on the documentation portal.

  • Article Markup Language — the format used to store articles (e.g., XML). Extended Markdown syntax is used by default. After changing the format and saving, all articles are reformatted automatically; then the changes need to be published.

Appearance

Controls how the catalog is displayed on the homepage:

  • Description — short text shown below the catalog title.

  • Style — the color theme of the catalog tile.

  • Logo for light theme — logo for the light interface theme. Displayed in both themes if no dark theme logo is set. Shown in the top-right corner of the catalog card.

  • Logo for dark theme — logo for the dark interface theme.

The Card preview block immediately shows how the catalog will look in light and dark theme.

To set a logo, click the Logo for light theme or Logo for dark theme field and choose an option:

  • Icons — an icon from the Lucide library, in any color. See the Icons article for details.

  • Emoji — an emoji.

  • Upload — a custom image.

You can also click Choose a random value to pick a logo at random.

Icons

Upload SVG icons that will be available in articles. See the Icons article for details.

Git LFS

Specify file patterns in the Tracked LFS files field to store such files via LFS and keep them out of Git history. See the Git LFS article for details.

Storage Usage

Shows local storage usage. Use cleanup if the local catalog size has grown noticeably or synchronization has slowed down.