Skip to content

Note media file preview in editor file tree #5708

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
mintlify wants to merge 1 commit into from
+1 −1
Closed

Note media file preview in editor file tree #5708

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion editor/pages.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

## Navigate files

Browse pages in the **Navigation** tab of the left panel. Click a page to open it. Click the search icon or press <kbd>Cmd</kbd> + <kbd>K</kbd> (macOS) or <kbd>Ctrl</kbd> + <kbd>K</kbd> (Windows) to search by filename or page content.
Browse pages in the **Navigation** tab of the left panel. Click a page to open it. Click an image or video file to preview it inline. Click the search icon or press <kbd>Cmd</kbd> + <kbd>K</kbd> (macOS) or <kbd>Ctrl</kbd> + <kbd>K</kbd> (Windows) to search by filename or page content.

<Note>
The web editor treats API specification files (OpenAPI and AsyncAPI) as read-only. To update a spec file, edit it in your preferred code editor and push the changes to your documentation repository.
Expand All @@ -31,7 +31,7 @@

- **Insert a link**: Select text and press <kbd>Cmd</kbd> + <kbd>K</kbd> (macOS) or <kbd>Ctrl</kbd> + <kbd>K</kbd> (Windows), or drag a page from the navigation tree into the editor to create a link with the page title.
- **Insert an emoji**: Type <kbd>:</kbd> followed by a keyword to open the emoji picker.
- **Edit a table**: 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 34 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L34 

Use 'Cursor' instead of 'cursor'.

**Markdown mode** gives you direct access to the MDX source. Use it for precise control over component properties and frontmatter.

Expand All @@ -56,7 +56,7 @@

### Table of contents

In visual mode, the editor shows a minimap on the right side of the page that reflects the heading structure of your document. Hover over the minimap to expand it into a full table of contents. Click any heading to scroll to that section.

Check warning on line 59 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L59 

Did you really mean 'minimap'?

Check warning on line 59 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L59 

Did you really mean 'minimap'?

### Code block options

Expand All @@ -69,9 +69,9 @@

## Review changes before publishing

Open the publish menu and click any changed file to enter diff view. The editor highlights differences between your draft and the last published version. If you're in visual mode, you see a visual diff; if you're in Markdown mode, you see a Markdown diff.

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 semicolons judiciously.

Diff view is read-only. Click the <Icon icon="x" /> button next to the mode toggle to return to editing.

Check warning on line 74 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L74 

Use 'diffs?' instead of 'Diff'.

Check warning on line 74 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L74 

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

## Manage pages

Expand All @@ -88,7 +88,7 @@

Hover over a page and click the gear icon, or right-click and select **Settings**, to configure:

- **Title**, **Slug**, and **Sidebar title**: Control how the page appears in navigation and its URL.

Check warning on line 91 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L91 

Use 'sidebars?' instead of 'Sidebar'.
- **Description** and **Keywords**: Improve search and SEO.
- **Layout**: Choose from standard, wide, centered, or custom.

Expand All @@ -100,7 +100,7 @@

Type <kbd>/image</kbd> to upload a new image or select an existing one from your repository. Type <kbd>/video</kbd> to upload or select a video.

You can also drag and drop files from your computer directly onto a page. In visual mode, the file inserts inline. In Markdown mode, the editor inserts the file path at your cursor position. Images save to your `images/` folder and videos to `videos/`.

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 'Cursor' instead of 'cursor'.

### Light and dark image variants

Expand Down
Loading