Files
mintlify__docs/editor/navigation.mdx
Ethan Palm 0f3871159a Editor UI changes (#3466)
* remove preview deployments

* update configuration image

* remove live preview

* update media page

* Revert "remove live preview"

This reverts commit 7f84b744b8.

* Revert "remove preview deployments"

This reverts commit da80ef4754.

* update navigation images

* Update pages.mdx

* update collaborate page with new preview UI

* update publish images

* Update index.mdx

* update live preview image
2026-02-13 16:47:49 -08:00

123 lines
5.4 KiB
Plaintext

---
title: "Organize navigation"
description: "Organize your documentation structure with the visual navigation editor."
keywords: ["editor", "navigation", "sidebar", "structure"]
---
Use the navigation sidebar to organize your documentation. Changes you make in the web editor's navigation tree appear in your site's navigation sidebar and sync to your `docs.json` configuration file.
## Add navigation elements
To add a new navigation element, click **Add new** at the bottom of the navigation tree.
<Frame>
<img src="/images/editor/navigation-light.png" alt="Add new navigation element." className="block dark:hidden" />
<img src="/images/editor/navigation-dark.png" alt="Add new navigation element." className="hidden dark:block" />
</Frame>
To add a navigation element nested inside another element, click the <Icon icon="plus" /> plus button next to the name of the top-level element.
After you create an element, drag-and-drop it to reorder or nest it within other elements. Hover over an element then click the gear icon to configure its properties, or right-click an element to access additional options like duplicate, convert to another element, or delete.
<Note>
Some elements cannot nest inside other elements. For example, tabs cannot nest inside groups. The web editor prevents you from nesting invalid elements.
</Note>
### Add existing files
Add files from your repository that aren't yet in navigation.
1. Click the <Icon icon="plus" /> plus button on the navigation element that you want to add the file to.
1. Click **Add existing file** in the dropdown menu.
<Frame>
<img src="/images/editor/add-existing-file-menu-light.png" alt="Add existing file menu expanded." className="block dark:hidden" />
<img src="/images/editor/add-existing-file-menu-dark.png" alt="Add existing file menu expandeda." className="hidden dark:block" />
</Frame>
## Organize into sections
Choose the right navigation structure for your documentation's scope and audience.
### When to use pages
Use pages for individual documentation files. Pages are the core building blocks of your navigation—every piece of content lives on a page. Add pages to your navigation to make them visible in your site's sidebar.
Pages can exist at the root level, within groups, tabs, anchors, dropdowns, or menus.
Files not included in your navigation are [hidden](/organize/hidden-pages) from your published documentation.
### When to use groups
Use groups to organize related pages into collapsible sections. Groups help users scan your navigation by clustering similar content together, like grouping all authentication-related pages or all API endpoint references.
Groups can nest within other groups to create a hierarchical organization. Groups can exist within tabs, anchors, dropdowns, or at the root level.
### When to use tabs
Use tabs to create separate top-level sections with horizontal navigation at the top of your site. Tabs work well when you have distinct areas like API Reference, Guides, and SDKs that users need to switch between.
Tabs can contain pages, groups, and menu items. Configure tabs to add icons or link to external resources.
### When to use anchors
Use anchors to create persistent navigation items at the top of your sidebar. Anchors help when you want to section your content or provide quick access to external resources without switching tabs.
Anchors can contain pages and groups, or link to external URLs.
**Global anchors:**
Create global anchors that appear on all pages regardless of which section users are viewing. Global anchors must link to external URLs and are useful for resources like blogs, status pages, or support links.
### When to use dropdowns
Use dropdowns to create an expandable menu at the top of your sidebar. Dropdowns work well when you have multiple related sections that users might want to explore but don't need constant visibility like tabs.
Dropdowns can contain pages and groups, or link to external URLs.
### When to use menus
Use menus to add dropdown navigation items within a tab. Menus help users navigate directly to specific pages from the top navigation bar.
Menus can contain pages and groups.
### When to use products
Use products when you have multiple distinct product offerings that each need their own documentation. Products create a switcher menu that lets users navigate between different product documentation sets.
Each product can have its own navigation structure with tabs, pages, and groups.
### When to use versions
Use versions when you maintain multiple versions of your documentation simultaneously, like v1.0, v2.0, and v3.0 of an API. Versions create a switcher menu that lets users select which version they want to view.
Each version can have different content and navigation structure.
### When to use languages
Use languages when you provide documentation in multiple languages. Languages create a switcher menu that lets users view documentation in their preferred language.
Each language maintains the same navigation structure with translated content.
## Customize appearance
**Add icons:**
1. Hover over a navigation item.
2. Click the gear icon.
3. Click the icon field.
**Add tags:**
1. Hover over a navigation item.
1. Click the gear icon.
1. Click the tag field.
1. Enter a tag like "NEW" or "BETA" that highlights important items.
**Control visibility:**
Hide the content within a navigation element without deleting it from your repository.
1. Right-click any item.
1. Click the toggle by the **Hide** label.