Mintlify web editor interface in light mode The web editor is a visual interface for creating, editing, and reviewing documentation directly in your browser.
  • Visual editing: Make changes to your documentation using a what-you-see-is-what-you-get (WYSIWYG) editor that shows how your content will look when published.
  • Git synchronization: All changes automatically sync with your Git repository to maintain version control.
  • Team collaboration: Multiple people can work on documentation simultaneously.
  • Component integration: Add callouts, code blocks, and other components with slash commands.
  • No setup required: Start writing immediately from your dashboard.

​
Web editor workflow

Here is how you’ll typically work in the web editor:
1

Choose your branch

Create a branch or make changes directly to your deployment branch. We recommend creating a branch so that you can preview your changes before they go live.
2

Open your file

Navigate to an existing file in the sidebar or create a new one using the file explorer.
3

Edit your content

Make changes in the web editor. Try switching between visual mode and Markdown mode using the toggle in the top-right corner to see which mode you prefer.
4

Preview your changes

Visual mode shows you how your changes will appear on your live site. Use this to verify everything looks correct.
5

Publish your changes

If you’re working on your deployment branch, publish your changes directly from the web editor. On other branches, you’ll create a pull request for review before publishing.

​
Editor modes

The web editor has two modes to accommodate different editing preferences and needs. Use the toggle in the top right corner of the editor toolbar to switch between editing modes.
Mode toggle icons highlighted in the web editor.

​
Visual mode

Visual mode provides a WYSIWYG experience where the changes that you make in the editor are the changes that will be published to your documentation site. This mode is ideal for when you want to see how your changes will look in real-time. Press / to open the component menu and add styled content, callouts, code snippets, or other components.
Visual editing mode in the Mintlify web editor

​
Markdown mode

Markdown mode provides direct access to the underlying MDX code of your documentation. This mode is ideal for when you need precise control over component properties or when you prefer to write in Markdown syntax.
Markdown mode in the Mintlify web editor

​
Next steps