mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
2016c35157
Generated-By: mintlify-agent Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
53 lines
2.3 KiB
Plaintext
53 lines
2.3 KiB
Plaintext
---
|
|
title: "Editor overview"
|
|
sidebarTitle: "Overview"
|
|
description: "Create, edit, and publish documentation in your browser with real-time team collaboration, automatic saving, live previews, and continuous Git sync."
|
|
keywords: ["editor", "visual", "collaborative", "web editor"]
|
|
---
|
|
|
|
<img
|
|
className="block dark:hidden my-0 pointer-events-none"
|
|
src="/images/editor/editor-light.png"
|
|
alt="Decorative image of the web editor in light mode"
|
|
/>
|
|
|
|
<img
|
|
className="hidden dark:block my-0 pointer-events-none"
|
|
src="/images/editor/editor-dark.png"
|
|
alt="Decorative image of the web editor in dark mode"
|
|
/>
|
|
|
|
The editor keeps your content in sync with your Git repository and lets your whole team edit together in real time.
|
|
|
|
## How the editor works
|
|
|
|
**Changes save automatically.** As you type, the editor saves changes. Your work persists across tabs, devices, and network interruptions.
|
|
|
|
**Git stays in sync.** When someone else pushes changes to your repository from outside the editor, those changes appear in the editor automatically. You don't need to pull or refresh. The editor merges non-conflicting changes and highlights anything that needs your attention.
|
|
|
|
**Publishing writes to Git.** When you publish, the editor commits your changes to your repository. On a deployment branch, this updates your live site immediately. On a feature branch, it creates a pull request.
|
|
|
|
**Your team edits together.** Multiple people can edit the same page simultaneously. Live cursors show who is editing and where.
|
|
|
|
## Explore the editor
|
|
|
|
<Card title="Branching and publishing" icon="git-branch" horizontal href="/editor/branching-and-publishing">
|
|
How branches and protection rules determine what happens when you publish, and how to manage the pull request review process.
|
|
</Card>
|
|
|
|
<Card title="Create and edit pages" icon="notebook-pen" horizontal href="/editor/pages">
|
|
Everything you need to add new and update existing pages.
|
|
</Card>
|
|
|
|
<Card title="Organize navigation" icon="list-tree" horizontal href="/editor/navigation">
|
|
Reorder pages and manage site structure.
|
|
</Card>
|
|
|
|
<Card title="Configurations" icon="settings" horizontal href="/editor/configurations">
|
|
Configure your site's branding, colors, and features.
|
|
</Card>
|
|
|
|
<Card title="Keyboard shortcuts" icon="keyboard" horizontal href="/editor/keyboard-shortcuts">
|
|
Speed up your workflow with keyboard shortcuts.
|
|
</Card>
|