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
+64-64Lines changed: 64 additions & 64 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -112,7 +112,6 @@ description: "This is the introduction to the documentation"
112
112
---
113
113
```
114
114
115
-
116
115
### Preview the changes
117
116
118
117
To preview the changes locally, run the following command.
@@ -137,87 +136,90 @@ Mintlify will automatically detect the changes, build your documentation, and de
137
136
Once the deployment is complete, your last update will be available at `<your-project-name>.mintlify.app`.
138
137
139
138
<Cardtitle="Jump to adding a custom domain"icon="arrow-down"href="#adding-a-custom-domain"horizontal>
140
-
Skip the web editor workflow and jump to adding a custom domain.
139
+
Optionally skip the web editor workflow and jump to adding a custom domain.
141
140
</Card>
142
141
143
142
## Web Editor Workflow
144
143
145
-
The web editor workflow provides an intuitive interface for creating and editing documentation without requiring local development tools. It's ideal for non-technical team members or for making quick updates.
144
+
The web editor workflow provides a WYSIWYG interface for creating and editing documentation without requiring local development tools. It's ideal for non-technical team members or for making quick updates.
145
+
146
+
### Access the Web Editor
147
+
148
+
Log in to your Mintlify Dashboard and select your project. Navigate to `Editor` on the left sidebar to open the web editor.
149
+
150
+
<Info>
151
+
If you haven't installed the GitHub App, you will be prompted to do so upon opening the web editor.
152
+
</Info>
146
153
147
-
<Steps>
148
-
<Steptitle="Access the Web Editor">
149
-
Log in to your Mintlify Dashboard and select your project. Click the Edit button to open the web editor.
In the web editor, you can navigate your documentation files in the sidebar. Let's update the introduction page:
156
-
Find and click on introduction.mdx in the file explorer
157
-
In the visual editor, update the title field to "Hello World"
158
-
You'll see your changes reflected in the live preview on the right
159
-
<Framecaption="Web Editor Interface">
160
-
<imgalt="Editing in Web Editor"src="/images/web-editor-interface.png" />
158
+
159
+
### Edit the documentation
160
+
161
+
In the web editor, you can navigate your documentation files in the sidebar. Let's update the introduction page.
162
+
163
+
Find and click on `introduction.mdx` in the file explorer.
164
+
165
+
Then, in the visual editor, update the title field to "Hello World".
166
+
167
+
<Frame>
168
+
<imgalt="Editing in Web Editor"src="/images/quickstart/web-editor-editing-light.png"className="block dark:hidden" />
169
+
<imgalt="Editing in Web Editor"src="/images/quickstart/web-editor-editing-dark.png"className="hidden dark:block" />
161
170
</Frame>
171
+
162
172
<Tip>
163
-
The editor provides a rich set of formatting tools and components. Access them by clicking the "+" button or typing "/" in the editor to open the command menu.
173
+
The editor provides a rich set of formatting tools and components. Access them by typing "/" in the editor to open the command menu.
164
174
</Tip>
165
-
</Step>
166
-
<Steptitle="Publish Your Changes">
167
-
When you're satisfied with your edits:
168
-
Click the Publish button in the top-right corner
169
-
Review your changes in the confirmation dialog
170
-
Add a commit message describing your updates
171
-
Click Confirm and Publish
175
+
176
+
### Publish Your Changes
177
+
178
+
When you're satisfied with your edits, click the `Publish` button in the top-right corner.
179
+
172
180
Your changes will be deployed immediately to your documentation site.
For teams using Git workflows, the web editor can create branches and pull requests instead of publishing directly to the main branch. This allows for proper review processes.
178
-
</Note>
179
-
</Step>
180
-
<Steptitle="Add a Custom Domain (Optional)">
181
-
Just as with the code-based workflow, you can add a custom domain through the dashboard:
182
-
From your Mintlify dashboard, go to Settings > Custom Domain
183
-
Enter your domain (e.g., docs.yourcompany.com)
184
-
Follow the provided instructions to configure DNS settings with your domain provider
185
-
</Step>
186
-
</Steps>
187
-
For more details about using the web editor, including advanced features like slash commands and image uploads, see our Web Editor documentation.
188
-
Next Steps
189
-
Congratulations! You've successfully deployed your first documentation site with Mintlify. Here are some suggested next steps to enhance your documentation:
190
-
<CardGroupcols={2}>
191
-
<Cardtitle="Customize Your Theme"icon="paintbrush"href="/core-concepts/styling/themes">
192
-
Learn how to customize colors, fonts, and the overall appearance of your documentation site.
Enhance your documentation with interactive components like accordions, tabs, and code samples.
199
-
</Card>
200
-
<Cardtitle="Set Up API References"icon="code"href="/api-playground/overview">
201
-
Create interactive API references with OpenAPI and AsyncAPI specifications.
202
-
</Card>
203
-
</CardGroup>
181
+
182
+
For more details about using the web editor, including advanced features like slash commands and image uploads, see our [Web Editor documentation](/editor).
204
183
205
184
## Adding a Custom Domain
206
185
207
-
While your `<name>.mintlify.app` subdomain works well for testing, most teams prefer using a custom domain for production documentation.
208
-
From your Mintlify dashboard, go to Settings > Custom Domain
186
+
While your `<your-project-name>.mintlify.app` subdomain works well for testing and development, most teams prefer using a custom domain for production documentation.
187
+
188
+
To add a custom domain, go to `Settings` > `Custom Domain` from the dashboard.
209
189
210
-
Enter your domain (e.g., docs.yourcompany.com)
211
-
Follow the provided instructions to configure DNS settings with your domain provider
0 commit comments