CodivDocs

CodivDocs is configured via a codiv.config.json file in your repository root.

Minimal example

{
  "name": "My Docs",
  "navigation": [
    {
      "group": "Getting Started",
      "pages": ["docs/introduction"]
    }
  ]
}

Full reference

Field	Type	Required	Description
`name`	`string`	Yes	Your documentation site name
`theme`	`object`	No	Theme customization
`navigation`	`array`	Yes	Sidebar navigation groups
`api`	`object`	No	API playground configuration
`versions`	`string[]`	No	Version labels
`redirects`	`array`	No	URL redirects
`footer`	`object`	No	Footer configuration

Navigation

Navigation is defined as an array of groups:

{
  "navigation": [
    {
      "group": "Group Name",
      "pages": [
        "docs/page-one",
        "docs/page-two",
        {
          "group": "Nested Group",
          "pages": ["docs/nested/page"]
        }
      ]
    }
  ]
}

Page paths are relative to the repo root, without the file extension.

Theme

{
  "theme": {
    "primary": "#ffffff",
    "logo": {
      "light": "/logo-light.svg",
      "dark": "/logo-dark.svg"
    },
    "font": "Geist Sans",
    "codeTheme": "github-dark"
  }
}