# Editor overview (/editor)

<!-- agent-signals: reading_time_min: 5 · est_tokens: 2392 · updated: 2026-09-23 -->
Related: [What is the agent?](/agent.md), [Analytics overview](/analytics.md), [Assistant](/assistant.md), [Automations overview](/automations.md), [Mintlify CLI](/cli.md), [Components overview](/components.md)

<Card title="New to the editor? Start with the tutorial." icon="<svg xmlns=&#x22;http://www.w3.org/2000/svg&#x22; viewBox=&#x22;0 0 24 24&#x22; fill=&#x22;none&#x22;><path d=&#x22;M22 9V15&#x22; stroke=&#x22;currentColor&#x22; stroke-linecap=&#x22;round&#x22; stroke-linejoin=&#x22;round&#x22; stroke-width=&#x22;1.5&#x22;/><path d=&#x22;M18 12V15.0669C18 16.1333 18 16.6665 17.737 17.1071L17.7316 17.1159C17.4661 17.5551 16.9843 17.8238 16.0206 18.3611C14.0645 19.4518 13.0864 19.9972 12.0109 20H11.9891C10.9136 19.9972 9.93551 19.4518 7.97941 18.3611C7.01574 17.8238 6.53391 17.5551 6.2684 17.1159L6.26305 17.1071C6 16.6665 6 16.1333 6 15.0669V12&#x22; stroke=&#x22;currentColor&#x22; stroke-linecap=&#x22;round&#x22; stroke-linejoin=&#x22;round&#x22; stroke-width=&#x22;1.5&#x22;/><path d=&#x22;M8.52143 5.22252L4.40645 7.2074C2.80215 7.98124 2 8.36816 2 8.99125C2 9.61434 2.80215 10.0013 4.40645 10.7751L8.598 12.7969C10.2608 13.599 11.0922 14 11.9816 14C12.8711 14 13.7025 13.599 15.3653 12.7969L19.6386 10.7356C21.2141 9.97571 22.0018 9.59575 22 8.97064C21.9982 8.34553 21.2146 7.97321 19.6473 7.22857C18.2179 6.5494 16.8685 5.92516 15.433 5.24184C13.6907 4.41243 12.8195 3.99772 11.9353 4.00001C11.0512 4.00229 10.2079 4.40904 8.52143 5.22252Z&#x22; stroke=&#x22;currentColor&#x22; stroke-linecap=&#x22;round&#x22; stroke-linejoin=&#x22;round&#x22; stroke-width=&#x22;1.5&#x22;/></svg>" href="/editor/tutorial">
  Create a branch, make a change, share a preview, and publish.
</Card>

Use the editor to write and publish documentation in your browser. The editor uses a docs-as-code workflow with all your changes backed by Git. Your work saves as commits in your repository and the editor manages Git operations for you.

