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
13 changes: 5 additions & 8 deletions editor/collaborate.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,12 @@ Use pull requests to propose changes and collaborate with your team before mergi

Preview deployments create temporary URLs where you can see your rendered changes before they go live. Use preview deployments to gather feedback on how changes.

Every time you save changes to a branch, the preview deployment updates automatically.

### Access preview deployments

1. Click **Share** in the editor tool bar.
2. Click **Preview** to open the preview deployment in a new tab.
3. The preview URL shows your documentation with all saved changes applied.
1. Click **Publish** in the editor tool bar.
2. Click the preview URL open the preview deployment in a new tab. The URL format is `organization-branch-name.mintlify.app`.

<Frame>
<img src="/images/editor/share-preview-light.png" className="block dark:hidden" alt="Share button in the editor toolbar" />
Expand All @@ -67,11 +68,7 @@ Share a direct link to a specific page in the editor with your teammates. Use ed

When you open a page, the editor saves the path in the URL. Copy the URL from your browser's address bar to share it with teammates who have access to the editor.

The URL format is:

```
https://dashboard.mintlify.com/{org}/{project}/editor/{branch}?file={filepath}
```
The URL format is: `https://dashboard.mintlify.com/{org}/{project}/editor/{branch}?file={filepath}`

For example, `https://dashboard.mintlify.com/acme/docs/editor/main?file=guides/quickstart.mdx` opens `quickstart.mdx` on the `main` branch.

Expand Down
6 changes: 2 additions & 4 deletions editor/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,18 +17,16 @@
alt="Decorative image in dark mode"
/>

Create, edit, and publish documentation directly in your browser with the web editor. View and share previews of your changes; manage your site's navigation structure with drag-and-drop components; and publish updates using your team's preferred workflow.

Check warning on line 20 in editor/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/index.mdx#L20

Use semicolons judiciously.

Check warning on line 20 in editor/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/index.mdx#L20

Use semicolons judiciously.

## Key features

- **Visual and Markdown editing**: Switch between visual and Markdown editing modes as you work.
- **Visual and Markdown editing**: Switch between visual and Markdown editing modes to suit your workflow.
- **Live preview**: See real-time changes without creating a preview deployment.
- **Shareable preview links**: Create preview links for your team from the editor.
- **Drag-and-drop navigation**: Organize your site structure visually without editing configuration files.
- **Built-in media manager**: Upload and organize images, videos, and other assets.
- **Git synchronization**: All changes sync automatically with your documentation repository.
- **Branch workflows**: Work on feature branches and create pull requests for review.
- **Team collaboration**: Multiple team members can work simultaneously with preview deployments.
- **Team collaboration**: Multiple team members can work simultaneously with branch-based workflows.

## Get started

Expand Down
2 changes: 1 addition & 1 deletion editor/live-preview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Preview your documentation site as you edit. Live preview shows your pages exact

## Open live preview

Click the <Icon icon="play" /> button in the toolbar to open a live preview in a new tab.
Click the <Icon icon="play" /> play button in the toolbar to open a live preview in a new tab.

<Frame>
<img
Expand Down
10 changes: 4 additions & 6 deletions editor/media.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@

## Supported file types

- **Images**: PNG, JPG, JPEG, SVG, GIF, WebP (max 15MB)

Check warning on line 9 in editor/media.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/media.mdx#L9

Use parentheses judiciously.

Check warning on line 9 in editor/media.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/media.mdx#L9

Put a nonbreaking space between the number and the unit in '15MB'.
- **Videos**: MP4, WebM (max 100MB)

Check warning on line 10 in editor/media.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/media.mdx#L10

Use parentheses judiciously.

Check warning on line 10 in editor/media.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/media.mdx#L10

Put a nonbreaking space between the number and the unit in '100MB'.
- **Fonts**: TTF, WOFF, WOFF2

Check warning on line 11 in editor/media.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/media.mdx#L11

Spell out 'TTF', if it's unfamiliar to the audience.
- **Other**: PDF, ICO (favicons)

## Add media to a page
Expand All @@ -23,24 +23,22 @@

### Upload files

Use the asset manager in the sidebar to upload or search for files.
Use the file explorer in the sidebar to upload or search for files. Drag and drop files into a folder to organize media assets.

<Frame>
<img
src="/images/editor/assets-light.png"
alt="Assets manager selected in the editor sidebar menu."
alt="File explorer open in the editor sidebar menu."
className="block dark:hidden"
/>

<img
src="/images/editor/assets-dark.png"
alt="Assets manager selected in the editor sidebar menu."
alt="File explorer open in the editor sidebar menu."
className="hidden dark:block"
/>
</Frame>

Click **Upload** in the asset manager to add files from your computer.

## Manage assets

### Organize with folders
Expand All @@ -49,7 +47,7 @@

### Rename and edit assets

Hover over an asset and click the **...** button to rename the file or update its alt text.

Check warning on line 50 in editor/media.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/media.mdx#L50

In general, don't use an ellipsis.

### Delete assets

Expand All @@ -60,4 +58,4 @@
- **Use descriptive names**: Name files clearly, like `api-dashboard-light.png` instead of `img1.png`.
- **Add alt text**: Provide descriptive alt text for accessibility and SEO.
- **Organize with folders**: Group related assets, such as light and dark mode variants or assets for a specific feature area.
- **Use appropriate formats**: PNG for graphics with transparency, JPG for photos, SVG for icons and logos.
- **Use appropriate formats**: PNG for graphics with transparency, JPG for photos, SVG for icons and logos.
8 changes: 4 additions & 4 deletions editor/navigation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@
<img src="/images/editor/navigation-dark.png" alt="Add new navigation element." className="hidden dark:block" />
</Frame>

