> ## Documentation Index
> Fetch the complete documentation index at: https://docs.clarivo.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Global Settings

> Control the look, feel, and structure of the Clarivo docs using docs.json

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

<ResponseField name="name" type="string" required>
  Name of your project. Used as the global title in the browser tab and navbar.

  Example: `Clarivo`
</ResponseField>

<ResponseField name="navigation" type="Navigation[]" required>
  An array of groups with all the pages within that group.

  <Expandable title="Navigation">
    <ResponseField name="group" type="string">
      The name of the group.

      Example: `Getting started`
    </ResponseField>

    <ResponseField name="pages" type="string[]">
      The relative paths to the markdown files that will serve as pages.

      Example: `["index", "quickstart", "development"]`
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="logo" type="string or object">
  Path to logo image or object with path to "light" and "dark" mode logo images.

  <Expandable title="Logo">
    <ResponseField name="light" type="string">
      Path to the logo in light mode. Example: `/logo/light.svg`
    </ResponseField>

    <ResponseField name="dark" type="string">
      Path to the logo in dark mode. Example: `/logo/dark.svg`
    </ResponseField>

    <ResponseField name="href" type="string" default="/">
      Where clicking on the logo links to.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="favicon" type="string">
  Path to the favicon image. Example: `/favicon.svg`
</ResponseField>

<ResponseField name="colors" type="Colors">
  Hex color codes for your global theme. Clarivo uses:

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

  <Expandable title="Colors">
    <ResponseField name="primary" type="string" required>
      The primary color. Used for highlighted content, section headers, and accents in light mode.
    </ResponseField>

    <ResponseField name="light" type="string">
      The primary color for dark mode.
    </ResponseField>

    <ResponseField name="dark" type="string">
      The primary color for important buttons.
    </ResponseField>

    <ResponseField name="background" type="object">
      Background color in light and dark mode.

      <Expandable title="Object">
        <ResponseField name="light" type="string" required>
          Hex color for the background in light mode.
        </ResponseField>

        <ResponseField name="dark" type="string" required>
          Hex color for the background in dark mode.
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="topbarLinks" type="TopbarLink[]">
  Links shown in the top navigation bar.

  <Expandable title="TopbarLink">
    <ResponseField name="name" type="string">
      The label of the link. Example: `Support`
    </ResponseField>

    <ResponseField name="url" type="string">
      The URL. Example: `mailto:support@clarivo.co`
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="topbarCtaButton" type="Call to Action">
  <Expandable title="Topbar Call to Action">
    <ResponseField name="type" type={'"link" or "github"'} default="link">
      `link` shows a button. `github` shows repo star count.
    </ResponseField>

    <ResponseField name="url" type="string">
      The URL the button links to. Example: `https://app.clarivo.co`
    </ResponseField>

    <ResponseField name="name" type="string">
      Button label. Required when `type` is `link`. Example: `Dashboard`
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="versions" type="string[]">
  Array of version names. Use when you need a version dropdown in the navbar.
</ResponseField>

<ResponseField name="anchors" type="Anchor[]">
  Anchors shown in the sidebar below the navigation.

  <Expandable title="Anchor">
    <ResponseField name="icon" type="string">
      A [Font Awesome](https://fontawesome.com/search) icon name. Example: `globe`
    </ResponseField>

    <ResponseField name="name" type="string">
      The anchor label. Example: `Website`
    </ResponseField>

    <ResponseField name="url" type="string">
      The URL the anchor links to. Example: `https://clarivo.co`
    </ResponseField>

    <ResponseField name="color" type="string">
      Hex color for the anchor icon background. Supports gradients via `from`/`to`.
    </ResponseField>

    <ResponseField name="isDefaultHidden" type="boolean" default="false">
      Hide the anchor unless directly linked.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="tabs" type="Tabs[]">
  Top-level navigation tabs.

  <Expandable title="Tabs">
    <ResponseField name="name" type="string">
      Tab label. Example: `API reference`
    </ResponseField>

    <ResponseField name="url" type="string">
      The folder prefix for pages in this tab. Example: `api-reference`
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="openapi" type="string | string[]">
  Path or URL to your OpenAPI spec file. Clarivo uses:

  ```json theme={null}
  "openapi": "api-reference/openapi.yaml"
  ```

  Supports multiple specs:

  ```json theme={null}
  "openapi": ["api-reference/openapi.yaml", "api-reference/webhooks.yaml"]
  ```
</ResponseField>

<ResponseField name="footerSocials" type="FooterSocials">
  Social links shown in the footer.

  Example:

  ```json theme={null}
  {
    "linkedin": "https://linkedin.com/company/clarivo"
  }
  ```

  <Expandable title="FooterSocials">
    <ResponseField name="[key]" type="string">
      One of: `website`, `facebook`, `x`, `discord`, `slack`, `github`, `linkedin`, `instagram`, `hacker-news`
    </ResponseField>

    <ResponseField name="property" type="string">
      The URL to the social profile. Example: `https://linkedin.com/company/clarivo`
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="feedback" type="Feedback">
  Enable feedback buttons on pages.

  <Expandable title="Feedback">
    <ResponseField name="suggestEdit" type="boolean" default="false">
      Adds a button for users to suggest edits via pull request.
    </ResponseField>

    <ResponseField name="raiseIssue" type="boolean" default="false">
      Adds a button for users to raise a docs issue.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="modeToggle" type="ModeToggle">
  Control dark/light mode behavior.

  <Expandable title="ModeToggle">
    <ResponseField name="default" type={'"light" or "dark"'}>
      Force a default mode for all users.
    </ResponseField>

    <ResponseField name="isHidden" type="boolean" default="false">
      Hide the mode toggle entirely.
    </ResponseField>
  </Expandable>
</ResponseField>