Global Settings (layout.json)

Every Docsalot site needs a layout.json file with the core configuration settings. Learn more about the properties or from an example

Properties

This section contains the full reference for the layout.json file.

Customizatdion

name

required

string

The name of your project, organization, or product.

colors

required

object

The colors used in your documentation. Colors are applied differently across themes. If you only provide a primary color, it will be used for all color elements.

description

string

Description of your site for SEO and AI indexing.

logo

string or object

Set your logo for both light and dark mode.

favicon

string or object

Path to your favicon file, including the file extension. Automatically resized to appropriate favicon sizes. Can be a single file or separate files for light and dark mode. Example: /favicon.png

thumbnails

object

Thumbnail customization for social media and page previews.

styling

object

Visual styling configurations.

icons

object

Icon library settings.

fonts

object

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

appearance

object

Light/dark mode toggle settings.

background

object

Background color and decoration settings.

Structure

navbar

object

Navigation bar items to external links.

navigation

required

array or object

The navigation structure of your content. Most layout.json files use an array of groups and pages. Advanced configurations can also use an object with nested navigation primitives.

topAnchor

object

Customizes the default documentation tab. When you configure tabs, this default tab appears first and points to your documentation root.

tabs

array of object

Top-level header tabs for major documentation areas. Tabs are useful for separating product docs, guides, API reference, SDKs, or other large sections.

interaction

object

User interaction settings for navigation elements.

metadata

object

Metadata configuration for documentation pages.

footer

object

Footer content and social media links.

banner

object

Site-wide banner displayed at the top of pages.

redirects

array of object

Redirects for moved, renamed, or deleted pages.

contextual

object

Contextual menu for AI-optimized content and integrations.

API Configurations

api

object

API documentation and interactive playground settings.

SEO and search

seo

object

SEO indexing configurations.

object

Search display settings.

Integrations

integrations

object

Third-party integrations.

Errors

errors

object

Error handling settings.

Example `layout.json`

Click on the following dropdown to view a sample configuration file

Example layout.json

{
  "name": "Docsalot",
  "logo": {
    "light": "https://storage.googleapis.com/docsalot/docs-assets/docsalot/logo/light.svg",
    "dark": "https://storage.googleapis.com/docsalot/docs-assets/docsalot/logo/dark.svg"
  },
  "favicon": "https://storage.googleapis.com/docsalot/docs-assets/docsalot/favicon.svg",
  "colors": {
    "primary": "#16A34A",
    "light": "#4ADE80",
    "dark": "#166534"
  },
  "topbarLinks": [
    {
      "name": "Contact Us",
      "url": "mailto:faizank@docsalot.dev"
    }
  ],
  "topbarCtaButton": {
    "name": "Get Started",
    "url": "https://1tc7vihvbit.typeform.com/to/pZJ31XZB"
  },
  "topAnchor": {
    "name": "Home",
    "icon": "house",
    "iconType": "solid"
  },
  "tabs": [
    {
      "name": "API Reference",
      "url": "api-reference",
      "icon": "square-terminal",
      "iconType": "regular"
    }
  ],
  "anchors": [
    {
      "name": "Community",
      "icon": "comments",
      "color": "#2564eb",
      "url": "https://discord.gg/Dp6EpTv4BU"
    }
  ],
  "navigation": [
    {
      "group": "Getting Started",
      "pages": ["introduction", "quickstart"]
    },
    {
      "group": "Settings",
      "pages": ["settings/global", "settings/page"]
    },
    {
      "group": "API Reference",
      "pages": ["api-reference/index", "api-reference/authentication"]
    },
    {
      "group": "Users",
      "pages": ["api-reference/users/list-users", "api-reference/users/create-user"]
    }
  ],
  "footerSocials": {
    "github": "https://github.com/slashml",
    "discord": "https://discord.gg/Dp6EpTv4BU",
    "twitter": "https://twitter.com/faizan10114"
  }
}

​Properties

​Customizatdion

​Structure

​API Configurations

​SEO and search

​Integrations

​Errors

​Example layout.json

On this page

Properties

Customizatdion

Structure

API Configurations

SEO and search

Integrations

Errors

Example `layout.json`