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
This URL is instantly available and will update whenever you make changes to your documentation. It's perfect for testing and sharing with your team during development.
24
+
Mintlify offers two ways to manage your documentation:
33
25
34
-
## Development Workflows
35
-
36
-
Mintlify offers two different workflows for creating and maintaining your documentation.
For those who prefer a visual interface. Click to jump to section.
44
-
</Card>
26
+
<CardGroupcols={2}>
27
+
<Cardtitle="Code-Based"icon="terminal">
28
+
Work with your existing development tools and Git workflows.
29
+
</Card>
30
+
<Cardtitle="Web Editor"icon="mouse-pointer-2">
31
+
Use our visual interface to edit documentation without coding.
32
+
</Card>
33
+
</CardGroup>
45
34
46
35
## Code-Based Workflow
47
36
48
-
The code-based workflow integrates with your existing development environment and Git repositories, making it ideal for technical teams who want to manage documentation alongside their code.
49
-
50
-
### Install the CLI
51
-
52
-
To work locally with your documentation, install the Command Line Interface (CLI), called [mint](https://www.npmjs.com/package/mint), by running the following command in your terminal:
37
+
### 1. Install CLI
53
38
54
39
<CodeGroup>
55
-
56
40
```bash npm
57
41
npm install -g mint
58
42
```
59
43
60
-
61
44
```bash yarn
62
45
yarn global add mint
63
46
```
64
47
65
-
66
48
```bash pnpm
67
49
pnpm add -g mint
68
50
```
69
-
70
51
</CodeGroup>
71
52
72
53
<Info>
73
-
You need Node.js version 19 or higher installed on your machine. If you encounter installation issues, check the troubleshooting guide.
74
-
</Info>
75
-
76
-
### Install the GitHub App
77
-
78
-
Mintlify provides a GitHub App that automates the deployment process when you push changes to your repository.
79
-
80
-
You can install the GitHub App by following the instructions from the onboarding checklist or by navigating to `Settings` > `Organization` > `GitHub`.
81
-
82
-
Click `Install GitHub App`. Select the repositories you want to connect.
When you're ready to publish your changes, simply push the changes to your repository.
133
-
134
-
Mintlify will automatically detect the changes, build your documentation, and deploy the updates to your site. You can monitor the deployment status in your GitHub repository's commit history or the [dashboard](https://dashboard.mintlify.com).
135
-
136
-
Once the deployment is complete, your last update will be available at `<your-project-name>.mintlify.app`.
137
-
138
-
<Cardtitle="Jump to adding a custom domain"icon="arrow-down"href="#adding-a-custom-domain"horizontal>
139
-
Optionally skip the web editor workflow and jump to adding a custom domain.
140
-
</Card>
65
+
1. Edit your MDX files locally
66
+
2. Preview changes with `mint dev`
67
+
3. Push changes to your repository
68
+
4. Changes automatically deploy to your site
141
69
142
70
## Web Editor Workflow
143
71
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.
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" />
170
-
</Frame>
72
+
1. Log in to your [Dashboard](https://dashboard.mintlify.com)
73
+
2. Navigate to `Editor`
74
+
3. Make changes in the visual editor
75
+
4. Click `Publish` to deploy
171
76
172
77
<Tip>
173
-
The editor provides a rich set of formatting tools and components. Access them by typing "/" in the editor to open the command menu.
78
+
Type "/" in the editor to access formatting tools and components
174
79
</Tip>
175
80
176
-
### Publish Your Changes
177
-
178
-
When you're satisfied with your edits, click the `Publish` button in the top-right corner.
179
-
180
-
Your changes will be deployed immediately to your documentation site.
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).
183
-
184
-
## Adding a Custom Domain
185
-
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.
81
+
## Add Custom Domain
187
82
188
-
To add a custom domain, go to `Settings` > `Custom Domain` from the dashboard.
If you encounter any issues during the setup process, check our common troubleshooting solutions:
227
-
228
106
<AccordionGroup>
229
-
<Accordiontitle="Local preview not working">
230
-
Make sure you have Node.js v19+ installed and that you're running the `mint dev` command from the directory containing your `docs.json` file.
107
+
<Accordiontitle="Local preview issues">
108
+
Verify Node.js v19+ is installed and you're in the correct directory
231
109
</Accordion>
232
-
<Accordiontitle="Changes not reflecting on live site">
233
-
Deployment can take upwards to a few minutes. Check your GitHub Actions (for code-based workflow) or deployment logs in the Mintlify dashboard to ensure there are no build errors.
110
+
<Accordiontitle="Deployment delays">
111
+
Changes can take a few minutes. Check GitHub Actions or dashboard logs
234
112
</Accordion>
235
-
<Accordiontitle="Custom domain not connecting">
236
-
Verify that your DNS records are set up correctly and allow sufficient time for DNS propagation (up to 48 hours). You can use tools like [DNSChecker](https://dnschecker.org) to verify your CNAME record.
113
+
<Accordiontitle="Domain connection">
114
+
Allow up to 48 hours for DNS propagation
237
115
</Accordion>
238
116
</AccordionGroup>
239
117
240
-
241
-
Need more help? [Contact our Support Team](mailto:[email protected]).
![mintlify[bot]](https://avatars.githubusercontent.com/in/222410?v=4&size=40){kind=avatar}
0 commit comments