---
title: Configuration
description: Complete archbee.json reference
icon: settings
---

All configuration lives in `archbee.json` at the root of your project. Field names are aligned with the Archbee API and `PublicDocSpaceResponse`.

## Site

| Field | Type | Default | Description |
|-------|------|---------|-------------|
| `name` | string | required | Site name (page title + main space label) |
| `icon` | string | — | Lucide icon for main space in navbar |
| `template` | string | `"stripe"` | `stripe`, `windy`, `colorNav`, or `booklet` |
| `contentLayout` | string | `"two-column"` | `one-column` or `two-column` |
| `publicTheme` | string | `"light"` | Default theme: `light` or `dark` |
| `logoRedirectURL` | string | `"/"` | URL the logo links to |
| `hostingTitle` | string | — | Title shown in browser tab (defaults to `name`) |
| `customFont` | string | — | Google Font name (see below) |

## Logos

```json
"faviconURL": "/public/favicon.ico",
"publicLogoURL": "/public/logo-light.png",
"darkPublicLogoURL": "/public/logo-dark.png"
```

Place assets in the `public/` directory. Paths are relative to your project root.

## Colors

```json
"hostingColor": "#2166AE",
"darkHostingColor": "#2166AE",
"secondaryColor": "#e0eefc",
"darkSecondaryColor": "#14467a"
```

If `secondaryColor` / `darkSecondaryColor` are omitted, they are computed automatically from the accent color.

## Portal customization

All flat at root level — same field names as the Archbee platform:

| Field | Default | Description |
|-------|---------|-------------|
| `showReadTime` | `true` | Show estimated reading time on each doc |
| `showLastUpdate` | `true` | Show last modified date |
| `showThemeSwitcher` | `true` | Show light/dark theme toggle |
| `showDocNavigationButtons` | `true` | Show previous/next buttons at bottom of docs |
| `hasPrimaryColorLinks` | `true` | Use accent color for links instead of default blue |
| `isArchbeeBrandVisible` | `true` | Show "Powered by Archbee" in navigation |
| `isPublicBackgroundEnabled` | `true` | Enable portal background pattern |
| `showFullTitleInLeftNavDocsTree` | `false` | Show full doc titles in left nav instead of truncated |

## Navigation

The main space lives at root level with `docsPath` + `structure.docsTree`. Additional spaces go in `sites[]`. This mirrors the API's `git-config-schema.ts`.

```json
"docsPath": "guides",
"structure": {
  "docsTree": [
    { "path": "index", "name": "Introduction", "icon": "house" },
    {
      "isCategory": true,
      "categoryName": "Getting Started",
      "children": [
        { "path": "quickstart", "name": "Quickstart" }
      ]
    }
  ]
},
"sites": [
  {
    "name": "Changelog",
    "docsPath": "changelog",
    "icon": "newspaper",
    "structure": {
      "docsTree": [
        { "path": "march-2026", "name": "March 2026" }
      ]
    }
  }
]
```

See [Navigation](/essentials/navigation) for details on doc tree items.

## External links

Links displayed in the top navbar header:

```json
"externalLinks": [
  { "label": "Book a Demo", "url": "https://archbee.com/demo" },
  { "label": "Sign Up", "url": "https://app.archbee.com", "isPrimary": true }
]
```

## Custom content

| Field | Description |
|-------|-------------|
| `footerTemplate` | Custom footer HTML |
| `customCSS` | CSS wrapped in `<style>` tags |
| `customJS` | JavaScript wrapped in `<script>` tags |
| `headerIncludes` | HTML to add to `<head>` |
| `custom404` | Custom 404 page content |

Include the appropriate wrapper tags:

```json
"footerTemplate": "<footer><p>Copyright 2026 My Company</p></footer>",
"customCSS": "<style>.sidebar { background: #f0f0f0; }</style>",
"customJS": "<script>console.log('loaded')</script>",
"headerIncludes": "<meta name='author' content='My Company'>",
"custom404": "<h1>Page not found</h1>"
```

## Full example

```json
{
  "name": "My Docs",
  "template": "stripe",
  "contentLayout": "two-column",
  "publicTheme": "light",

  "faviconURL": "/public/favicon.ico",
  "publicLogoURL": "/public/logo-light.png",
  "darkPublicLogoURL": "/public/logo-dark.png",

  "hostingColor": "#2166AE",
  "darkHostingColor": "#2166AE",

  "docsPath": "guides",
  "structure": {
    "docsTree": [
      { "path": "index", "name": "Home", "icon": "house" },
      { "path": "quickstart", "name": "Quickstart", "icon": "rocket" }
    ]
  }
}
```
