Navegação

O menu de navegação é a lista de links em todo site.

Você provavelmente atualizará o docs.json toda vez que adicionar uma nova página. As páginas não aparecem automaticamente.

Sintaxe de navegação

Nossa sintaxe de navegação é recursiva, o que significa que você pode criar grupos de navegação aninhados. Você não precisa incluir .mdx nos nomes das páginas.

"navigation": {
  "tabs": [
    {
      "tab": "Docs",
      "groups": [
        {
          "group": "Getting Started",
          "pages": ["quickstart"]
        }
      ]
    }
  ]
}

"navigation": {
  "tabs": [
    {
      "tab": "Docs",
      "groups": [
        {
          "group": "Getting Started",
          "pages": [
            "quickstart",
            {
              "group": "Nested Reference Pages",
              "pages": ["nested-reference-page"]
            }
          ]
        }
      ]
    }
  ]
}

Pastas

Simplesmente coloque seus arquivos MDX em pastas e atualize os caminhos no docs.json.

Por exemplo, para ter uma página em https://yoursite.com/your-folder/your-page, você criaria uma pasta chamada your-folder contendo um arquivo MDX chamado your-page.mdx.

aviso

Você não pode usar api para o nome de uma pasta, a menos que a aninhe dentro de outra pasta. O Mintlify usa o Next.js, que reserva a pasta de nível superior api para chamadas internas do servidor. Um nome de pasta como api-reference seria aceito.

"navigation": {
  "tabs": [
    {
      "tab": "Docs",
      "groups": [
        {
          "group": "Group Name",
          "pages": ["your-folder/your-page"]
        }
      ]
    }
  ]
}

Páginas ocultas

Arquivos MDX não incluídos no docs.json não aparecerão na barra lateral, mas são acessíveis através da barra de pesquisa e por links diretos a eles.