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
Copy file name to clipboardExpand all lines: quickstart.mdx
+27-29Lines changed: 27 additions & 29 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,20 +17,20 @@ icon: "rocket"
17
17
18
18
## Getting Started
19
19
20
-
Welcome! Follow the instructions below to learn how to deploy, update and
20
+
Welcome! Follow the instructions below to learn how to deploy, update, and
21
21
supercharge your documentation with Mintlify.
22
22
23
23
### Creating the Repository
24
24
25
25
Mintlify docs are rendered from MDX files and configurations defined in our
26
26
[starter kit](https://github.com/mintlify/starter). We use GitHub to integrate
27
-
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.
27
+
your docs with your code and make source control effortless. Get started by onboarding through the [dashboard](https://dashboard.mintlify.com) or cloning our [starter kit](https://github.com/mintlify/starter).
28
28
29
29
<AccordionGroup>
30
30
31
31
<Accordionicon="message-bot"title="Install the GitHub app">
32
32
33
-
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.
33
+
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
-
3.Use your favorite IDE to open the repository.
73
-
4. Install our Mintlify CLI to preview changes with `npm i -g mintlify`.
2.Clone your docs repository using `git clone <your-repo>`. If you haven't set up Git yet, now would be a good time to do so with [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
+
3.Open the repository in your favorite IDE
73
+
4. Install the Mintlify CLI to preview changes with `npm i -g mintlify`
74
74
75
75
Learn more about this in our [local development guide](/development).
76
76
77
77
</Accordion>
78
78
79
79
<Accordionicon="pen-to-square"title="Editing with the web editor">
80
80
81
-
Learn more about how to use the web editor on our [guide](/web-editor).
81
+
Learn more about how to use the web editor in our [guide](/web-editor).
82
82
83
83
</Accordion>
84
84
85
85
<Accordionicon="palette"title="Customizing to your brand">
86
86
87
-
Easily customize colors, logos and buttons among other configurations in our`docs.json` file. Start with these basic configurations:
87
+
Easily customize colors, logos, and buttons among other configurations in your`docs.json` file. Start with these basic configurations:
88
88
89
89
```json
90
90
"name": "Your Company"
@@ -101,13 +101,13 @@ your docs.
101
101
},
102
102
```
103
103
104
-
A full list of supported configurations can be found at[global settings](/settings/global).
104
+
A full list of supported configurations can be found in our[global settings](/settings/global).
105
105
106
106
</Accordion>
107
107
108
108
<Accordionicon="pencil"title="Adding content">
109
109
110
-
Add content with simple MDX files. Initiate your pages with this template:
110
+
Add content with simple MDX files. Start your pages with this template:
111
111
112
112
```md
113
113
---
@@ -123,40 +123,39 @@ your docs.
123
123
124
124
<Accordionicon="rocket"title="Pushing changes">
125
125
126
-
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).
126
+
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 cannot 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`.
150
+
3.Include the generated endpoint MDX files in your `docs.json` under `navigation`
152
151
153
152
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).
158
+
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
159
161
160
We also support integrations with a range of analytics providers. You can find the list of providers [here](/integrations/analytics/overview).
162
161
@@ -165,22 +164,21 @@ your docs.
165
164
166
165
<Note>
167
166
We provide a white-glove migration service as part of our Enterprise plan.
168
-
Interested? You can request it by [contacting us](mailto:[email protected]).
0 commit comments