Site customization

Customize the look and feel of your docs site.

Update your site's branding, styling, and layout to match your organization's identity. This includes theming elements like color palette, logos, and more.

The SiteCustomizationSettings object

Attributes

titlestring · min: 2 · max: 128Optional

Title to use for the published site. If not defined, it'll fallback to the default content title.

faviconone ofRequired

or

or

objectOptional

updatedAtstring · date-timeOptional

When the customization settings were updated. If missing, customization was not updated.

The SiteCustomizationSettings object

{
  "title": "text",
  "localizedTitle": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "styling": {
    "theme": "clean",
    "primaryColor": {
      "light": "text",
      "dark": "text"
    },
    "tint": {
      "color": {
        "light": "text",
        "dark": "text"
      }
    },
    "infoColor": {
      "light": "text",
      "dark": "text"
    },
    "successColor": {
      "light": "text",
      "dark": "text"
    },
    "warningColor": {
      "light": "text",
      "dark": "text"
    },
    "dangerColor": {
      "light": "text",
      "dark": "text"
    },
    "corners": "straight",
    "depth": "subtle",
    "links": "default",
    "font": "ABCFavorit",
    "headingFont": "ABCFavorit",
    "monospaceFont": "FiraCode",
    "icons": "regular",
    "codeTheme": {
      "default": {
        "light": "default-light",
        "dark": "default-light"
      },
      "openapi": {
        "light": "default-light",
        "dark": "default-light"
      }
    },
    "sidebar": {
      "background": "default",
      "list": "default"
    },
    "search": "prominent"
  },
  "favicon": {
    "icon": {
      "light": "https://example.com",
      "dark": "https://example.com"
    }
  },
  "header": {
    "logo": {
      "light": "https://example.com",
      "dark": "https://example.com"
    },
    "primaryLink": {
      "kind": "file",
      "file": "text",
      "space": "text"
    },
    "links": [
      {
        "title": "text",
        "localizedTitle": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "style": "link",
        "to": {
          "kind": "file",
          "file": "text",
          "space": "text"
        },
        "links": [
          {
            "title": "text",
            "localizedTitle": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "to": {
              "kind": "file",
              "file": "text",
              "space": "text"
            }
          }
        ],
        "condition": "text"
      }
    ]
  },
  "footer": {
    "logo": {
      "light": "https://example.com",
      "dark": "https://example.com"
    },
    "groups": [
      {
        "title": "text",
        "localizedTitle": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "links": [
          {
            "title": "text",
            "localizedTitle": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "to": {
              "kind": "file",
              "file": "text",
              "space": "text"
            }
          }
        ]
      }
    ],
    "copyright": "text"
  },
  "announcement": {
    "enabled": true,
    "message": "text",
    "localizedMessage": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "link": {
      "title": "text",
      "localizedTitle": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "to": {
        "kind": "file",
        "file": "text",
        "space": "text"
      }
    },
    "style": "info"
  },
  "themes": {
    "default": "light",
    "toggeable": true
  },
  "feedback": {
    "enabled": true
  },
  "ai": {
    "mode": "none",
    "greeting": "text",
    "localizedGreeting": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "suggestions": [
      "text"
    ],
    "instructions": "text"
  },
  "advancedCustomization": {
    "enabled": true
  },
  "pageActions": {
    "items": [
      "assistant"
    ]
  },
  "externalLinks": {
    "target": "self"
  },
  "pagination": {
    "enabled": true
  },
  "trademark": {
    "enabled": true
  },
  "privacyPolicy": {
    "url": "https://example.com"
  },
  "socialPreview": {
    "url": "https://example.com"
  },
  "socialAccounts": [
    {
      "platform": "twitter",
      "handle": "text",
      "display": {
        "footer": true,
        "header": false
      }
    }
  ],
  "insights": {
    "trackingCookie": true
  },
  "updatedAt": "2026-01-01T00:00:00.000Z"
}