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
* Documentation edits made through Mintlify web editor
* Update quickstart.mdx
* Update quickstart.mdx
* Update quickstart.mdx
never liked this final line lmao
---------
Co-authored-by: tiffany-mintlify <[email protected]>
Welcome! Follow the instructions below to learn how to deploy, update and
21
+
Welcome\! Follow the instructions below to learn how to deploy, update and
21
22
supercharge your documentation with Mintlify.
22
23
23
24
### Creating the Repository
@@ -27,36 +28,33 @@ Mintlify docs are rendered from MDX files and configurations defined in our
27
28
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
29
29
30
<AccordionGroup>
30
-
31
-
<Accordionicon="message-bot"title="Install the GitHub app">
32
-
31
+
<Accordiontitle="Install the GitHub app"icon="message-bot">
33
32
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
69
3. Use your favorite IDE to open the repository.
73
70
4. Install our Mintlify CLI to preview changes with `npm i -g mintlify`.
74
71
75
72
Learn more about this in our [local development guide](/development).
76
-
77
73
</Accordion>
78
-
79
-
<Accordionicon="pen-to-square"title="Editing with the web editor">
80
-
74
+
<Accordiontitle="Editing with the web editor"icon="pen-to-square">
81
75
Learn more about how to use the web editor on our [guide](/web-editor).
82
-
83
76
</Accordion>
84
-
85
-
<Accordionicon="palette"title="Customizing to your brand">
86
-
77
+
<Accordiontitle="Customizing to your brand"icon="palette">
87
78
Easily customize colors, logos and buttons among other configurations in our `docs.json` file. Start with these basic configurations:
88
79
89
80
```json
@@ -102,11 +93,8 @@ your docs.
102
93
```
103
94
104
95
A full list of supported configurations can be found at [global settings](/settings/global).
105
-
106
96
</Accordion>
107
-
108
-
<Accordionicon="pencil"title="Adding content">
109
-
97
+
<Accordiontitle="Adding content"icon="pencil">
110
98
Add content with simple MDX files. Initiate your pages with this template:
111
99
112
100
```md
@@ -118,22 +106,16 @@ your docs.
118
106
```
119
107
120
108
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
109
</Accordion>
123
-
124
-
<Accordionicon="rocket"title="Pushing changes">
125
-
110
+
<Accordiontitle="Pushing changes"icon="rocket">
126
111
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">
136
-
118
+
<Accordiontitle="Generating API references"icon="code-branch">
137
119
You can easily set up your API references using an OpenAPI document.
138
120
139
121
1. Add your `openapi.yaml` or `openapi.json` file into your docs repository or define the `openapi` field in `docs.json` with a URL.
@@ -151,15 +133,11 @@ your docs.
151
133
3. Finally, include the generated endpoint MDX files to your `docs.json` under `navigation`.
152
134
153
135
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
139
161
140
We also support integrations with a range of analytics providers. You can find the list of providers [here](/integrations/analytics/overview).
162
-
163
141
</Accordion>
164
142
</AccordionGroup>
165
143
@@ -170,17 +148,18 @@ your docs.
170
148
171
149
### Publishing
172
150
173
-
<Accordionicon="star"title="Adding a custom domain">
151
+
<Accordiontitle="Adding a custom domain"icon="star">
152
+
Integrate your docs into your website by hosting them on a custom domain. This is included in the free plan.
174
153
175
-
Integrate your docs into your website by hosting them on a custom domain. This is included in the free plan.
154
+
Navigate to your [dashboard settings](https://dashboard.mintlify.com/settings) to add a custom domain.
176
155
177
-
Navigate to your [dashboard settings](https://dashboard.mintlify.com/settings) to add a custom domain.
Congrats, you've set up your documentation on Mintlify\!
180
162
181
-
</Accordion>
163
+
Need support or want to give some feedback? You can click `support` in the [dashboard](http://dashboard.mintlify.com) (bottom left corner) or reach out to [[email protected]](mailto:[email protected]).
182
164
183
-
Congrats! You've set up your Mintlify Docs and it's looking amazing! Need
184
-
support or want to give some feedback? You can join our
185
-
[community](https://mintlify.com/community) or drop us an email at
You can also join our [community](https://mintlify.com/community) to engage with other Mintlify users and stay up to date with the latest feature drops.
0 commit comments