Skip to content

Commit 6864205

Browse files
Documentation edits made through Mintlify web editor
1 parent a3613c0 commit 6864205

File tree

1 file changed

+46
-64
lines changed

1 file changed

+46
-64
lines changed

quickstart.mdx

Lines changed: 46 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ icon: "rocket"
99
className="block dark:hidden"
1010
src="https://mintlify-assets.b-cdn.net/hero-light.png"
1111
/>
12+
1213
<img
1314
className="hidden dark:block"
1415
src="https://mintlify-assets.b-cdn.net/hero-dark.png"
@@ -20,43 +21,44 @@ icon: "rocket"
2021
Welcome! Follow the instructions below to learn how to deploy, update and
2122
supercharge your documentation with Mintlify.
2223

24+
<Info>
25+
callout
26+
</Info>
27+
2328
### Creating the Repository
2429

2530
Mintlify docs are rendered from MDX files and configurations defined in our
2631
[starter kit](https://github.com/mintlify/starter). We use GitHub to integrate
2732
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.
2833

2934
<AccordionGroup>
30-
31-
<Accordion icon="message-bot" title="Install the GitHub app">
32-
35+
<Accordion title="Install the GitHub app" icon="message-bot">
3336
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.
3437

3538
<Frame>
36-
![GitHub Bot Verification](https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/github-bot-verification.png)
39+
![GitHub Bot Verification](https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/github-bot-verification.png)
3740
</Frame>
38-
3941
</Accordion>
42+
<Accordion title="Monorepo Setup" icon="code-branch">
43+
If you want your docs to live alongside your code as a monorepo setup, you
44+
can: 1. Move your docs content to your monorepo. 2. Specify the path to your
45+
`docs.json` in the
46+
[dashboard](https://dashboard.mintlify.com/settings/deployment/git-settings)
4047

41-
<Accordion icon="code-branch" title="Monorepo Setup">
42-
If you want your docs to live alongside your code as a monorepo setup, you
43-
can: 1. Move your docs content to your monorepo. 2. Specify the path to your
44-
`docs.json` in the
45-
[dashboard](https://dashboard.mintlify.com/settings/deployment/git-settings)
46-
<Frame>
47-
<img
48-
alt="Monorepo setup"
49-
className="block dark:hidden"
50-
src="/images/monorepo-light.png"
51-
/>
52-
<img
53-
alt="Monorepo setup"
54-
className="hidden dark:block"
55-
src="/images/monorepo-dark.png"
56-
/>
57-
</Frame>
58-
</Accordion>
59-
48+
<Frame>
49+
<img
50+
alt="Monorepo setup"
51+
className="block dark:hidden"
52+
src="/images/monorepo-light.png"
53+
/>
54+
55+
<img
56+
alt="Monorepo setup"
57+
className="hidden dark:block"
58+
src="/images/monorepo-dark.png"
59+
/>
60+
</Frame>
61+
</Accordion>
6062
</AccordionGroup>
6163

6264
### Updating the Content
@@ -65,25 +67,18 @@ Mintlify enables you to easily customize the style, structure, and content of
6567
your docs.
6668

6769
<AccordionGroup>
68-
<Accordion icon="rectangle-terminal" title="Editing locally (recommended for developers)">
69-
70+
<Accordion title="Editing locally (recommended for developers)" icon="rectangle-terminal">
7071
1. Install [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git).
7172
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).
7273
3. Use your favorite IDE to open the repository.
7374
4. Install our Mintlify CLI to preview changes with `npm i -g mintlify`.
7475

7576
Learn more about this in our [local development guide](/development).
76-
7777
</Accordion>
78-
79-
<Accordion icon="pen-to-square" title="Editing with the web editor">
80-
78+
<Accordion title="Editing with the web editor" icon="pen-to-square">
8179
Learn more about how to use the web editor on our [guide](/web-editor).
82-
8380
</Accordion>
84-
85-
<Accordion icon="palette" title="Customizing to your brand">
86-
81+
<Accordion title="Customizing to your brand" icon="palette">
8782
Easily customize colors, logos and buttons among other configurations in our `docs.json` file. Start with these basic configurations:
8883

8984
```json
@@ -102,11 +97,8 @@ your docs.
10297
```
10398

10499
A full list of supported configurations can be found at [global settings](/settings/global).
105-
106100
</Accordion>
107-
108-
<Accordion icon="pencil" title="Adding content">
109-
101+
<Accordion title="Adding content" icon="pencil">
110102
Add content with simple MDX files. Initiate your pages with this template:
111103

112104
```md
@@ -118,22 +110,16 @@ your docs.
118110
```
119111

120112
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-
122113
</Accordion>
123-
124-
<Accordion icon="rocket" title="Pushing changes">
125-
114+
<Accordion title="Pushing changes" icon="rocket">
126115
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).
127116

128-
<Frame>
129-
![Manual
130-
Update](https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/manual-update.png)
131-
</Frame>
132-
117+
<Frame>
118+
![Manual
119+
Update](https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/manual-update.png)
120+
</Frame>
133121
</Accordion>
134-
135-
<Accordion icon="code-branch" title="Generating API references">
136-
122+
<Accordion title="Generating API references" icon="code-branch">
137123
You can easily set up your API references using an OpenAPI document.
138124

139125
1. Add your `openapi.yaml` or `openapi.json` file into your docs repository or define the `openapi` field in `docs.json` with a URL.
@@ -142,24 +128,20 @@ your docs.
142128
"openapi": "link-to-your-openapi-file"
143129
```
144130

145-
2. Use our [scraper](/api-playground/openapi/setup#autogenerate-files-recommended) to autogenerate your OpenAPI endpoints files as:
131+
1. Use our [scraper](/api-playground/openapi/setup#autogenerate-files-recommended) to autogenerate your OpenAPI endpoints files as:
146132

147133
```bash
148134
npx @mintlify/scraping@latest openapi-file <path-or-url-to-openapi-file>
149135
```
150136

151-
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`.
152138

153139
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).
154-
155140
</Accordion>
156-
157-
<Accordion icon="chart-simple" title="Adding analytics">
158-
141+
<Accordion title="Adding analytics" icon="chart-simple">
159142
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).
160143

161144
We also support integrations with a range of analytics providers. You can find the list of providers [here](/integrations/analytics/overview).
162-
163145
</Accordion>
164146
</AccordionGroup>
165147

@@ -170,17 +152,17 @@ your docs.
170152

171153
### Publishing
172154

173-
<Accordion icon="star" title="Adding a custom domain">
155+
<Accordion title="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.
174157

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.
178-
179-
<Frame>![Custom Domain](/images/custom-domain.png)</Frame>
158+
Navigate to your [dashboard settings](https://dashboard.mintlify.com/settings) to add a custom domain.
180159

160+
<Frame>
161+
![Custom Domain](/images/custom-domain.png)
162+
</Frame>
181163
</Accordion>
182164

183165
Congrats! You've set up your Mintlify Docs and it's looking amazing! Need
184166
support or want to give some feedback? You can join our
185167
[community](https://mintlify.com/community) or drop us an email at
186-
168+

0 commit comments

Comments
 (0)