Add pages to your navigation by listing them in the navigation array.

The values should be the relative path to the page from the root of your project, without the file extension.

Pages are never automatically added to the navigation. You must add them manually. This means you can have "hidden" pages.

navigation is required.

{
  "navigation": [
    "index",
    "quickstart",
    "api/intro"
  ]
}

Configure links

By default the page's frontmatter title value is used as the link text.

You can customise specific links in your navigation by using an object containing the path as well as a custom title.

{
  "navigation": [
    "index",
    {"title": "Quickstart", "path": "quickstart"}
  ]
}

Groups

You can group pages in the navigation by using a group object containing a title and pages array.

The pages array should contain a string or an object with a title and path (just like the root navigation array).

You can nest groups within groups to create a hierarchy of pages.

{
  "navigation": [
    "index",
    {"title": "Quickstart", "path": "quickstart"},
    {
      "title": "API",
      "pages": [
        "api/index",
        {
          "title": "Endpoints",
          "pages": [
            "api/endpoints/create-user",
            "api/endpoints/get-user"
          ]
        }
      ]
    }
  ]
}

This would create the following navigation:

Homepage
Quickstart
API >
  API home
  Endpoints >
    Create User
    Get User