mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
Ethan Palm
3dc3852b7a
* Improve SEO descriptions across 47 pages Curated descriptions from two bot-generated PRs (#3908, #3949), selecting the best approach for each page: - Added missing title and description frontmatter to 10 API reference pages - Benefit-focused descriptions for integration pages (not implementation-heavy) - Accurate REST-aligned titles for API endpoints (Export, List, Trigger, etc.) - Expanded short descriptions to 50–160 character range throughout Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * copyedit * Update custom-domain.mdx * Fix analytics API page titles to match spec summaries "Export" was inaccurate — spec uses "Get" for both endpoints. Also updated descriptions to use "Retrieve" for consistency. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> --------- Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
68 lines
2.5 KiB
Plaintext
68 lines
2.5 KiB
Plaintext
---
|
|
title: "Web editor overview"
|
|
sidebarTitle: "Overview"
|
|
description: "Create, edit, and publish documentation in your browser with visual editing, live preview, and Git sync."
|
|
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, edit, and publish documentation directly in your browser with the web editor. View and share previews of your changes; manage your site's navigation structure with drag-and-drop components; and publish updates using your team's preferred workflow.
|
|
|
|
## Key features
|
|
|
|
- **Visual and Markdown editing**: Switch between visual and Markdown editing modes to suit your workflow.
|
|
- **Live preview**: See real-time changes without creating a preview deployment.
|
|
- **Shareable preview links**: Create preview links for your team from the editor.
|
|
- **Drag-and-drop navigation**: Organize your site structure visually without editing configuration files.
|
|
- **Git synchronization**: All changes sync automatically with your documentation repository.
|
|
- **Team collaboration**: Multiple team members can work simultaneously with branch-based workflows.
|
|
|
|
## 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, videos, and other assets.
|
|
</Card>
|
|
|
|
<Card title="Live preview" icon="play" horizontal href="/editor/live-preview">
|
|
Preview your site in real time as you edit.
|
|
</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>
|