Configuration Overview

Start Here

Use this minimal config to get started:

{
  "name": "My Documentation",
  "navigation": {
    "tabs": [
      {
        "id": "docs",
        "label": "Documentation",
        "content": ["index"]
      }
    ]
  }
}

This is the minimum required configuration. Everything else is optional.

Main Sections

Full Reference

See the fields you can use in docs.json.

Appearance

Set the theme, colors, logo, and favicon.

Navigation

Set tabs, pages, and site structure.

Navbar

Set the top navigation bar.

Footer

Set footer links and social links.

Search

Change the search prompt text.

Errors

Set the 404 page and error behavior.

Redirects

Add redirects.

Core Fields

name

string

required

Site name.

navigation

object

required

Main navigation structure.

logo

string | object

Logo path, or light and dark logo paths.

colors

object

Brand colors.

navbar

object

Top navigation links and primary button.

footer

object

Footer links and social links.

object

Search prompt text.

errors

object

Not-found behavior.