Navigation

Configure your documentation structure

Navigation in Jamdesk is configured in your docs.json file using anchors, groups, and pages.

Structure Overview

title="docs.json"
{
  "navigation": {
    "anchors": [
      {
        "anchor": "Docs",
        "icon": "book-open",
        "groups": [
          {
            "group": "Getting Started",
            "pages": ["introduction", "quickstart"]
          }
        ]
      }
    ]
  }
}

Concepts

Anchors

Top-level navigation sections shown in the sidebar header:

{
  "anchor": "API Reference",
  "icon": "code",
  "groups": [...]
}

Icons use the Font Awesome Light variant to maintain a clean, consistent appearance.

Groups

Collapsible sections within an anchor:

{
  "group": "Authentication",
  "pages": ["auth/overview", "auth/tokens"]
}

Pages

Individual documentation pages, referenced by their file path (without .mdx):

"pages": ["introduction", "guides/quickstart", "api/endpoints"]

Multiple Anchors

Create separate sections for different audiences:

{
  "navigation": {
    "anchors": [
      {
        "anchor": "Guides",
        "icon": "book",
        "groups": [
          { "group": "Getting Started", "pages": ["intro", "quickstart"] }
        ]
      },
      {
        "anchor": "API",
        "icon": "code",
        "groups": [
          { "group": "Reference", "pages": ["api/auth", "api/users"] }
        ]
      }
    ]
  }
}

Nested Groups

Organize complex documentation with nested structures:

{
  "group": "SDKs",
  "pages": [
    "sdks/overview",
    {
      "group": "JavaScript",
      "pages": ["sdks/js/install", "sdks/js/usage"]
    },
    {
      "group": "Python",
      "pages": ["sdks/python/install", "sdks/python/usage"]
    }
  ]
}

Was this page helpful?