Skip to main content

Configuration Reference

docs.config.json lives in the root of your member repo and is the only configuration file you need.

VS Code (and most editors) autocomplete and validate it automatically using the $schema field — no extensions or package installation required.

Full example​

{
    "$schema": "https://docs.trickfirerobotics.com/docs.config.schema.json",
    "name": "TrickFire CAN",
    "description": "CAN bus driver and protocol library for TrickFire robots.",
    "sidebar": [
        { "label": "Getting Started", "slug": "getting-started" },
        {
            "label": "Reference",
            "items": [
                { "label": "API", "slug": "reference/api" },
                { "label": "FAQ", "slug": "reference/faq" }
            ]
        }
    ],
    "social": [
        {
            "icon": "github",
            "label": "GitHub",
            "href": "https://github.com/TrickfireRobotics/trickfire-can"
        }
    ]
}

Fields​

name (required)​

Display name for your project. Shown in the navbar Projects dropdown and in the site's landing page cards.

description (required)​

One-line description of the project. Shown on the docs homepage card for your project.

Explicit sidebar definition. When omitted, Docusaurus autogenerates the sidebar from your docs/ file structure.

See Sidebar Configuration for full documentation.

Each item is either a doc link or a group:

Doc link:

{ "label": "Getting Started", "slug": "getting-started" }

External link:

{ "label": "GitHub", "link": "https://github.com/TrickfireRobotics" }

Group:

{
    "label": "Reference",
    "collapsed": false,
    "items": [{ "label": "API", "slug": "reference/api" }]
}

social (optional)​

Extra nav links appended after the built-in GitHub / Notion / TrickFire links.

"social": [
    { "icon": "github",   "label": "GitHub", "href": "https://github.com/..." },
    { "icon": "external", "label": "Notion", "href": "https://notion.so/..." }
]

icon accepts "github" or "external".

advanced (optional)​

Pass-through options merged into the Docusaurus plugin config for this project. Use this to enable Docusaurus features not exposed by docs.config.json.

"advanced": {
    "docusaurus": {
        "showLastUpdateTime": true,
        "editUrl": "https://github.com/TrickfireRobotics/my-repo/edit/main/"
    }
}

JSON Schema​

The full schema is published at:

https://docs.trickfirerobotics.com/docs.config.schema.json

Referencing it via $schema gives you field descriptions, allowed values, and required-field errors directly in your editor.