You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
description: "Learn how to use Mintlify's web editor to create and edit documentation"
4
+
description: "Learn how to create and edit documentation with the web editor"
5
5
---
6
6
7
7
<img
@@ -16,57 +16,58 @@ description: "Learn how to use Mintlify's web editor to create and edit document
16
16
alt="Mintlify web editor interface in dark mode"
17
17
/>
18
18
19
-
The web editor is a visual interface for creating, editing, and reviewing documentation directly in your browser. No local setup required—just log in to your dashboard and start writing.
19
+
The web editor is a visual interface for creating, editing, and reviewing documentation directly in your browser.
20
20
21
-
## What you can do
21
+
-**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.
22
+
-**Git synchronization**: All changes automatically sync with your Git repository to maintain version control.
23
+
-**Team collaboration**: Multiple people can work on documentation simultaneously.
24
+
-**Component integration**: Add callouts, code blocks, and other components with slash commands.
25
+
-**No setup required**: Start writing immediately from your dashboard.
22
26
23
-
-**Visual editing**: Make changes using a what-you-see-is-what-you-get (WYSIWYG) editor that shows how your content will look when published
24
-
-**Git synchronization**: All changes automatically sync with your Git repository to maintain version control
25
-
-**Real-time collaboration**: Multiple team members can work on documentation simultaneously
26
-
-**Component integration**: Add callouts, code blocks, and other Mintlify components with a simple `/` command
27
+
## Web editor workflow
27
28
28
-
## Your first editing session
29
-
30
-
Follow this walkthrough to make your first changes in the web editor:
29
+
Here is how you'll typically work in the web editor:
31
30
32
31
<Steps>
33
32
<Steptitle="Choose your branch">
34
-
Create a branch or make changes directly to your deployment branch. For your first time, we recommend creating a branch to keep your live docs safe while you learn.
33
+
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.
35
34
</Step>
36
35
<Steptitle="Open your file">
37
36
Navigate to an existing file in the sidebar or create a new one using the file explorer.
38
37
</Step>
39
38
<Steptitle="Edit your content">
40
-
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 you prefer.
39
+
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.
41
40
</Step>
42
41
<Steptitle="Preview your changes">
43
-
Visual mode shows you exactly how your changes will appear on your live site. Use this to verify everything looks correct.
42
+
Visual mode shows you how your changes will appear on your live site. Use this to verify everything looks correct.
44
43
</Step>
45
44
<Steptitle="Publish your changes">
46
-
If you're working on your deployment branch, your changes go live immediately. On other branches, you'll create a pull request for review before publishing.
45
+
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.
47
46
</Step>
48
47
</Steps>
49
48
50
49
## Editor modes
51
50
52
-
The web editor offers two editing experiences. Switch between them anytime using the toggle in the editor toolbar:
51
+
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.
53
52
54
53
<Frame>
55
54
<img
56
55
src="/images/editor/mode-toggle-light.png"
57
-
alt="Mode toggle icons highlighted in the Mintlify web editor"
56
+
alt="Mode toggle icons highlighted in the web editor."
58
57
className="block dark:hidden"
59
58
/>
60
59
<img
61
60
src="/images/editor/mode-toggle-dark.png"
62
-
alt="Mode toggle icons highlighted in the Mintlify web editor"
61
+
alt="Mode toggle icons highlighted in the web editor."
63
62
className="hidden dark:block"
64
63
/>
65
64
</Frame>
66
65
67
66
### Visual mode
68
67
69
-
Perfect for beginners and quick edits. What you see in the editor is exactly what appears on your documentation site. Press `/` to open the component menu and add content blocks, callouts, and code snippets.
68
+
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.
69
+
70
+
Press `/` to open the component menu and add styled content, callouts, code snippets, or other components.
70
71
71
72
<Frame>
72
73
<img
@@ -83,7 +84,7 @@ Perfect for beginners and quick edits. What you see in the editor is exactly wha
83
84
84
85
### Markdown mode
85
86
86
-
Gives you direct access to the underlying MDX code. Use this when you need precise control over component properties or prefer writing in Markdown syntax.
87
+
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.
87
88
88
89
<Frame>
89
90
<img
@@ -100,10 +101,6 @@ Gives you direct access to the underlying MDX code. Use this when you need preci
100
101
101
102
## Next steps
102
103
103
-
Now that you understand the basics:
104
-
105
-
- Learn about [branching workflows](/editor/branching-workflow) for safer collaboration
0 commit comments