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

# Global settings

> Configure site-wide settings in docs.json.

The `docs.json` file lets you turn a collection of Markdown files into a navigable, customized documentation site. This required configuration file controls styling, navigation, integrations, and more. Think of it as the blueprint for your documentation.

Settings in `docs.json` apply globally to all pages.

## Setting up your docs.json

To get started, you only need to specify `theme`, `name`, `colors.primary`, and `navigation`. Other fields are optional and you can add them as your documentation needs grow.

<Tip>
  For the best editing experience, include the schema reference at the top of your `docs.json` file. This enables autocomplete, validation, and helpful tooltips in most code editors.
</Tip>

```json theme={null}
{
  "$schema": "https://mintlify.com/docs.json",
  "theme": "mint",
  "name": "Your Docs",
  "colors": {
    "primary": "#ff0000"
  },
  "navigation": {
    // Your navigation structure
  }
  // The rest of your configuration
}
```

## Customization

### Theme

The layout theme of your site. Choose from: `mint`, `maple`, `palm`, `willow`, `linden`, `almond`, `aspen`, `sequoia`, `luma`.

See the [Themes documentation](/customize/themes) for more information.

### Name

The name of your project, organization, or product.

### Colors

The colors used in your documentation. Colors are applied differently across themes.

<CodeGroup>
  ```json Primary color only theme={null}
  "colors": {
    "primary": "#3B82F6"
  }
  ```

  ```json Multiple colors theme={null}
  "colors": {
    "primary": "#3B82F6",
    "light": "#F8FAFC",
    "dark": "#0F172A"
  }
  ```
</CodeGroup>

<Note>
  All color values must be hex codes beginning with `#`.
</Note>

### Logo

Set your logo for both light and dark mode.

```json theme={null}
"logo": {
  "light": "/logo.png",
  "dark": "/logo-dark.png",
  "href": "https://mintlify.com"
}
```

### Favicon

Path to your favicon file, including the file extension. Automatically resized to appropriate favicon sizes.

```json Single favicon theme={null}
"favicon": "/favicon.png"
```

```json Light and dark favicons theme={null}
"favicon": {
  "light": "/favicon.png",
  "dark": "/favicon-dark.png"
}
```

### Fonts

Set custom fonts for your documentation. The default font varies by theme.

```json theme={null}
"fonts": {
  "family": "Open Sans",
  "weight": 400,
  "heading": {
    "family": "Playfair Display",
    "weight": 700
  },
  "body": {
    "family": "Open Sans",
    "weight": 400
  }
}
```

<Note>
  Supports [Google Fonts](https://fonts.google.com) family names. Google Fonts are loaded automatically when you specify a family name.
</Note>

### Background

Background color and decoration settings.

```json theme={null}
"background": {
  "decoration": "gradient",
  "color": {
    "light": "#ffffff",
    "dark": "#000000"
  },
  "image": {
    "light": "/background.png",
    "dark": "/background-dark.png"
  }
}
```

### Variables

Global variables for use throughout your documentation. Variables are replaced at build time using `{{variableName}}` syntax.

```json theme={null}
"variables": {
  "version": "2.0.0",
  "api-url": "https://api.example.com"
}
```

<Warning>
  All variables referenced in your content must be defined, or the build will fail.
</Warning>

## Navigation

The navigation structure of your content. See [Navigation](/organize/navigation) for detailed information.

```json theme={null}
"navigation": {
  "groups": [
    {
      "group": "Getting started",
      "pages": [
        "index",
        "quickstart"
      ]
    }
  ]
}
```

## Integrations

Third-party integrations for analytics, chat, and more.

### Analytics integrations

<CodeGroup>
  ```json Google Analytics 4 theme={null}
  "integrations": {
    "ga4": {
      "measurementId": "G-XXXXXXXXXX"
    }
  }
  ```

  ```json Mixpanel theme={null}
  "integrations": {
    "mixpanel": {
      "projectToken": "your-project-token"
    }
  }
  ```

  ```json PostHog theme={null}
  "integrations": {
    "posthog": {
      "apiKey": "phc_your-api-key",
      "apiHost": "https://app.posthog.com"
    }
  }
  ```
</CodeGroup>

### Chat integrations

<CodeGroup>
  ```json Intercom theme={null}
  "integrations": {
    "intercom": {
      "appId": "your-app-id"
    }
  }
  ```

  ```json Front Chat theme={null}
  "integrations": {
    "frontchat": {
      "snippetId": "your-snippet-id"
    }
  }
  ```
</CodeGroup>

### Telemetry

```json theme={null}
"integrations": {
  "telemetry": {
    "enabled": true
  }
}
```

<Note>
  When set to `false`, feedback features are also disabled and do not appear on your documentation pages.
</Note>

## SEO and search

### SEO configuration

```json theme={null}
"seo": {
  "indexing": "navigable",
  "metatags": {
    "og:image": "https://example.com/image.png"
  }
}
```

<Tip>
  Choose `navigable` to index only pages in your navigation or `all` to index every page. Defaults to `navigable`.
</Tip>

### Search settings

```json theme={null}
"search": {
  "prompt": "Search documentation..."
}
```

## API configurations

API documentation and interactive playground settings.

```json theme={null}
"api": {
  "openapi": "openapi.json",
  "playground": {
    "display": "interactive"
  },
  "examples": {
    "languages": ["javascript", "python", "curl"]
  }
}
```

See [API Playground](/api-playground/overview) for more information.

## Footer

Footer content and social media links.

```json theme={null}
"footer": {
  "socials": {
    "x": "https://x.com/mintlify",
    "github": "https://github.com/mintlify",
    "linkedin": "https://linkedin.com/company/mintlify"
  },
  "links": [
    {
      "header": "Resources",
      "items": [
        {
          "label": "Blog",
          "href": "https://mintlify.com/blog"
        }
      ]
    }
  ]
}
```

## Navbar

Navigation bar items to external links.

```json theme={null}
"navbar": {
  "links": [
    {
      "type": "github",
      "href": "https://github.com/example/repo"
    },
    {
      "label": "Community",
      "href": "https://example.com/community"
    }
  ],
  "primary": {
    "type": "button",
    "label": "Get Started",
    "href": "https://example.com/start"
  }
}
```

## Metadata

Metadata configuration for documentation pages.

```json theme={null}
"metadata": {
  "timestamp": true
}
```

<Tip>
  Enable the last modified date on all pages. You can override this setting on individual pages with the `timestamp` frontmatter field.
</Tip>

## Banner

Site-wide banner displayed at the top of pages.

```json theme={null}
"banner": {
  "content": "🚀 Banner is live! [Learn more](https://mintlify.com)",
  "dismissible": true
}
```

## Redirects

Redirects for moved, renamed, or deleted pages.

```json theme={null}
"redirects": [
  {
    "source": "/old-page",
    "destination": "/new-page",
    "permanent": true
  }
]
```

## Error handling

404 error page customization.

```json theme={null}
"errors": {
  "404": {
    "redirect": false,
    "title": "Page not found",
    "description": "The page you're looking for doesn't exist."
  }
}
```