Supported Themes

We support two documentation themes: Sequoia and Clover. Each published version can have its own theme configuration.

• Clover Theme: A classic documentation theme featuring a three-part layout consisting of a top navigation header, sidebar, and main content area.
• Sequoia Theme: A modern documentation theme with a streamlined two-part layout including a sidebar and main content area.

Theme Configuration

Global Theme Settings

To set a default theme for all API documents:

1. Navigate to Publish Center → API Documents → Settings
2. Select your preferred default theme

This theme will be applied to all published API document versions that don’t have a specific theme configured. This serves as your global default documentation theme.

Version-Specific Theme Configuration

To override the default theme for a specific published version, create an apigit.json file in your project root and specify the desired theme and layout configuration.

Add a theme field to the JSON configuration, set it as sequoia or clover:

{
    "theme": "sequoia",
    "nav": [
        ...
    ]
}

This configuration will apply only to the specific document version, overriding the global default theme setting.