Skip to content
Merged
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
1 change: 1 addition & 0 deletions editor/keyboard-shortcuts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@
| **Add link** to selected text | <kbd>Cmd</kbd> + <kbd>K</kbd> | <kbd>Ctrl</kbd> + <kbd>K</kbd> |
| **Add line break** | <kbd>Cmd</kbd> + <kbd>Enter</kbd> | <kbd>Ctrl</kbd> + <kbd>Enter</kbd> |
| **Component menu** | <kbd>/</kbd> | <kbd>/</kbd> |
| **Emoji picker** | <kbd>:</kbd> + keyword | <kbd>:</kbd> + keyword |

### Smart substitutions

Expand Down Expand Up @@ -92,6 +93,6 @@

| Command | macOS | Windows |
| :--- | :--- | :--- |
| **Add cursor** | <kbd>Option</kbd> + Click | <kbd>Alt</kbd> + Click |

Check warning on line 96 in editor/keyboard-shortcuts.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/keyboard-shortcuts.mdx#L96

Use 'Cursor' instead of 'cursor'.
| **Add cursor above** | <kbd>Cmd</kbd> + <kbd>Option</kbd> + <kbd>↑</kbd> | <kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>↑</kbd> |

Check warning on line 97 in editor/keyboard-shortcuts.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/keyboard-shortcuts.mdx#L97

Use 'Cursor' instead of 'cursor'.

Check warning on line 97 in editor/keyboard-shortcuts.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/keyboard-shortcuts.mdx#L97

Use 'preceding' instead of 'above'.
| **Add cursor below** | <kbd>Cmd</kbd> + <kbd>Option</kbd> + <kbd>↓</kbd> | <kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>↓</kbd> |

Check warning on line 98 in editor/keyboard-shortcuts.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/keyboard-shortcuts.mdx#L98

Use 'Cursor' instead of 'cursor'.
1 change: 1 addition & 0 deletions editor/pages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
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>

<Frame>
Expand All @@ -55,11 +55,12 @@
- **Add images**: Use the image component from the <kbd>/</kbd> menu or type <kbd>/image</kbd>.
- **Add videos**: Type <kbd>/video</kbd> to upload or select a video.
- **Add embedded content**: Type <kbd>/youtube</kbd> or <kbd>/loom</kbd> to embed videos, or <kbd>/embed</kbd> for custom HTML. See [Add media](/editor/media) for details.
- **Add Mermaid diagrams**: Type <kbd>/mermaid</kbd> to insert a Mermaid diagram with an interactive preview, zoom/pan controls, and code editor.

Check warning on line 58 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L58

Use 'Mermaid' instead of 'mermaid'.
- **Add snippets**: Type <kbd>/snippet</kbd> to search for and insert a reusable snippet. The editor adds the required import statement automatically.
- **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.

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

Use 'Cursor' instead of 'cursor'.
- **Insert emojis**: Type <kbd>:</kbd> followed by a keyword to open the emoji picker. Use arrow keys to navigate the grid and press <kbd>Enter</kbd> to insert the selected emoji. The picker searches emoji names, tags, and shortcodes.

Check warning on line 63 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L63

Did you really mean 'shortcodes'?
- **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.

See [Components](/components) for the complete list of available components.
Expand Down Expand Up @@ -99,7 +100,7 @@

- **Title**: Set the main heading. Appears in navigation, browser tabs, and search results.
- **Slug**: Set the URL path for the page. The slug defaults to the path relative to your repository root without the file extension. For example, `guides/getting-started.mdx` becomes `guides/getting-started`. Changing the slug renames and moves the file to match the new path.
- **Sidebar title**: Display shorter text in navigation when the full title is too long for the sidebar.

Check warning on line 103 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L103

Use 'sidebars?' instead of 'Sidebar'.
- **Icon**: Add a visual marker next to the page to help users identify it quickly.
- **External URL**: Link to an external site instead of a page. Use this to add external resources to your navigation.

Expand Down
Loading