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
22
supercharge your documentation with Mintlify.
22
23
24
+
<Info>
25
+
callout
26
+
</Info>
27
+
23
28
### Creating the Repository
24
29
25
30
Mintlify docs are rendered from MDX files and configurations defined in our
26
31
[starter kit](https://github.com/mintlify/starter). We use GitHub to integrate
27
32
your docs with your code, and make source control effortless. Onboard through the [dashboard](https://dashboard.mintlify.com) or clone our [starter kit](https://github.com/mintlify/starter) to get started.
28
33
29
34
<AccordionGroup>
30
-
31
-
<Accordionicon="message-bot"title="Install the GitHub app">
32
-
35
+
<Accordiontitle="Install the GitHub app"icon="message-bot">
33
36
Install our GitHub app to ensure 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).
72
73
3. Use your favorite IDE to open the repository.
73
74
4. Install our Mintlify CLI to preview changes with `npm i -g mintlify`.
74
75
75
76
Learn more about this in our [local development guide](/development).
76
-
77
77
</Accordion>
78
-
79
-
<Accordionicon="pen-to-square"title="Editing with the web editor">
80
-
78
+
<Accordiontitle="Editing with the web editor"icon="pen-to-square">
81
79
Learn more about how to use the web editor on our [guide](/web-editor).
82
-
83
80
</Accordion>
84
-
85
-
<Accordionicon="palette"title="Customizing to your brand">
86
-
81
+
<Accordiontitle="Customizing to your brand"icon="palette">
87
82
Easily customize colors, logos and buttons among other configurations in our `docs.json` file. Start with these basic configurations:
88
83
89
84
```json
@@ -102,11 +97,8 @@ your docs.
102
97
```
103
98
104
99
A full list of supported configurations can be found at [global settings](/settings/global).
105
-
106
100
</Accordion>
107
-
108
-
<Accordionicon="pencil"title="Adding content">
109
-
101
+
<Accordiontitle="Adding content"icon="pencil">
110
102
Add content with simple MDX files. Initiate your pages with this template:
111
103
112
104
```md
@@ -118,22 +110,16 @@ your docs.
118
110
```
119
111
120
112
Learn more about adding images, tables, lists, and more using the [MDX syntax](/text). We also offer a [wide array of components](/content/components).
121
-
122
113
</Accordion>
123
-
124
-
<Accordionicon="rocket"title="Pushing changes">
125
-
114
+
<Accordiontitle="Pushing changes"icon="rocket">
126
115
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).
3. Finally, include the generated endpoint MDX files to your `docs.json` under `navigation`.
137
+
1. Finally, include the generated endpoint MDX files to your `docs.json` under `navigation`.
152
138
153
139
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).
160
143
161
144
We also support integrations with a range of analytics providers. You can find the list of providers [here](/integrations/analytics/overview).
162
-
163
145
</Accordion>
164
146
</AccordionGroup>
165
147
@@ -170,17 +152,17 @@ your docs.
170
152
171
153
### Publishing
172
154
173
-
<Accordionicon="star"title="Adding a custom domain">
155
+
<Accordiontitle="Adding a custom domain"icon="star">
156
+
Integrate your docs into your website by hosting them on a custom domain. This is included in the free plan.
174
157
175
-
Integrate your docs into your website by hosting them on a custom domain. This is included in the free plan.
176
-
177
-
Navigate to your [dashboard settings](https://dashboard.mintlify.com/settings) to add a custom domain.
0 commit comments