> ## Documentation Index
> Fetch the complete documentation index at: https://product-guide-starter-replace-template-content.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# docs.json settings

> Configure your site's name, appearance, navigation, and integrations in docs.json.

`docs.json` is the single configuration file that controls everything about your Mintlify site. It lives at the root of your documentation repository.

## Required fields

Every `docs.json` must include these four fields:

| Field            | Description                                                                                     |
| ---------------- | ----------------------------------------------------------------------------------------------- |
| `name`           | The site name shown in the browser tab and default social previews.                             |
| `theme`          | The visual theme (`mint`, `almond`, `willow`, `sequoia`, and others).                           |
| `colors.primary` | Your brand's primary color as a hex code. Used for links, buttons, and accents.                 |
| `navigation`     | Defines the sidebar structure. See [navigation](/platform/key-concepts#navigation) for details. |

## Appearance

<Tabs>
  <Tab title="Logo and favicon">
    Set `logo.light` and `logo.dark` to paths for your logo images. Mintlify switches between them based on the visitor's color scheme preference.

    ```json theme={null}
    "logo": {
      "light": "/logo/light.svg",
      "dark": "/logo/dark.svg"
    },
    "favicon": "/favicon.ico"
    ```
  </Tab>

  <Tab title="Colors">
    Beyond `colors.primary`, you can set `colors.light` and `colors.dark` for fine-grained control in each mode.

    ```json theme={null}
    "colors": {
      "primary": "#0D9373",
      "light": "#07C983",
      "dark": "#0D9373"
    }
    ```
  </Tab>

  <Tab title="Fonts">
    Override the default font by setting `styling.font`. Mintlify supports Google Fonts by name.

    ```json theme={null}
    "styling": {
      "font": "Inter"
    }
    ```
  </Tab>
</Tabs>

## Site structure

* **`navbar`** — Configure the top navigation bar: links and a primary CTA button.
* **`footer`** — Add social media links displayed at the bottom of every page.
* **`banner`** — Show a site-wide announcement bar with a message and optional link.
* **`redirects`** — Map old URLs to new ones to preserve links when you restructure content.

## API settings

If your docs include an API reference, configure it under `api`:

```json theme={null}
"api": {
  "openapi": "openapi.yaml",
  "playground": {
    "mode": "show"
  }
}
```

Mintlify reads your OpenAPI or AsyncAPI spec and generates interactive playground pages automatically.

## SEO

Set `metadata` fields to control how your site appears in search results and social link previews. The `timestamp` option adds a last-updated date to each page automatically from its Git history.