The navigation property in docs.json mendefinisikan bagaimana pengguna akan menjelajahi dokumentasi Anda. Anggap ini sebagai cetak biru untuk struktur menu dokumentasi Anda.

Dengan konfigurasi navigasi yang tepat, Anda dapat mengatur konten Anda ke dalam hierarki logis yang memudahkan pengguna untuk menemukan dengan tepat apa yang mereka cari.

​
Pages

Pages adalah komponen navigasi yang paling mendasar.

Pages adalah array di mana setiap entri harus berupa referensi ke path dari page file.

{
  "navigation": {
    "pages": [
      "overview",
      "quickstart",
      "advanced/components",
      "advanced/integrations"
    ]
  }
}

​
Groups

Groups memungkinkan Anda mengelompokkan halaman-halaman Anda. Groups juga dapat disarangkan satu sama lain.

{
  "navigation": {
    "groups": [
      {
        "group": "Getting Started",
        "pages": [
          "quickstart",
          {
            "group": "Editing",
            "pages": [
				"installation",
				"editor",
				{
					"group": "Nested group",
					"pages": [
						"navigation",
						"code"
					]
				}
			]
          }
        ]
      },
      {
        "group": "Writing Content",
        "pages": ["writing-content/page", "writing-content/text"]
      }
    ]
  }
}

​
Tabs

Tabs membantu membedakan antara topik atau bagian yang berbeda dari dokumentasi Anda.

"navigation": {
  "tabs": [
    {
      "tab": "API References",
      "pages": [
        "api-reference/get",
        "api-reference/post",
        "api-reference/delete"
      ]
    },
    {
      "tab": "SDKs",
      "pages": [
        "sdk/fetch",
        "sdk/create",
        "sdk/delete",
      ]
    },
    {
      "tab": "Blog",
      "href": "https://external-link.com/blog"
    }
  ]
}

​
Anchors

Anchors adalah cara lain untuk membagi konten Anda. Mereka muncul di atas navigasi samping Anda.

Konfigurasinya sangat mirip dengan tabs.

Meskipun tidak wajib, kami sangat menyarankan agar Anda juga mengatur bidang icon.

"navigation": {
  "anchors": [
    {
      "anchor": "Documentation",
      "icon": "book-open",
      "pages": [
        "quickstart",
        "development",
        "navigation"
      ]
    },
    {
      "anchor": "API References",
      "icon": "sqaure-terminal",
      "pages": [
        "api-reference/get",
        "api-reference/post",
        "api-reference/delete"
      ]
    },
    {
      "anchor": "Blog",
      "href": "https://external-link.com/blog"
    }
  ]
}

Anchors yang hanya berisi tautan eksternal dapat dicapai menggunakan global keyword:

"navigation": {
  "global":  {
    "anchors": [
      {
         "anchor": "Community",
         "icon": "house",
         "href": "https://slack.com"
      },
      {
         "anchor": "Blog",
         "icon": "pencil",
         "href": "https://mintlify.com/blog"
      }
    ]
  },
  "tabs": [...]
}

Dropdowns muncul di tempat yang sama dengan anchors, tetapi dikonsolidasikan menjadi satu dropdown tunggal.

Meskipun tidak wajib, kami juga menyarankan agar Anda mengatur ikon untuk setiap item dropdown.

"navigation": {
  "dropdowns": [
    {
      "dropdown": "Documentation",
      "icon": "book-open",
      "pages": [
        "quickstart",
        "development",
        "navigation"
      ]
    }
    {
      "dropdown": "API References",
      "icon": "sqaure-terminal",
      "pages": [
        "api-reference/get",
        "api-reference/post",
        "api-reference/delete"
      ]
    }
    {
      "dropdown": "Blog",
      "href": "https://external-link.com/blog"
    }
  ]
}

​
Versions

Versions dapat dimanfaatkan untuk membagi navigasi Anda menjadi versi yang berbeda.

{
  "navigation": {
    "versions": [
      {
        "version": "1.0.0",
        "groups": [
          {
            "group": "Getting Started",
            "pages": ["v1/overview", "v1/quickstart", "v1/development"]
          }
        ]
      },
      {
        "version": "2.0.0",
        "groups": [
          {
            "group": "Getting Started",
            "pages": ["v2/overview", "v2/quickstart", "v2/development"]
          }
        ]
      }
    ]
  }
}

​
Languages

Languages dapat dimanfaatkan untuk membagi navigasi Anda menjadi bahasa yang berbeda.

Anda dapat mengotomatisasi translations dokumentasi Anda ke dalam bahasa yang didukung.

Saat ini kami mendukung bahasa-bahasa berikut:

Arabic (ar)

Chinese (cn)

Chinese (zh-Hant)

English (en)

French (fr)

German (de)

Indonesian (id)

Italian (it)

Japanese (jp)

Korean (ko)

Portuguese (pt)

Portuguese (pt-BR)

Russian (ru)

Spanish (es)

Turkish (tr)

{
  "navigation": {
    "languages": [
      {
        "language": "en",
        "groups": [
          {
            "group": "Getting Started",
            "pages": ["en/overview", "en/quickstart", "en/development"]
          }
        ]
      },
      {
        "language": "es",
        "groups": [
          {
            "group": "Getting Started",
            "pages": ["es/overview", "es/quickstart", "es/development"]
          }
        ]
      }
    ]
  }
}

​
Nesting

Penting untuk dicatat bahwa Anda dapat menggunakan kombinasi apa pun dari anchors, tabs, dan dropdowns - salah satunya dapat disarangkan satu sama lain secara bergantian.

Dengan cara ini, Anda dapat membuat struktur navigasi yang sangat kompleks yang mudah dikelola.

{
  "navigation": {
    "anchors": [
      {
        "anchor": "Anchor 1",
        "groups": [
          {
            "group": "Group 1",
            "pages": [
              "some-folder/file-1",
              "another-folder/file-2"
              "just-a-file"
            ]
          }
        ]
      }
      {
        "anchor": "Anchor 2",
        "groups": [
          {
            "group": "Group 2",
            "pages": [
              "some-other-folder/file-1",
              "various-different-folders/file-2",
              "another-file"
            ]
          }
        ]
      }
    ]
  }
}