Web editor basics

A beginner-friendly guide to editing your documentation in your browser.

The web editor lets you create and edit your documentation directly in your browser—no coding experience required. Think of it like using Google Docs, but for your documentation site.

Getting to the editor

1. Go to your Mintlify dashboard
2. Click Editor in the left sidebar

You’ll see your documentation files listed on the left and an editing area on the right.

Understanding the interface

The editor has three main areas:

• File list (left side): Shows all your documentation pages
• Editing area (center): Where you write and edit content
• Toolbar (top): Buttons for formatting and publishing

Opening and editing a page

To edit an existing page:

1. Find the page in the file list on the left
2. Click on it to open
3. Click anywhere in the editing area to start typing

Your changes appear as you type, showing you exactly how they’ll look on your live site.

Adding formatting

You can format your text using the toolbar buttons or keyboard shortcuts:

• Bold text: Highlight text and click the B button
• Italic text: Highlight text and click the I button
• Headings: Click where you want a heading and select a heading size from the toolbar

Press / (forward slash) to open a menu with all available formatting options and components.

Adding special elements

The editor includes pre-built elements to make your documentation more helpful:

Callout boxes

Callout boxes highlight important information. To add one:

1. Press / to open the component menu
2. Type “callout” or scroll to find it
3. Click the callout type you want (Tip, Warning, Info, etc.)
4. Type your message inside

Code blocks

To add a code example:

1. Press / to open the component menu
2. Type “code” and select Code Block
3. Choose the programming language
4. Paste or type your code

Images

To add an image:

1. Press / to open the component menu
2. Type “image” and select Image
3. Upload your image file or paste a URL

Creating a new page

To create a new documentation page:

1. Click the + icon at the top of the file list
2. Type a name for your file (spaces are okay—they’ll be converted automatically)
3. Press Enter
4. Start writing your content

After creating a new page, you’ll need to add it to your navigation menu so visitors can find it. See the Navigation guide for help.

Saving your work

The editor automatically saves your work as you type. You’ll see a “Saved” indicator in the toolbar when your changes are saved.

Publishing your changes

When you’re ready to make your changes live:

1. Click the Publish button in the top-right corner
2. Add a brief description of what you changed (optional but helpful)
3. Click Publish again to confirm

Your changes will appear on your live documentation site within a few minutes.

If you’re not sure about your changes, you can create a “branch” to preview them before publishing. Ask your team administrator about using branches for safer editing.

Switching between visual and code view

The editor has two viewing modes:

• Visual mode (default): Shows your content as it will appear on your site
• Markdown mode: Shows the underlying code

Most non-technical users will want to stay in visual mode. However, if you need to copy content from another source or make precise adjustments, you can switch to Markdown mode using the toggle buttons in the toolbar.

Finding pages quickly

If you have many documentation pages, use the search feature:

• Press Cmd + P (Mac) or Ctrl + P (Windows)
• Start typing the page name
• Click the page you want to open

Common tasks

Copying content from another page

1. Open the page you want to copy from
2. Select the content you want (click and drag)
3. Press Cmd + C (Mac) or Ctrl + C (Windows)
4. Open the destination page
5. Click where you want to paste
6. Press Cmd + V (Mac) or Ctrl + V (Windows)

Adding a link

1. Highlight the text you want to turn into a link
2. Press Cmd + K (Mac) or Ctrl + K (Windows)
3. Type or paste the URL
4. Press Enter

Undoing a mistake

Press Cmd + Z (Mac) or Ctrl + Z (Windows) to undo your last change. You can press it multiple times to undo several changes.

Getting help

If you get stuck:

• Hover over any button in the toolbar to see what it does
• Press / to see all available components and formatting options
• Check the full editor documentation for advanced features
• Contact your team administrator or Mintlify support

Next steps

Organize your navigation

Learn how to add your new pages to the navigation menu

Format text

Discover more text formatting options

Add components

Explore interactive components for your documentation

Full editor guide

Read the complete editor documentation