Configuration

Overview

Find the settings you need to configure your Shiso site.

Use docs.json to configure your site-wide settings. It controls your site's name and branding, navigation, appearance, search, SEO, and other features. Project-level engine settings — URLs, content location, and locale — live in an optional shiso.config.ts file instead.

The resolved configuration only requires navigation. Start with a small configuration and add other sections when you need them:

{
  "$schema": "./node_modules/@umami/shiso/docs.schema.json",
  "navigation": {
    "groups": [
      {
        "group": "Getting started",
        "pages": ["index", "installation"]
      }
    ]
  }
}

Configuration sections#

The pages below cover every docs.json setting that changes your Shiso site.

Set your branding, edit links, and page feedback.

Organize pages into groups, tabs, and dropdowns.

Choose colors, fonts, light and dark modes, backgrounds, and breadcrumbs.

Header, footer, and banner

Add navbar links, a primary action, announcements, social profiles, and footer links.

Configure site search, Markdown exports, and actions for AI assistants.

Generate endpoint pages, schemas, and code samples from an OpenAPI spec.

Maintain multiple product versions with scoped navigation and search.

Add translations, language selection, locales, and right-to-left layout.

SEO, redirects, and errors

Control indexing and metadata, redirect old URLs, customize the 404 page, and show update dates.

Project settings

Use shiso.config.ts to change the docs URL prefix or content folder, and set your production site URL.

Split configuration

Organize docs.json across reusable JSON files with $ref.

Troubleshooting

Fix missing pages, navigation problems, and invalid configuration values.

Last updated on Sep 8, 2026

PreviousInstallation NextSite details

On this page