Skip to content

Commit bfcd85f

Browse files
Documentation edits made through Mintlify web editor
1 parent 64fe730 commit bfcd85f

File tree

1 file changed

+27
-55
lines changed

1 file changed

+27
-55
lines changed

quickstart.mdx

Lines changed: 27 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,9 @@ icon: "rocket"
55
---
66

77
<Frame>
8-
<img
9-
className="block dark:hidden"
10-
src="https://mintlify-assets.b-cdn.net/hero-light.png"
11-
/>
12-
<img
13-
className="hidden dark:block"
14-
src="https://mintlify-assets.b-cdn.net/hero-dark.png"
15-
/>
8+
<img className="block dark:hidden" src="https://mintlify-assets.b-cdn.net/hero-light.png" />
9+
10+
<img className="hidden dark:block" src="https://mintlify-assets.b-cdn.net/hero-dark.png" />
1611
</Frame>
1712

1813
## Getting Started
@@ -27,36 +22,26 @@ Mintlify docs are rendered from MDX files and configurations defined in our
2722
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.
2823

2924
<AccordionGroup>
30-
3125
<Accordion icon="message-bot" title="Install the GitHub app">
32-
3326
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.
3427

3528
<Frame>
36-
![GitHub Bot Verification](https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/github-bot-verification.png)
29+
![GitHub Bot Verification](https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/github-bot-verification.png)
3730
</Frame>
38-
3931
</Accordion>
4032

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-
`mint.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>
33+
<Accordion icon="code-branch" title="Monorepo Setup">
34+
If you want your docs to live alongside your code as a monorepo setup, you
35+
can: 1. Move your docs content to your monorepo. 2. Specify the path to your
36+
`mint.json` in the
37+
[dashboard](https://dashboard.mintlify.com/settings/deployment/git-settings)
5938

39+
<Frame>
40+
<img alt="Monorepo setup" className="block dark:hidden" src="/images/monorepo-light.png" />
41+
42+
<img alt="Monorepo setup" className="hidden dark:block" src="/images/monorepo-dark.png" />
43+
</Frame>
44+
</Accordion>
6045
</AccordionGroup>
6146

6247
### Updating the Content
@@ -66,24 +51,22 @@ your docs.
6651

6752
<AccordionGroup>
6853
<Accordion icon="rectangle-terminal" title="Editing locally (recommended for developers)">
69-
7054
1. Install [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git).
55+
7156
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).
57+
7258
3. Use your favorite IDE to open the repository.
59+
7360
4. Install our Mintlify CLI to preview changes with `npm i -g mintlify`.
7461

7562
Learn more about this in our [local development guide](/development).
76-
7763
</Accordion>
7864

7965
<Accordion icon="pen-to-square" title="Editing with the web editor">
80-
8166
Learn more about how to use the web editor on our [guide](/web-editor).
82-
8367
</Accordion>
8468

8569
<Accordion icon="palette" title="Customizing to your brand">
86-
8770
Easily customize colors, logos and buttons among other configurations in our `mint.json` file. Start with these basic configurations:
8871

8972
```json
@@ -102,11 +85,9 @@ your docs.
10285
```
10386

10487
A full list of supported configurations can be found at [global settings](/settings/global).
105-
10688
</Accordion>
10789

10890
<Accordion icon="pencil" title="Adding content">
109-
11091
Add content with simple MDX files. Initiate your pages with this template:
11192

11293
```md
@@ -118,22 +99,18 @@ your docs.
11899
```
119100

120101
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-
122102
</Accordion>
123103

124104
<Accordion icon="rocket" title="Pushing changes">
125-
126105
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).
127106

128-
<Frame>
129-
![Manual
130-
Update](https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/manual-update.png)
131-
</Frame>
132-
107+
<Frame>
108+
![Manual
109+
Update](https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/manual-update.png)
110+
</Frame>
133111
</Accordion>
134112

135113
<Accordion icon="code-branch" title="Generating API references">
136-
137114
You can easily set up your API references using an OpenAPI document.
138115

139116
1. Add your `openapi.yaml` or `openapi.json` file into your docs repository or define the `openapi` field in `mint.json` with a URL.
@@ -151,15 +128,12 @@ your docs.
151128
3. Finally, include the generated endpoint MDX files to your `mint.json` under `navigation`.
152129

153130
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-
155131
</Accordion>
156132

157133
<Accordion icon="chart-simple" title="Adding analytics">
158-
159134
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).
160135

161136
We also support integrations with a range of analytics providers. You can find the list of providers [here](/integrations/analytics/overview).
162-
163137
</Accordion>
164138
</AccordionGroup>
165139

@@ -171,16 +145,14 @@ your docs.
171145
### Publishing
172146

173147
<Accordion icon="star" title="Adding a custom domain">
148+
Integrate your docs into your website by hosting them on a custom domain. This is included in the free plan.
174149

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

152+
<Frame>![Custom Domain](/images/custom-domain.png)</Frame>
181153
</Accordion>
182154

183155
Congrats! You've set up your Mintlify Docs and it's looking amazing! Need
184156
support or want to give some feedback? You can join our
185-
[community](https://mintlify.com/community) or drop us an email at
186-
157+
[community](https://join.slack.com/t/mintlify-users/shared_invite/zt-2ycm40ref-_HaWTg56T~2QdaJMT_dVyA) or drop us an email at
158+

0 commit comments

Comments
 (0)