mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
Ethan Palm
f33c9dd8b7
* create files and update docs.json * draft of overview * keyboard shortcuts draft * draft of publishing * draft of collaborate * configurations draft * media draft * content draft * navigation draft * edit shortcuts * update overview * update media page and add images * collaborate edits * reorder nav * publish edits * copy edit publish * publish 💅 * remove redundancy * demo commit * fix tooltips * make configurations focused on tasks * update index * rename content.mdx to pages.mdx * copy edit pages * make configuration section more task-based * 💅 pages * remove old editor page * add redirect * 💅 navigation * add more nav elements * fix tooltip * update numbering * update redirects * update links * fix redirect loop * remove columns
64 lines
2.3 KiB
Plaintext
64 lines
2.3 KiB
Plaintext
---
|
|
title: "Web editor overview"
|
|
sidebarTitle: "Overview"
|
|
description: "Edit and publish documentation in your browser with real-time previews and Git synchronization."
|
|
keywords: ["editor", "visual", "gitbook"]
|
|
---
|
|
|
|
<img
|
|
className="block dark:hidden my-0 pointer-events-none"
|
|
src="/images/editor/editor-light.png"
|
|
alt="Decorative image in light mode"
|
|
/>
|
|
|
|
<img
|
|
className="hidden dark:block my-0 pointer-events-none"
|
|
src="/images/editor/editor-dark.png"
|
|
alt="Decorative image in dark mode"
|
|
/>
|
|
|
|
Create and edit documentation directly in your browser with the web editor. Work on content visually to see real-time previews or in Markdown; manage your site structure with drag-and-drop components; and publish changes using Git workflows.
|
|
|
|
## Key features
|
|
|
|
- **Visual and Markdown editing**: Switch between visual and Markdown modes as you work.
|
|
- **Drag-and-drop navigation**: Organize your site structure visually without editing configuration files.
|
|
- **Built-in media manager**: Upload and organize images and assets.
|
|
- **Git synchronization**: All changes sync automatically with your documentation repository.
|
|
- **Branch workflows**: Work on feature branches and create pull requests for review.
|
|
- **Team collaboration**: Multiple team members can work simultaneously with preview deployments.
|
|
|
|
## Get started
|
|
|
|
<Card title="Create and edit pages" icon="notebook-pen" horizontal href="/editor/pages">
|
|
Create, edit, and organize pages.
|
|
</Card>
|
|
|
|
<Card title="Organize navigation" icon="list-tree" horizontal href="/editor/navigation">
|
|
Structure your site navigation.
|
|
</Card>
|
|
|
|
<Card title="Add media" icon="image" horizontal href="/editor/media">
|
|
Upload and use images in your documentation.
|
|
</Card>
|
|
|
|
## Publish and collaborate
|
|
|
|
<Card title="Publish changes" icon="rocket" horizontal href="/editor/publish">
|
|
Save and publish your documentation updates.
|
|
</Card>
|
|
|
|
<Card title="Collaborate" icon="users" horizontal href="/editor/collaborate">
|
|
Work with teams using branches and pull requests.
|
|
</Card>
|
|
|
|
## Reference
|
|
|
|
<Card title="Configurations" icon="settings" horizontal href="/editor/configurations">
|
|
Configure site branding, colors, and features.
|
|
</Card>
|
|
|
|
<Card title="Keyboard shortcuts" icon="keyboard" horizontal href="/editor/keyboard-shortcuts">
|
|
Speed up your workflow with keyboard shortcuts.
|
|
</Card>
|