Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions editor/navigation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,18 @@

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.

To ungroup pages within a group or other navigation element, right-click then click **Ungroup**. All pages within the ungrouped element move to the root level of your navigation.

Check warning on line 22 in editor/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/navigation.mdx#L22

Use 'ungroup(s|ed|ing)?' instead of 'Ungroup'.

<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>

### Auto-generated API pages

When a navigation element references an [OpenAPI specification](/api-playground/openapi-setup#auto-populate-api-pages), the web editor automatically populates the navigation tree with pages for each endpoint in the spec. This lets you preview your full API documentation structure directly in the editor.

Auto-generated pages and their parent groups are locked. You cannot reorder, rename, or delete them through drag-and-drop or context menus. To change the structure of auto-generated API pages, update your OpenAPI specification or your `docs.json` configuration.

Check warning on line 32 in editor/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/navigation.mdx#L32

In general, use active voice instead of passive voice ('are locked').

### Add existing files

Add files from your repository that aren't yet in navigation.
Expand Down Expand Up @@ -73,9 +79,9 @@

### 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.

Check warning on line 82 in editor/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/navigation.mdx#L82

Use 'dropdowns?' instead of 'Dropdowns'.

Dropdowns can contain pages and groups, or link to external URLs.

Check warning on line 84 in editor/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/navigation.mdx#L84

Use 'dropdowns?' instead of 'Dropdowns'.

### When to use menus

Expand Down Expand Up @@ -114,7 +120,7 @@
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.

Check warning on line 123 in editor/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/navigation.mdx#L123

Spell out 'NEW', if it's unfamiliar to the audience.

Check warning on line 123 in editor/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/navigation.mdx#L123

Spell out 'BETA', if it's unfamiliar to the audience.

**Control visibility:**

Expand Down
6 changes: 6 additions & 0 deletions editor/pages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,15 @@
Switch between visual and Markdown mode with the toggle in the toolbar. The web editor saves your changes when switching modes.

<Note>
API specification files (OpenAPI and AsyncAPI) are read-only in the web editor. You can view their contents but cannot edit them directly. To update a spec file, edit it using your preferred code editor and push the changes to your documentation repository.

Check warning on line 31 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L31

In general, use active voice instead of passive voice ('are read').
</Note>

### Auto-generated API pages

When your navigation references an [OpenAPI specification](/api-playground/openapi-setup#auto-populate-api-pages), the web editor generates preview pages for each endpoint directly in the navigation tree. These pages let you see how your API documentation looks without deploying.

Auto-generated API pages are read-only. You can click them to preview their content, but you cannot edit the page content, rename, delete, or reorder them. To customize an auto-generated page, use the [`x-mint` extension](/api-playground/openapi-setup#customize-your-endpoint-pages) in your OpenAPI specification or [create an MDX page](/api-playground/openapi-setup#create-mdx-pages-from-your-openapi-specification) for the endpoint.

Check warning on line 38 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L38

In general, use active voice instead of passive voice ('are read').

<Frame>
<img
src="/images/editor/mode-toggle-light.png"
Expand Down Expand Up @@ -60,7 +66,7 @@
- **Add math equations**: Type <kbd>/inline-math</kbd> for an inline LaTeX equation or <kbd>/block-math</kbd> for a centered block equation. [Enable LaTeX](/editor/configurations) in your site settings first.
- **Add prompt blocks**: Type <kbd>/prompt</kbd> to insert an AI prompt template with copy actions.
- **Edit tables**: When your cursor is inside a table, use the floating toolbar to add or remove rows and columns, or merge cells.
- **Insert links**: Select text and press <kbd>Cmd</kbd> + <kbd>K</kbd>, or drag a page from the navigation tree into the editor to create a link with the page title.

Check warning on line 69 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L69

Did you really mean 'Cmd'?

See [Components](/components) for the complete list of available components.

Expand Down
Loading