The editor loads by default when you open your [dashboard](https://app.mintlify.com). Anyone in your organization can open it, but certain actions depend on your [role](/dashboard/roles). Admins and editors can edit and publish. Viewers can browse content and leave [comments and suggestions](/editor/collaborate).

## How the editor works [#how-the-editor-works]

**Changes save automatically, but saving is separate from publishing.** As you type, the editor stores your work. Your changes persist across tabs, devices, and network interruptions. For any changes to reach your live site, you must [publish](/editor/publish) them.

**Publishing writes to Git.** When you publish, the editor commits your changes to your repository. If you publish to your deployment branch, this updates your live site immediately. On a feature branch, your edits commit to the branch automatically and open a pull request for review. Nothing on a feature branch reaches your live site until it merges into your deployment branch.

**Git stays in sync.** When someone pushes to your repository, those changes appear automatically. You don't need to pull or refresh. The editor merges non-conflicting changes and flags anything that needs your attention.

**Your team edits together.** Multiple people can edit the same page at once, with live cursors showing who is working where. Comments and suggestions are visible to everyone.

<Tip>
  If the editor ever appears out of sync with your repository, use [Reset editor](/editor/settings#reset-editor) to force a resync.
</Tip>

## Editor layout [#editor-layout]

<Frame>
  <img src="/_assets/941c0fc71fcdefe2624848a0026d70aaae6bf64574fc1080df3f10372cceccfb" alt="Screenshot of the editor with the Site tab selected." className="dark:hidden" />

  <img src="/_assets/f3bbe6e3f0fc4e59421abe42f1ab3bbe7a5b2556576a57902b54755949388f6d" alt="Screenshot of the editor with the Site tab selected." className="hidden dark:block" />
</Frame>

* **Top bar**: Open the agent with **Ask agent**. On the **Site** tab, the top bar also has the branch selector, **Preview**, and **Publish**. On the **Workspace** tab, it has **Share**. Click <Icon icon="<svg xmlns=&#x22;http://www.w3.org/2000/svg&#x22; viewBox=&#x22;0 0 24 24&#x22; fill=&#x22;none&#x22;><path d=&#x22;M12 12.002H12.5M19 12.002H19.5M5 12.002H5.5M12 13.002C12.5523 13.002 13 12.5542 13 12.002C13 11.4497 12.5523 11.002 12 11.002C11.4477 11.002 11 11.4497 11 12.002C11 12.5542 11.4477 13.002 12 13.002ZM19 13.002C19.5523 13.002 20 12.5542 20 12.002C20 11.4497 19.5523 11.002 19 11.002C18.4477 11.002 18 11.4497 18 12.002C18 12.5542 18.4477 13.002 19 13.002ZM5 13.002C5.55228 13.002 6 12.5542 6 12.002C6 11.4497 5.55228 11.002 5 11.002C4.44772 11.002 4 11.4497 4 12.002C4 12.5542 4.44772 13.002 5 13.002Z&#x22; stroke=&#x22;currentColor&#x22; stroke-linecap=&#x22;round&#x22; stroke-linejoin=&#x22;round&#x22; stroke-width=&#x22;1.5&#x22;/></svg>" /> **More options** for page actions like **Page settings**, **Comments**, **Version history**, **Duplicate**, and **Move to**.
* **Sidebar**: Use the sidebar to select pages to edit, create new pages, and manage your site structure. Press <kbd>Ctrl</kbd> + <kbd>\\</kbd> (macOS and Windows) to hide or show it. Press <kbd>Cmd</kbd> + <kbd>K</kbd> (macOS) or <kbd>Ctrl</kbd> + <kbd>K</kbd> (Windows) to search your pages and dashboard.
  * **Workspace**: Pages that aren't part of your Git repository or published site. **Personal** contains your private drafts, **Teamspace** contains pages shared with your whole organization, and **Shared with me** contains pages teammates shared with you directly.
  * **Site**: Your repository and published site. **Navigation** contains the pages in your site navigation. **Files** lists the files in your repository that aren't in your navigation.

## Visual and source mode [#visual-and-source-mode]

**Visual mode** renders your page as you type. Press <kbd>/</kbd> to open the component menu and insert components.

**Source mode** gives you direct access to the MDX, with line numbers. Use it for precise control over component properties and frontmatter. Type <kbd>\<</kbd> to access components. Press <kbd>Cmd</kbd> + <kbd>S</kbd> (macOS) or <kbd>Ctrl</kbd> + <kbd>S</kbd> (Windows) to format the document. If a single change modifies more than 1,000 characters, the editor asks you to confirm it.

Both modes edit the same file and support [real-time collaboration](/editor/collaborate#real-time-editing). Switch between them with <kbd>Cmd</kbd> + <kbd>Shift</kbd> + <kbd>S</kbd> (macOS) or <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>S</kbd> (Windows), or with the **Source mode** switch in <Icon icon="<svg xmlns=&#x22;http://www.w3.org/2000/svg&#x22; viewBox=&#x22;0 0 24 24&#x22; fill=&#x22;none&#x22;><path d=&#x22;M12 12.002H12.5M19 12.002H19.5M5 12.002H5.5M12 13.002C12.5523 13.002 13 12.5542 13 12.002C13 11.4497 12.5523 11.002 12 11.002C11.4477 11.002 11 11.4497 11 12.002C11 12.5542 11.4477 13.002 12 13.002ZM19 13.002C19.5523 13.002 20 12.5542 20 12.002C20 11.4497 19.5523 11.002 19 11.002C18.4477 11.002 18 11.4497 18 12.002C18 12.5542 18.4477 13.002 19 13.002ZM5 13.002C5.55228 13.002 6 12.5542 6 12.002C6 11.4497 5.55228 11.002 5 11.002C4.44772 11.002 4 11.4497 4 12.002C4 12.5542 4.44772 13.002 5 13.002Z&#x22; stroke=&#x22;currentColor&#x22; stroke-linecap=&#x22;round&#x22; stroke-linejoin=&#x22;round&#x22; stroke-width=&#x22;1.5&#x22;/></svg>" /> **More options**. The editor remembers your choice across pages.

For the components you can insert, see [Components](/components). For MDX syntax, see [Format text](/create/text) and [Format code](/create/code).

## Git concepts [#git-concepts]

Understanding some Git concepts helps you get the most from the editor. For definitions of commits, branches, pull requests, merges, conflicts, and diffs, see [Git concepts for documentation](/guides/git-concepts).

| Action in the editor              | Git operation                                                                                                                                            |
| --------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Edit a page                       | Saves automatically. No commit yet.                                                                                                                      |
| Publish on your deployment branch | `git commit` and `git push`. Triggers a deployment.                                                                                                      |
| Edit on a feature branch          | `git commit` and `git push` to the branch about 15 seconds after you stop editing. The first commit opens a pull request against your deployment branch. |
| Request review                    | Marks the pull request ready for review.                                                                                                                 |
| Merge and publish                 | Merges the pull request and triggers a deployment.                                                                                                       |
| Create a branch                   | `git checkout -b <branch-name>`                                                                                                                          |
| Switch branches                   | `git checkout <branch-name>`                                                                                                                             |
| External push or CLI update       | Incoming changes sync into the editor using a three-way merge.                                                                                           |