Keith WilliamsandSyed Ali Shahbaz
be728e9c01
* feat: Add Mintlify docs * Fixed the mint.json for v2 * Fixed versioning issue * Add titles to ICS feed endpoints * Added errors to v1 * Added rate-limit to API v1 * feat: added v1-v2 differences and v1 auth * Trying to eliminate reasons for v1 not showing on publication * Used the swagger openapi validator * remove deprecated v1 endpoints * Moved api docs into new folders without api-reference * Renamed api to api-reference * removed the versioning * Got rid of anchor warnings * Fixed naming * Just as a test - using the same v2 openapi spec for v1 reference * Removed 'externalDocs' from v1 * Removed securitySchemes * Updated the diff between v1/v2 * Added v1 in front of /attendees to test * Moved paths up and removed externalDocs * Testing - Added content to the response * Reduced paths to 1 * Testing: anything at this point * Fixed validation * Moved the other .mdx files to see if that's disrupting something * Trying with a tab * Empty tags array * Added back servers field * Removed all other schemas * Removed v1 for now * Added platform docs * Language fixes * Added v1 back * add API V1 response for attendees * remove unnecessary endpoint docs in API V1 * Removing platform and API for now * Updated v2 openapi doc --------- Co-authored-by: Syed Ali Shahbaz <alishahbaz7@gmail.com>
67 lines
1.7 KiB
Plaintext
67 lines
1.7 KiB
Plaintext
---
|
|
title: 'Navigation'
|
|
description: 'The navigation field in mint.json defines the pages that go in the navigation menu'
|
|
icon: 'map'
|
|
---
|
|
|
|
The navigation menu is the list of links on every website.
|
|
|
|
You will likely update `mint.json` every time you add a new page. Pages do not show up automatically.
|
|
|
|
## Navigation syntax
|
|
|
|
Our navigation syntax is recursive which means you can make nested navigation groups. You don't need to include `.mdx` in page names.
|
|
|
|
<CodeGroup>
|
|
|
|
```json Regular Navigation
|
|
"navigation": [
|
|
{
|
|
"group": "Getting Started",
|
|
"pages": ["quickstart"]
|
|
}
|
|
]
|
|
```
|
|
|
|
```json Nested Navigation
|
|
"navigation": [
|
|
{
|
|
"group": "Getting Started",
|
|
"pages": [
|
|
"quickstart",
|
|
{
|
|
"group": "Nested Reference Pages",
|
|
"pages": ["nested-reference-page"]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
```
|
|
|
|
</CodeGroup>
|
|
|
|
## Folders
|
|
|
|
Simply put your MDX files in folders and update the paths in `mint.json`.
|
|
|
|
For example, to have a page at `https://yoursite.com/your-folder/your-page` you would make a folder called `your-folder` containing an MDX file called `your-page.mdx`.
|
|
|
|
<Warning>
|
|
|
|
You cannot use `api` for the name of a folder unless you nest it inside another folder. Mintlify uses Next.js which reserves the top-level `api` folder for internal server calls. A folder name such as `api-reference` would be accepted.
|
|
|
|
</Warning>
|
|
|
|
```json Navigation With Folder
|
|
"navigation": [
|
|
{
|
|
"group": "Group Name",
|
|
"pages": ["your-folder/your-page"]
|
|
}
|
|
]
|
|
```
|
|
|
|
## Hidden Pages
|
|
|
|
MDX files not included in `mint.json` will not show up in the sidebar but are accessible through the search bar and by linking directly to them.
|