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

Repository Theme Setting

To set the default theme for the published documents of a repository:

1. In the repository, navigate to Publish Center → API & Documents → Setting
2. Select your preferred theme under Theme:

This setting is shared by all published document versions of the repository, and it applies to every version that doesn’t have a specific theme configured. The default is sequoia.

Version-Specific Theme Configuration

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

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

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

This configuration applies to every version published from a commit that contains it, overriding the repository theme. A version that follows a branch picks up changes to apigit.json with its next update.

To see a theme before publishing, run apigit preview in a clone: it applies the theme of apigit.json, and --theme sequoia|clover stands in for the repository setting, which the local preview does not read.