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
50 changes: 50 additions & 0 deletions editor.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,56 @@

Press <kbd>Command</kbd> + <kbd>P</kbd> on macOS or <kbd>Ctrl</kbd> + <kbd>P</kbd> on Windows to search for files by name.

### Manage images and media

The visual editor includes an Images and Media view that lets you browse, preview, and manage all image and video assets in your documentation.

#### Access the Images and Media view

Select **Images and Media** from the sidebar navigation to open the asset manager.

<Frame>
<img
src="/images/editor/images-media-light.png"
className="block dark:hidden"
alt="Images and Media view in the visual editor"
/>

<img
src="/images/editor/images-media-dark.png"
className="hidden dark:block"
alt="Images and Media view in the visual editor in dark mode"
/>
</Frame>

#### View modes

The asset manager provides two ways to view your media files:

**Tree view**: Browse assets organized by folder structure. This view is ideal for navigating large collections of assets and understanding how your media files are organized.

**Gallery view**: See thumbnail previews of all images in a scrollable gallery grouped by folder. This view is ideal for quickly finding specific images visually.

Use the view toggle button in the toolbar to switch between tree and gallery views.

#### Preview assets

Select any image or video file to see a preview in the right panel. The preview shows:

- Full-size image or video player
- File metadata including size and dimensions
- File path for easy reference

#### Configure assets

Select the settings icon on any file or folder to open the configuration panel where you can:

- View and copy file paths
- See file metadata (size, dimensions, file type)
- View folder contents and structure

Use the **Copy path** option to quickly copy a file path to your clipboard for use in your documentation.

### Create new pages

Select the **Create a new file** icon in the file explorer sidebar.
Expand Down Expand Up @@ -269,7 +319,7 @@
/>
</Frame>

If you authorize Mintlify to your GitHub user, your commits will be signed as if you had made them yourself. If not, they will be signed by the Mintlify GitHub app.

Check warning on line 322 in editor.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor.mdx#L322

Avoid using 'will'.

Check warning on line 322 in editor.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor.mdx#L322

In general, use active voice instead of passive voice ('be signed').

Check warning on line 322 in editor.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor.mdx#L322

Avoid using 'will'.

Check warning on line 322 in editor.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor.mdx#L322

In general, use active voice instead of passive voice ('be signed').

### Pull requests and reviewing changes

Expand All @@ -296,7 +346,7 @@
- Any specific areas that need review
</Step>
<Step title="Create and share">
Select **Publish Pull Request**. The editor will provide a link to view your pull request.

Check warning on line 349 in editor.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor.mdx#L349

Avoid using 'will'.

<Frame>
<img
Expand Down
4 changes: 4 additions & 0 deletions guides/media.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ keywords: ["screenshots", "GIFs", "videos", "media best practices"]

Screenshots, GIFs, and videos can enhance documentation but require ongoing maintenance as UI elements change. Use them selectively to avoid unnecessary upkeep.

<Note>
The [visual editor](/editor) includes an Images and Media view where you can browse, preview, and manage all your image and video assets in one place. Use this to quickly find file paths and view asset metadata.
</Note>

Key guidelines:

- **Media should be supplementary.** If a workflow is clear in text alone, avoid adding visuals.
Expand Down
Loading