Settings

docs.json is the single source of truth for how your site looks and what it contains. This page covers the essentials; theme, localization, SEO, and API settings each have their own page.

Site identity

{
  "name": "Acme",
  "description": "Everything you need to build on Acme.",
  "logo": {
    "light": "/logo/light.svg",
    "dark": "/logo/dark.svg"
  }
}

• name is your site's title — used in the header, browser tab, and social cards.
• description is the default meta description.
• logo replaces the text name in the header. Give a light variant, and optionally a dark one; paths are under public/.

Favicons are picked up by convention — drop a favicon.ico, favicon.svg, icon.png, or apple-touch-icon.png into public/ and it's used automatically.

Products

Products are the top-level areas readers switch between. Each id maps to a content/docs/{id}/ folder:

"products": [
  { "id": "platform", "label": "Platform" },
  { "id": "mobile", "label": "Mobile SDK" }
]

The schema

Every field is defined by a JSON schema, so a good editor gives you autocomplete and inline docs. Point docs.json at it and regenerate it any time with the CLI:

{ "$schema": "./docs.config.schema.json" }

npx fiskil schema

Validation

The build refuses to run on an invalid docs.json, so a typo never reaches readers. Check it any time:

npx fiskil validate