mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
Ethan Palm
ed2c632698
* split web editor into focused pages * remove icons * add redirect * copyedit getting started * update group IA * copyedit git concepts * update conceptual info about branches * concsion * more concision * copyedit content management page * copyedit publishing * copy edit troubleshooting * focus reference on keyboard shortcuts
108 lines
4.1 KiB
Plaintext
108 lines
4.1 KiB
Plaintext
---
|
|
title: "Getting started with the web editor"
|
|
sidebarTitle: "Getting started"
|
|
description: "Learn how to create and edit documentation with the web editor"
|
|
---
|
|
|
|
<img
|
|
className="block dark:hidden my-0 pointer-events-none"
|
|
src="/images/editor/editor-light.png"
|
|
alt="Mintlify web editor interface in light mode"
|
|
/>
|
|
|
|
<img
|
|
className="hidden dark:block my-0 pointer-events-none"
|
|
src="/images/editor/editor-dark.png"
|
|
alt="Mintlify web editor interface in dark mode"
|
|
/>
|
|
|
|
The web editor is a visual interface for creating, editing, and reviewing documentation directly in your browser.
|
|
|
|
- **Visual editing**: Make changes to your documentation using a what-you-see-is-what-you-get (WYSIWYG) editor that shows how your content will look when published.
|
|
- **Git synchronization**: All changes automatically sync with your Git repository to maintain version control.
|
|
- **Team collaboration**: Multiple people can work on documentation simultaneously.
|
|
- **Component integration**: Add callouts, code blocks, and other components with slash commands.
|
|
- **No setup required**: Start writing immediately from your dashboard.
|
|
|
|
## Web editor workflow
|
|
|
|
Here is how you'll typically work in the web editor:
|
|
|
|
<Steps>
|
|
<Step title="Choose your branch">
|
|
Create a branch or make changes directly to your deployment branch. We recommend creating a branch so that you can preview your changes before they go live.
|
|
</Step>
|
|
<Step title="Open your file">
|
|
Navigate to an existing file in the sidebar or create a new one using the file explorer.
|
|
</Step>
|
|
<Step title="Edit your content">
|
|
Make changes in the web editor. Try switching between visual mode and Markdown mode using the toggle in the top-right corner to see which mode you prefer.
|
|
</Step>
|
|
<Step title="Preview your changes">
|
|
Visual mode shows you how your changes will appear on your live site. Use this to verify everything looks correct.
|
|
</Step>
|
|
<Step title="Publish your changes">
|
|
If you're working on your deployment branch, publish your changes directly from the web editor. On other branches, you'll create a pull request for review before publishing.
|
|
</Step>
|
|
</Steps>
|
|
|
|
## Editor modes
|
|
|
|
The web editor has two modes to accommodate different editing preferences and needs. Use the toggle in the top right corner of the editor toolbar to switch between editing modes.
|
|
|
|
<Frame>
|
|
<img
|
|
src="/images/editor/mode-toggle-light.png"
|
|
alt="Mode toggle icons highlighted in the web editor."
|
|
className="block dark:hidden"
|
|
/>
|
|
<img
|
|
src="/images/editor/mode-toggle-dark.png"
|
|
alt="Mode toggle icons highlighted in the web editor."
|
|
className="hidden dark:block"
|
|
/>
|
|
</Frame>
|
|
|
|
### Visual mode
|
|
|
|
Visual mode provides a WYSIWYG experience where the changes that you make in the editor are the changes that will be published to your documentation site. This mode is ideal for when you want to see how your changes will look in real-time.
|
|
|
|
Press `/` to open the component menu and add styled content, callouts, code snippets, or other components.
|
|
|
|
<Frame>
|
|
<img
|
|
src="/images/editor/visual-mode-light.png"
|
|
alt="Visual editing mode in the Mintlify web editor"
|
|
className="block dark:hidden"
|
|
/>
|
|
<img
|
|
src="/images/editor/visual-mode-dark.png"
|
|
alt="Visual editing mode in the Mintlify web editor"
|
|
className="hidden dark:block"
|
|
/>
|
|
</Frame>
|
|
|
|
### Markdown mode
|
|
|
|
Markdown mode provides direct access to the underlying `MDX` code of your documentation. This mode is ideal for when you need precise control over component properties or when you prefer to write in Markdown syntax.
|
|
|
|
<Frame>
|
|
<img
|
|
src="/images/editor/markdown-mode-light.png"
|
|
alt="Markdown mode in the Mintlify web editor"
|
|
className="block dark:hidden"
|
|
/>
|
|
<img
|
|
src="/images/editor/markdown-mode-dark.png"
|
|
alt="Markdown mode in the Mintlify Web Editor"
|
|
className="hidden dark:block"
|
|
/>
|
|
</Frame>
|
|
|
|
## Next steps
|
|
|
|
- Learn fundamental [Git concepts](/editor/git-concepts).
|
|
- Learn best practices for collaborating with [branches](/editor/branches).
|
|
- Explore [content management](/editor/content-management) with the web editor.
|
|
- Understand [publishing options](/editor/publishing) for different scenarios.
|