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
Copy file name to clipboardExpand all lines: quickstart.mdx
+9-25Lines changed: 9 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -93,50 +93,34 @@ Your preview is at `localhost:3000`.
93
93
94
94
**Push to deploy**. Mintlify automatically builds and deploys your changes.
95
95
96
-
## Web editor workflow
96
+
###Web editor workflow
97
97
98
-
The web editor workflow provides a what-you-see-is-what-you-get (WYSIWYG) interface for creating and editing documentation. This workflow is best for people who want to work in their web browser without additional local development tools.
98
+
Edit directly in your browser with a visual interface.
99
99
100
-
### Access the web editor
100
+
**Open the editor**:
101
101
102
-
1. Log in to your [dashboard](https://dashboard.mintlify.com).
103
-
2. Select **Editor** on the left sidebar.
104
-
105
-
<Info>
106
-
If you have not installed the GitHub App, you will be prompted to install the app when you open the web editor.
107
-
</Info>
102
+
1. Go to your [dashboard](https://dashboard.mintlify.com).
103
+
2. Select **Editor** in the sidebar.
108
104
109
105
<Frame>
110
106
<imgalt="The Mintlify web editor in the visual editor mode"src="/images/quickstart/web-editor-light.png"className="block dark:hidden" />
111
107
<imgalt="The Mintlify web editor in the visual editor mode"src="/images/quickstart/web-editor-dark.png"className="hidden dark:block" />
112
108
</Frame>
113
109
114
-
### Edit the documentation
115
-
116
-
In the web editor, you can navigate through your documentation files in the sidebar. Let's update the introduction page:
117
-
118
-
Find and select `index.mdx` in the file explorer.
119
-
120
-
Then, in the editor, update the title field to "Hello World".
110
+
**Edit your docs**. Select `index.mdx` and update the title to "Hello World".
121
111
122
112
<Frame>
123
113
<imgalt="Editing in Web Editor"src="/images/quickstart/web-editor-editing-light.png"className="block dark:hidden" />
124
114
<imgalt="Editing in Web Editor"src="/images/quickstart/web-editor-editing-dark.png"className="hidden dark:block" />
125
115
</Frame>
126
116
127
117
<Tip>
128
-
The editor provides a rich set of formatting tools and components. Type <kbd>/</kbd> in the editor to open the command menu and access these tools.
118
+
Type <kbd>/</kbd> to open the command menu and access formatting tools.
129
119
</Tip>
130
120
131
-
### Publish your changes
132
-
133
-
When you're satisfied with your edits, select the **Publish** button in the top-right corner. Your changes are immediately deployed to your documentation site.
134
-
135
-
<Tip>
136
-
Use branches to preview and review changes through pull requests before deploying to your live site.
137
-
</Tip>
121
+
**Publish**. Click the **Publish** button to deploy your changes.
138
122
139
-
For more details about using the web editor, including using branches and pull requests to collaborate and preview changes, see our[web editor documentation](/editor).
123
+
Learn more in the [web editor documentation](/editor).
0 commit comments