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
5 changes: 5 additions & 0 deletions editor/navigation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

To add a navigation element nested inside another element, click the **+** button next to the name of the parent element.

After creating an element, drag and drop it to reorder or nest it within other elements. Right-click any element to configure its properties, duplicate it, hide it from navigation, or delete it.

Check warning on line 20 in editor/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/navigation.mdx#L20

Use the Oxford comma in 'After creating an element, drag and'.

<Note>
Some elements cannot nest inside other elements. For example, tabs cannot nest inside groups. The web editor prevents you from nesting invalid elements.
Expand All @@ -33,6 +33,11 @@

Pages can exist at the root level, within groups, tabs, anchors, dropdowns, or menus.

**Files in navigation vs unused files:**

- **Files in navigation**: Appear in your site's sidebar and are visible to users on your published site.
- **Unused files**: Exist in your repository but aren't included in navigation. These files don't appear on your published site until you add them to navigation. Find unused files in the **Unused Pages** section at the bottom of the navigation panel.

### 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.
Expand Down Expand Up @@ -98,7 +103,7 @@
1. Right-click a navigation item.
1. Click **Configure**.
1. Click the tag field.
1. Enter a tag like "NEW" or "BETA" that highlights important items.

Check warning on line 106 in editor/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/navigation.mdx#L106

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

Check warning on line 106 in editor/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/navigation.mdx#L106

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

**Control visibility:**

Expand Down
50 changes: 50 additions & 0 deletions editor/pages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,36 @@
- Click files to open them in the editor.
- Click the search icon or press <kbd>Cmd</kbd> + <kbd>P</kbd> (macOS) or <kbd>Ctrl</kbd> + <kbd>P</kbd> (Windows) to search for files by name.

### View unused pages

The **Unused Pages** section at the bottom of the navigation panel shows files that exist in your repository but aren't included in your navigation. These files won't appear on your published site until you add them to navigation.

- Click the search icon to search for specific unused files.
- Click a file to preview it in the editor.
- Click **Add** to create new pages or folders in the unused pages section.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor: keep Unused Pages capitalization consistent.

Suggested change
- Click **Add** to create new pages or folders in the unused pages section.
- Click **Add** to create new pages or folders in the **Unused Pages** section.


## Create new pages

1. Click the **+** button in the navigation element where you want to add a page.
1. Click **Add a page**.
1. Enter a file name. The editor adds the `.mdx` extension automatically.

Check warning on line 27 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L27

Use 'filename' instead of 'file name'.

### Add existing files to navigation

Add files from the **Unused Pages** section to your navigation to make them visible on your site.

**Using drag and drop:**

1. Find the file in the **Unused Pages** section.
1. Drag the file to your desired location in the navigation tree.
1. Drop it where you want it to appear.

**Using the menu:**

1. Click the **+** button next to the navigation element where you want to add the file.
1. Click **Add existing file**.
1. Search for and select the file you want to add.

## Edit content

Switch between visual and Markdown mode with the toggle in the toolbar. The web editor saves your changes when switching modes.
Expand All @@ -35,7 +59,7 @@
- **Format text**: Use the toolbar to bold, italicize, or apply other formatting to text.
- **Add components**: Press <kbd>/</kbd> to open the component menu and select components.
- **Add images**: Use the image component from the <kbd>/</kbd> menu.
- **Insert links**: Select text and press <kbd>Cmd</kbd> + <kbd>K</kbd>.

Check warning on line 62 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L62

Did you really mean 'Cmd'?

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

Expand All @@ -45,7 +69,7 @@

- **Direct MDX editing**: Write MDX and Markdown syntax for precise control over content.
- **Component properties**: Set component properties and configurations.
- **Frontmatter**: Edit page metadata at the top of the file.

Check warning on line 72 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L72

Use 'frontmatter' instead of 'Frontmatter'.

See [Format text](/create/text) and [Format code](/create/code) for more information on MDX syntax.

Expand All @@ -69,7 +93,7 @@

Help users find your page and improve how it appears when shared.

- **Description**: Write a brief summary. Appears in search results and SEO meta tags.

Check warning on line 96 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L96

Spell out 'SEO', if it's unfamiliar to the audience.
- **Keywords**: Add relevant search terms to help users discover this page.
- **OG Image URL**: Set a custom preview image for social media shares and link previews.

Expand All @@ -84,6 +108,32 @@

## Move pages

To move pages in your navigation, drag and drop them to your desired location.

Check warning on line 111 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L111

Use the Oxford comma in 'To move pages in your navigation, drag and'.

To duplicate or delete pages, right-click the page and select the desired action.

## Manage unused files

Files in the **Unused Pages** section exist in your repository but don't appear in navigation or on your published site.

### Configure unused files

1. Right-click a file in the **Unused Pages** section.
1. Click **Configure**.
1. Edit the file's settings like title, description, and other metadata.

### Remove files from navigation

Hide a page from your published site without deleting it from your repository.

1. Right-click a page in your navigation.
1. Click **Hide Page**.

The page moves to the **Unused Pages** section and won't appear on your site. You can add it back to navigation later using drag and drop or the **Add existing file** menu.

### Delete unused files

1. Right-click a file in the **Unused Pages** section.
1. Click **Delete**.

This permanently removes the file from your repository.