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
Welcome! Follow the instructions below to learn how to deploy, update and
21
16
supercharge your documentation with Mintlify.
22
17
18
+
19
+
20
+
<Tip>
21
+
Warning this is a new version
22
+
</Tip>
23
+
24
+
25
+
23
26
### Creating the Repository
24
27
25
28
Mintlify docs are rendered from MDX files and configurations defined in our
@@ -28,29 +31,26 @@ your docs with your code, and make source control effortless.
28
31
29
32
<AccordionGroup>
30
33
<Accordionicon="github"title="Creating your documentation repository">
31
-
32
34
If you've created a docs repo in our onboarding, this step is complete. You can find your docs repository on your Mintlify [dashboard](https://dashboard.mintlify.com).
33
35
34
36
To create your docs repo without logging into GitHub, follow these instructions:
37
+
35
38
1. Clone our [starter template](https://github.com/mintlify/starter) into a new public repo. You can make the repo private later.
36
-
2. [Get in touch](mailto:[email protected]) with our team to deploy your repo.
The next step is to install our GitHub app. This ensures that your updates are automatically deployed when you push changes. You can find the installation link in the [dashboard](https://dashboard.mintlify.com/settings), on the Settings page. Upon successful installation, a check mark will appear next to the commit hash of the repository.
2. Once git is installed, clone your docs repository using `git clone <your-repo>`. If you haven't set it up yet, now would be a good time to do so with these [SSH keys](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent).
66
+
66
67
3. Use your favorite IDE to open the repository.
68
+
67
69
4. Install our Mintlify CLI to preview changes with `npm i -g mintlify`.
68
-
69
-
Learn more about this in our [local development guide](/development).
70
70
71
+
Learn more about this in our [local development guide](/development).
71
72
</Accordion>
72
73
73
74
<Accordionicon="pen-to-square"title="Editing with the web editor">
74
-
75
75
Learn more about how to use the web editor on our [guide](/web-editor).
76
-
77
76
</Accordion>
78
77
79
78
<Accordionicon="palette"title="Customizing to your brand">
80
-
81
79
Easily customize colors, logos and buttons among other configurations in our `mint.json` file. Start with these basic configurations:
82
80
83
81
```json
@@ -96,11 +94,9 @@ your docs.
96
94
```
97
95
98
96
A full list of supported configurations can be found at [global settings](/settings/global).
99
-
100
97
</Accordion>
101
98
102
99
<Accordionicon="pencil"title="Adding content">
103
-
104
100
Add content with simple MDX files. Initiate your pages with this template:
105
101
106
102
```md
@@ -112,21 +108,17 @@ your docs.
112
108
```
113
109
114
110
Learn more about adding images, tables, lists, and more using the [MDX syntax](/text). We also offer a [wide array of components](/content/components).
115
-
116
111
</Accordion>
117
112
118
113
<Accordionicon="rocket"title="Pushing changes">
119
-
120
114
Once ready, commit and push your changes to update your docs site. Here is a [guide](https://docs.github.com/en/get-started/using-git/pushing-commits-to-a-remote-repository#about-git-push) on how to do that. If the GitHub app is unable to successfully deploy your changes, you can manually update your docs through our [dashboard](https://dashboard.mintlify.com).
<Accordionicon="code-branch"title="Generating API references">
129
-
130
122
You can easily set up your API references using an OpenAPI document.
131
123
132
124
1. Add your `openapi.yaml` or `openapi.json` file into your docs repository or define the `openapi` field in `mint.json` with a URL.
@@ -144,15 +136,12 @@ your docs.
144
136
3. Finally, include the generated endpoint MDX files to your `mint.json` under `navigation`.
145
137
146
138
For a complete guide on using Mintlify with OpenAPI, check out [this guide](/api-playground/openapi/setup). [This guide](/api-playground/openapi/writing-openapi) explains how to configure your API authentication methods. For manual API references definition, explore [our syntax](/api-playground/overview).
Our in-house analytics give you insights into page views, search analytics, session recordings and more. Access these on your [dashboard](https://dashboard.mintlify.com/analytics).
153
-
154
-
We also support integrations with a range of analytics providers. You can find the list of providers [here](/integrations/analytics/overview).
155
143
144
+
We also support integrations with a range of analytics providers. You can find the list of providers [here](/integrations/analytics/overview).
156
145
</Accordion>
157
146
</AccordionGroup>
158
147
@@ -164,18 +153,16 @@ your docs.
164
153
### Publishing
165
154
166
155
<Accordionicon="star"title="Adding a custom domain">
167
-
168
156
Integrate your docs into your website by hosting them on a custom domain. This is included even in the free plan.
169
-
170
-
Navigate to your [dashboard settings](https://www.dashboard.mintlify.com/settings) to add a custom domain.
171
157
172
-
<Frame>
173
-
174
-
</Frame>
158
+
Navigate to your [dashboard settings](https://www.dashboard.mintlify.com/settings) to add a custom domain.
175
159
160
+
<Frame>
161
+
162
+
</Frame>
176
163
</Accordion>
177
164
178
165
Congrats! You've set up your Mintlify Docs and it's looking amazing! Need
179
166
support or want to give some feedback? You can join our
180
167
[community](https://mintlify.com/community) or drop us an email at
![mintlify[bot]](https://avatars.githubusercontent.com/in/222410?v=4&size=40){kind=avatar}
0 commit comments