Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/jamdesk/jamdesk-cli/llms.txt

Use this file to discover all available pages before exploring further.

Every aspect of your Jamdesk documentation site — themes, navigation structure, branding, analytics integrations, OpenAPI specs, and SEO metadata — is controlled by a single file: docs.json at the root of your project. There is no separate config for the CLI, the hosted site, or the build pipeline; one file drives everything. The schema is validated automatically whenever you run jamdesk dev, jamdesk validate, or jamdesk deploy, so mistakes are caught early with clear error messages.

​
Example: Full docs.json

Below is a representative docs.json covering the most common options. Copy this as a starting point and adjust to fit your project. 
{
  "$schema": "https://www.jamdesk.com/docs.json",
  "name": "My Docs",
  "theme": "jam",
  "colors": {
    "primary": "#6E56CF"
  },
  "logo": {
    "light": "/logo/light.svg",
    "dark": "/logo/dark.svg"
  },
  "navigation": {
    "tabs": [
      {
        "tab": "Documentation",
        "groups": [
          {
            "group": "Get Started",
            "pages": ["introduction", "quickstart"]
          }
        ]
      }
    ]
  }
}

​
Themes

Jamdesk ships three built-in themes, each with its own typographic style and layout personality. Set the active theme with the theme field:
ValueDescription
"jam"Clean and minimal — the default. Great for technical documentation.
"nebula"Modern with softer tones and more visual breathing room.
"pulsar"Bold and high-contrast, suited for product-led docs.
{
  "theme": "nebula"
}
All three themes support light and dark mode and are fully previewed by the local dev server — no deployment needed to see how your site looks. Navigation is structured as a hierarchy: tabs at the top level, groups within each tab, and pages within each group. Pages are referenced by their file path relative to the project root, without the .mdx extension. 
{
  "navigation": {
    "tabs": [
      {
        "tab": "Documentation",
        "groups": [
          {
            "group": "Get Started",
            "pages": ["introduction", "quickstart"]
          },
          {
            "group": "Guides",
            "pages": ["guides/authentication", "guides/webhooks"]
          }
        ]
      },
      {
        "tab": "API Reference",
        "groups": [
          {
            "group": "Endpoints",
            "pages": ["api-reference/overview"]
          }
        ]
      }
    ]
  }
}
jamdesk validate warns you when a page listed in navigation does not have a corresponding .mdx file, so stale references are caught before deployment.

​
Branding

Provide separate logo files for light and dark mode so your brand mark always looks sharp: 
{
  "logo": {
    "light": "/logo/light.svg",
    "dark": "/logo/dark.svg"
  }
}

​
Favicon

{
  "favicon": "/favicon.png"
}

​
Colors

The primary color is used for links, active navigation items, and interactive elements across all themes: 
{
  "colors": {
    "primary": "#6E56CF"
  }
}

​
Spellcheck Configuration

Jamdesk’s built-in spellchecker knows 150+ common tech terms out of the box, but every project has its own product names, acronyms, and jargon. Add project-specific words to the spellcheck.ignore array and they will never be flagged: 
{
  "spellcheck": {
    "ignore": ["YourProduct", "kubectl", "acmecorp"]
  }
}
Your project name from docs.json is automatically added to the ignore list.

​
CLI Defaults

Global CLI preferences live in ~/.jamdeskrc rather than docs.json, because they apply to the developer’s machine rather than the project itself. This file is created the first time you log in and can be edited by hand: 
{
  "defaultPort": 3001,
  "verbose": false,
  "checkUpdates": true
}
FieldDefaultDescription
defaultPort3000Port used by jamdesk dev unless overridden with --port.
verbosefalseEnable verbose output for all commands.
checkUpdatestrueNotify when a newer CLI version is available.

​
Monorepo Support

docs.json works in monorepos without any special configuration. Run jamdesk dev (or any other CLI command) from the directory that contains your docs.json. If your docs live at packages/docs/docs.json, simply cd packages/docs first.

​
Full Reference

The complete list of every supported docs.json field — including analytics integrations, OpenAPI spec paths, custom domains, and footer links — is documented in the docs.json reference.

Build docs developers (and LLMs) love

Get started for freeTalk to us