To add a navigation element nested inside another element, click the **+** plus button next to the name of the parent element.
To add a navigation element nested inside another element, click the <Icon icon="plus" /> plus button next to the name of the top-level element.

After creating 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.
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.

<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 @@ -27,8 +27,8 @@

Add files from your repository that aren't yet in navigation.

1. Click the plus button, <Icon icon="plus" />, where you want to add the file.
1. Click **Add existing file**.
1. Click the <Icon icon="plus" /> plus button on the navigation element that you want to add the file to.
1. Click **Add existing file** in the dropdown menu.

<Frame>
<img src="/images/editor/add-existing-file-menu-light.png" alt="Add existing file menu expanded." className="block dark:hidden" />
Expand Down Expand Up @@ -112,7 +112,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 115 in editor/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/navigation.mdx#L115

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

Check warning on line 115 in editor/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/navigation.mdx#L115

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

**Control visibility:**

Expand Down
2 changes: 1 addition & 1 deletion editor/pages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

## Create new pages

1. Click the **\+** button in the navigation element where you want to add a page.
1. Click the <Icon icon="plus" /> plus button in the navigation element where you want to add a page.
1. Click **Add a page**.
1. Enter a filename. The editor adds the `.mdx` extension automatically.

Expand Down Expand Up @@ -45,7 +45,7 @@
- **Add components**: Press <kbd>/</kbd> to open the component menu and select components.
- **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.
- **Insert links**: Select text and press <kbd>Cmd</kbd> + <kbd>K</kbd>.

Check warning on line 48 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L48

Did you really mean 'Cmd'?

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

Expand Down Expand Up @@ -99,10 +99,10 @@

Choose how the page displays to match your content needs.

- **Standard layout** (`default`): Default page with sidebar navigation and table of contents.

Check warning on line 102 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L102

Use parentheses judiciously.
- **Full-width layout** (`wide`): Hides table of contents to allow wider layouts for tables, diagrams, or other content.

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 parentheses judiciously.
- **Centered layout** (`center`): Hides sidebar and table of contents for better readability of text-heavy pages like changelogs.

Check warning on line 104 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L104

Use parentheses judiciously.
- **Custom width** (`custom`): Minimal layout with only the top navbar for landing pages or other unique layouts.

Check warning on line 105 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L105

Use parentheses judiciously.

## Manage pages

Expand All @@ -120,3 +120,3 @@

### Hide pages

Expand Down
10 changes: 5 additions & 5 deletions editor/publish.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,27 +33,27 @@
- Media uploads and organization.
- Configuration updates.

When you work on your deployment branch, your changes save automatically.
When you work on your deployment branch, changes automatically save.

<Frame caption="Changes on a deployment branch.">
<img src="/images/editor/toolbar-light.png" alt="Web editor toolbar showing one pending change." className="block dark:hidden" />
<img src="/images/editor/toolbar-dark.png" alt="Web editor toolbar showing one pending change." className="hidden dark:block" />
</Frame>

When you work on a feature branch, you can save changes to the branch as <Tooltip headline="Commit" tip="A commit is a saved snapshot of your changes in Git.">commits</Tooltip>.
When you work on a feature branch, save changes to the branch.

<Frame caption="Changes on a feature branch.">
<img src="/images/editor/toolbar-branch-light.png" alt="Web editor toolbar showing one pending change and the Save as commit button on a feature branch." className="block dark:hidden" />
<img src="/images/editor/toolbar-branch-dark.png" alt="Web editor toolbar showing one pending change and the Save as commit button on a feature branch." className="hidden dark:block" />
<img src="/images/editor/toolbar-branch-light.png" alt="Web editor toolbar showing one pending change and the Save in branch button on a feature branch." className="block dark:hidden" />
<img src="/images/editor/toolbar-branch-dark.png" alt="Web editor toolbar showing one pending change and the Save in branch button on a feature branch." className="hidden dark:block" />
</Frame>

To discard changes, click **Undo changes** beside a file name in the **Changes** dropdown.
To discard changes, click **Undo changes** beside a file name in the files changed dropdown.

Check warning on line 50 in editor/publish.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/publish.mdx#L50

Use 'filename' instead of 'file name'.

### Publish your changes

Click **Publish** in the toolbar. Depending on your workflow, your changes deploy immediately or create a pull request for you to merge in your Git provider. If you are on a feature branch, save your changes before publishing.

The **Publish** button is disabled when there are no pending changes or when a pull request for the current branch is already open.

Check warning on line 56 in editor/publish.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/publish.mdx#L56

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

## Resolve conflicts

Expand All @@ -64,7 +64,7 @@
Conflicts happen when:

- You and another team member edit the same lines in a file.
- Files are moved or deleted in one branch but modified in another.

Check warning on line 67 in editor/publish.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/publish.mdx#L67

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

### Resolve conflicts

Expand Down
Binary file modified images/editor/add-existing-file-menu-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/editor/add-existing-file-menu-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/editor/assets-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/editor/assets-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/editor/configurations-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/editor/configurations-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/editor/live-preview-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/editor/live-preview-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/editor/navigation-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/editor/navigation-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/editor/share-preview-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/editor/share-preview-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/editor/toolbar-branch-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/editor/toolbar-branch-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/editor/toolbar-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/editor/toolbar-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.