mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
d2c373e8c2
* docs: dedupe editor pages against canonical guides and settings * docs: mirror editor dedupe into es, fr, zh and fix long descriptions --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
66 lines
4.4 KiB
Plaintext
66 lines
4.4 KiB
Plaintext
---
|
|
title: "Editor overview"
|
|
sidebarTitle: "Overview"
|
|
description: "Create, edit, and publish content in your browser with the Mintlify editor. Supports real-time collaboration and continuous Git sync."
|
|
keywords: ["web editor", "git", "branches", "commits", "pull requests"]
|
|
---
|
|
|
|
<Card title="New to the editor? Start with the tutorial." icon="graduation-cap" horizontal 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
|
|
|
|
**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, you can save changes to the branch or 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
|
|
|
|
<Frame>
|
|
<img src="/images/editor/layout-light.png" alt="Screenshot of the editor with the Publishing tab selected." className="dark:hidden" />
|
|
<img src="/images/editor/layout-dark.png" alt="Screenshot of the editor with the Publishing tab selected." className="hidden dark:block" />
|
|
</Frame>
|
|
|
|
* **Top bar**: Use the top bar to control what branch you work on, access the agent, preview, and publish changes.
|
|
* **Sidebar**: Use the sidebar to select pages to edit, create new pages, and manage your site structure.
|
|
* **Home**: The file tree for your project. Pages in **Personal** are private to you. Pages in **Workspace** are public to your organization.
|
|
* **Publishing**: The navigation structure for your site. Organize pages as you want them to appear in your site.
|
|
|
|
## 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. Use it for precise control over component properties and frontmatter.
|
|
|
|
Both modes edit the same file. 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).
|
|
|
|
For the components you can insert, see [Components](/components). For MDX syntax, see [Format text](/create/text) and [Format code](/create/code).
|
|
|
|
## 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. |
|
|
| Save in branch | `git commit` to the current feature branch. |
|
|
| Create pull request | `git push` and opens a pull request against your deployment branch. |
|
|
| 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. |
|