Global Settings

Every docs site needs a docs.json file at the root. This file controls the name, colors, navigation, logo, and more. Below is a reference for all supported properties.

Properties

string

required

Name of your project. Used as the global title in the browser tab and navbar.Example: Clarivo

An array of groups with all the pages within that group.

Show Navigation

string

The name of the group.Example: Getting started

string[]

The relative paths to the markdown files that will serve as pages.Example: ["index", "quickstart", "development"]

string or object

Path to logo image or object with path to “light” and “dark” mode logo images.

Show Logo

string

Path to the logo in light mode. Example: /logo/light.svg

string

Path to the logo in dark mode. Example: /logo/dark.svg

string

default:"/"

Where clicking on the logo links to.

string

Path to the favicon image. Example: /favicon.svg

Colors

Hex color codes for your global theme. Clarivo uses:

primary / light: #18E299
dark: #0C8C5E

Show Colors

string

required

The primary color. Used for highlighted content, section headers, and accents in light mode.

string

The primary color for dark mode.

string

The primary color for important buttons.

object

Background color in light and dark mode.

Show Object

string

required

Hex color for the background in light mode.

string

required

Hex color for the background in dark mode.

TopbarLink[]

Links shown in the top navigation bar.

Show TopbarLink

string

The label of the link. Example: Support

string

The URL. Example: mailto:[email protected]

Call to Action

Show Topbar Call to Action

"link" or "github"

default:"link"

link shows a button. github shows repo star count.

string

The URL the button links to. Example: https://app.clarivo.co

string

Button label. Required when type is link. Example: Dashboard

string[]

Array of version names. Use when you need a version dropdown in the navbar.

Anchor[]

Anchors shown in the sidebar below the navigation.

Show Anchor

string

A Font Awesome icon name. Example: globe

string

The anchor label. Example: Website

string

The URL the anchor links to. Example: https://clarivo.co

string

Hex color for the anchor icon background. Supports gradients via from/to.

boolean

default:"false"

Hide the anchor unless directly linked.

Tabs[]

Top-level navigation tabs.

Show Tabs

string

Tab label. Example: API reference

string

The folder prefix for pages in this tab. Example: api-reference

string | string[]

Path or URL to your OpenAPI spec file. Clarivo uses:

"openapi": "api-reference/openapi.yaml"

Supports multiple specs:

"openapi": ["api-reference/openapi.yaml", "api-reference/webhooks.yaml"]

FooterSocials

Social links shown in the footer.Example:

{
  "linkedin": "https://linkedin.com/company/clarivo"
}

Show FooterSocials

string

One of: website, facebook, x, discord, slack, github, linkedin, instagram, hacker-news

string

The URL to the social profile. Example: https://linkedin.com/company/clarivo

Feedback

Enable feedback buttons on pages.

Show Feedback

boolean

default:"false"

Adds a button for users to suggest edits via pull request.

boolean

default:"false"

Adds a button for users to raise a docs issue.

ModeToggle

Control dark/light mode behavior.

Show ModeToggle

"light" or "dark"

Force a default mode for all users.

boolean

default:"false"

Hide the mode toggle entirely.

Getting started

Customization

Writing content

AI tools

Global Settings

Properties

​Properties

Properties