Navigation Configuration

Basic Navigation

{
  "navigation": {
    "tabs": [
      {
        "id": "docs",
        "label": "Documentation",
        "content": ["index", "getting-started", "quickstart"]
      }
    ]
  }
}

Group Pages By Task

{
  "navigation": {
    "tabs": [
      {
        "id": "docs",
        "label": "Documentation",
        "icon": "book",
        "content": [
          {
            "title": "Getting Started",
            "icon": "rocket",
            "pages": ["index", "getting-started", "quickstart", "concepts"]
          },
          {
            "title": "Reference",
            "icon": "settings",
            "pages": ["config/index", "config/reference"]
          }
        ]
      }
    ]
  }
}

Enable Multiple Languages

Use navigation.languages to turn on the language switcher:

{
  "navigation": {
    "languages": {
      "default": "en",
      "items": ["en", "fr", "nl", "jp"]
    },
    "tabs": [
      {
        "id": "docs",
        "label": {
          "en": "Docs",
          "fr": "Documentation",
          "nl": "Documentatie",
          "jp": "ドキュメント"
        },
        "content": ["index"]
      }
    ]
  }
}

Translate Navigation Labels

When languages are enabled, labels can be translation maps:

{
  "id": "docs",
  "label": {
    "en": "Docs",
    "fr": "Documentation",
    "nl": "Documentatie",
    "jp": "ドキュメント"
  },
  "content": [
    {
      "title": {
        "en": "Getting Started",
        "fr": "Bien demarrer",
        "nl": "Aan de slag",
        "jp": "はじめに"
      },
      "pages": ["getting-started", "cli"]
    }
  ]
}

Show Pages Only In Some Languages

Add a languages array to a page or group when it should only appear in some languages.

{
  "title": {
    "en": "Regional Setup",
    "fr": "Configuration regionale"
  },
  "languages": ["en", "fr"],
  "pages": ["regional-setup"]
}

Add An External Link

{
  "navigation": {
    "tabs": [
      {
        "id": "docs",
        "label": "Documentation",
        "content": ["index"]
      },
      {
        "type": "link",
        "label": "GitHub",
        "href": "https://github.com/example/repo",
        "icon": "brand-github"
      }
    ]
  }
}

Full Example

{
  "navigation": {
    "languages": {
      "default": "en",
      "items": ["en", "fr", "nl", "jp"]
    },
    "tabs": [
      {
        "id": "docs",
        "label": {
          "en": "Docs",
          "fr": "Documentation",
          "nl": "Documentatie",
          "jp": "ドキュメント"
        },
        "icon": "book",
        "content": [
          {
            "title": {
              "en": "Getting Started",
              "fr": "Bien demarrer",
              "nl": "Aan de slag",
              "jp": "はじめに"
            },
            "icon": "rocket",
            "pages": ["index", "getting-started", "cli", "localization"]
          },
          {
            "title": {
              "en": "Configuration",
              "fr": "Configuration",
              "nl": "Configuratie",
              "jp": "設定"
            },
            "icon": "settings",
            "pages": ["config/index", "config/reference", "config/navigation"]
          }
        ]
      }
    ]
  }
}