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 available immediately and updates automatically when you make changes to your documentation. Use this URL for testing and sharing with your team during development.
32
+
Your site's URL is available immediately. Use this URL for testing and sharing with your team while you are setting up your docs site.
33
33
34
34
### Install the GitHub App
35
35
36
36
Mintlify provides a GitHub App that automates deployment when you push changes to your repository.
37
37
38
38
Install the GitHub App by following the instructions from the onboarding checklist or your dashboard.
39
39
40
-
1. Navigate to **Settings** in your Mintlify dashboard
41
-
2. Select **GitHub App** from the sidebar
42
-
3. Select **Install GitHub App**. This opens a new tab to the GitHub App installation page
43
-
4. Select the organization or user account where you want to install the app, then select the repositories you want to connect
40
+
1. Navigate to **Settings** in your Mintlify dashboard.
41
+
2. Select **GitHub App** from the sidebar.
42
+
3. Select **Install GitHub App**. This opens a new tab to the GitHub App installation page.
43
+
4. Select the organization or user account where you want to install the app.
44
+
5. Select the repositories that you want to connect.
For users who prefer working with existing tools in their local environment. Click to jump to this section.
@@ -73,41 +74,28 @@ Mintlify offers two workflows for creating and maintaining your documentation.
73
74
For users who prefer a visual interface in their web browser. Click to jump to this section.
74
75
</Card>
75
76
76
-
## Code-Based Workflow
77
+
## Code-based workflow
77
78
78
79
The code-based workflow integrates with your existing development environment and Git repositories. This workflow is best for technical teams who want to manage documentation alongside code.
79
80
80
81
### Install the CLI
81
82
82
83
To work locally with your documentation, install the Command Line Interface (CLI), called [mint](https://www.npmjs.com/package/mint), by running this command in your terminal:
83
84
84
-
<CodeGroup>
85
-
86
-
```bash npm
87
-
npm install -g mint
88
-
```
89
-
90
-
91
-
```bash yarn
92
-
yarn global add mint
93
-
```
94
-
95
-
96
-
```bash pnpm
97
-
pnpm add -g mint
85
+
```bash
86
+
npm i -g mint
98
87
```
99
88
100
-
</CodeGroup>
101
-
102
89
<Info>
103
90
You need Node.js installed on your machine. If you encounter installation issues, check the troubleshooting guide.
104
91
</Info>
105
92
106
-
### Edit the Documentation
93
+
### Edit the documentation
107
94
108
95
After setting up your environment, you can start editing your documentation files. For example, update the title of the introduction page:
109
96
110
-
Open your repository created during onboarding, find the `index.mdx` file, and locate the top of the file:
97
+
1. Open your repository created during onboarding.
98
+
2. Open `index.mdx` and locate the top of the file:
111
99
112
100
```mdx index.mdx
113
101
---
@@ -116,7 +104,7 @@ description: "This is the introduction to the documentation"
116
104
---
117
105
```
118
106
119
-
Update the `title` field to `"Hello World"`.
107
+
3.Update the `title` field to `"Hello World"`.
120
108
121
109
```mdx index.mdx {2}
122
110
---
@@ -125,9 +113,9 @@ description: "This is the introduction to the documentation"
125
113
---
126
114
```
127
115
128
-
### Preview the Changes
116
+
### Preview the changes
129
117
130
-
To preview the changes locally, run this command:
118
+
To preview the changes locally, run the following command:
131
119
132
120
```bash
133
121
mint dev
@@ -140,23 +128,23 @@ Your preview will be available at `localhost:3000`.
When you're ready to publish your changes, push them to your repository.
133
+
When you are ready to publish your changes, push them to your repository.
146
134
147
135
Mintlify automatically detects the changes, builds your documentation, and deploys the updates to your site. Monitor the deployment status in your GitHub repository commit history or the [dashboard](https://dashboard.mintlify.com).
148
136
149
-
After deployment completes, your latest update will be available at `<your-project-name>.mintlify.app`.
137
+
After the deployment completes, your latest update will be available at `<your-project-name>.mintlify.app`.
150
138
151
139
<Cardtitle="Jump to adding a custom domain"icon="arrow-down"href="#adding-a-custom-domain"horizontal>
152
140
Optionally, skip the web editor workflow and jump to adding a custom domain.
153
141
</Card>
154
142
155
-
## Web Editor Workflow
143
+
## Web editor workflow
156
144
157
145
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.
158
146
159
-
### Access the Web Editor
147
+
### Access the web editor
160
148
161
149
1. Log in to your [dashboard](https://dashboard.mintlify.com).
162
150
2. Select **Editor** on the left sidebar.
@@ -170,7 +158,7 @@ The web editor workflow provides a what-you-see-is-what-you-get (WYSIWYG) interf
170
158
<imgalt="The Mintlify web editor in the visual editor mode"src="/images/quickstart/web-editor-dark.png"className="hidden dark:block" />
171
159
</Frame>
172
160
173
-
### Edit the Documentation
161
+
### Edit the documentation
174
162
175
163
In the web editor, you can navigate through your documentation files in the sidebar. Let's update the introduction page:
176
164
@@ -187,7 +175,7 @@ Then, in the editor, update the title field to "Hello World".
187
175
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.
188
176
</Tip>
189
177
190
-
### Publish Your Changes
178
+
### Publish your changes
191
179
192
180
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.
193
181
@@ -197,11 +185,11 @@ When you're satisfied with your edits, select the **Publish** button in the top-
197
185
198
186
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).
199
187
200
-
## Adding a Custom Domain
188
+
## Adding a custom domain
201
189
202
190
While your `<your-project-name>.mintlify.app` subdomain works well for testing and development, most teams prefer using a custom domain for production documentation.
203
191
204
-
To add a custom domain, navigate to `Settings` > `Custom Domain` from the dashboard.
192
+
To add a custom domain, navigate to the [Domain Setup](https://dashboard.mintlify.com/settings/deployment/custom-domain) page in your dashboard.
0 commit comments