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 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. The name of the group. Example: Getting started
The relative paths to the markdown files that will serve as pages. Example: ["index", "quickstart", "development"]
Path to logo image or object with path to “light” and “dark” mode logo images. Path to the logo in light mode. Example: /logo/light.svg
Path to the logo in dark mode. Example: /logo/dark.svg
Where clicking on the logo links to.
Path to the favicon image. Example: /favicon.svg
Hex color codes for your global theme. Clarivo uses:
primary / light: #18E299dark: #0C8C5E The primary color. Used for highlighted content, section headers, and accents in light mode.
The primary color for dark mode.
The primary color for important buttons.
Background color in light and dark mode. Hex color for the background in light mode.
Hex color for the background in dark mode.
Links shown in the top navigation bar. The label of the link. Example: Support
Show Topbar Call to Action
type
"link" or "github"
default: "link"
link shows a button. github shows repo star count.
The URL the button links to. Example: https://app.clarivo.co
Button label. Required when type is link. Example: Dashboard
Array of version names. Use when you need a version dropdown in the navbar.
Anchors shown in the sidebar below the navigation. The anchor label. Example: Website
The URL the anchor links to. Example: https://clarivo.co
Hex color for the anchor icon background. Supports gradients via from/to.
Hide the anchor unless directly linked.
Top-level navigation tabs. Tab label. Example: API reference
The folder prefix for pages in this tab. Example: api-reference
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" ]
Social links shown in the footer. Example: { "linkedin" : "https://linkedin.com/company/clarivo" }
One of: website, facebook, x, discord, slack, github, linkedin, instagram, hacker-news
The URL to the social profile. Example: https://linkedin.com/company/clarivo
Enable feedback buttons on pages. Adds a button for users to suggest edits via pull request.
Adds a button for users to raise a docs issue.
Control dark/light mode behavior. Force a default mode for all users.
Hide the mode toggle entirely.
