Settings

The settings file is the central configuration hub for your documentation. It's available at root of your project inside the docs.json file.

This configuration file controls the look and feel of your documentation, including navigation, themes, integrations and other.

Reference

This section contains the full reference for the docs.json file:

Environment Variables

Load environment variables from .env files to keep sensitive values out of your code.

Supported files: .env, .env.local, .env.development, .env.production

Usage:

# .env
LS_TRACK_ID=YOUR_TRACK_ID

// docs.json
{
    ...
    "integrations": {
        "analytics": {
            "livesession": {
                "trackId": "$LS_TRACK_ID"
            }
        }
    }
}

JSON Schema Validation

The docs.json file is validated against a JSON schema to ensure proper configuration. You can reference the schema by including:

{
    "$schema": "https://xyd.dev/public/docs.json"
}

Code-Based SettingsComing Soon

If you feel that the JSON configuration is not enough, you can use the TypeScript/React based configuration to have more control and use APIs that are not available in the JSON configuration.

For example, you could define a custom components, adds custom markdown plugins or other customization stuff:

import { Settings } from 'xyd-js';

export default {
    // ... your settings configuration here
} satisfies Settings