Skip to content

Commit 637ed2a

Browse files
Documentation edits made through Mintlify web editor
1 parent 4b26a4e commit 637ed2a

File tree

1 file changed

+32
-62
lines changed

1 file changed

+32
-62
lines changed

quickstart.mdx

Lines changed: 32 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,13 @@
1-
---
2-
title: "Quickstart"
3-
description: "Start building modern documentation in under five minutes"
4-
icon: "rocket"
5-
---
1+
#
62

73
<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-
/>
4+
<img className="block dark:hidden" src="https://mintlify-assets.b-cdn.net/hero-light.png" />
5+
6+
<img className="hidden dark:block" src="https://mintlify-assets.b-cdn.net/hero-dark.png" />
167
</Frame>
178

9+
# Ruhan Test
10+
1811
## Getting Started
1912

2013
Welcome! Follow the instructions below to learn how to deploy, update and
@@ -27,36 +20,26 @@ Mintlify docs are rendered from MDX files and configurations defined in our
2720
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.
2821

2922
<AccordionGroup>
30-
3123
<Accordion icon="message-bot" title="Install the GitHub app">
32-
3324
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.
3425

3526
<Frame>
36-
![GitHub Bot Verification](https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/github-bot-verification.png)
27+
![GitHub Bot Verification](https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/github-bot-verification.png)
3728
</Frame>
38-
3929
</Accordion>
4030

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>
31+
<Accordion icon="code-branch" title="Monorepo Setup">
32+
If you want your docs to live alongside your code as a monorepo setup, you
33+
can: 1. Move your docs content to your monorepo. 2. Specify the path to your
34+
`mint.json` in the
35+
[dashboard](https://dashboard.mintlify.com/settings/deployment/git-settings)
36+
37+
<Frame>
38+
<img alt="Monorepo setup" className="block dark:hidden" src="/images/monorepo-light.png" />
5939

40+
<img alt="Monorepo setup" className="hidden dark:block" src="/images/monorepo-dark.png" />
41+
</Frame>
42+
</Accordion>
6043
</AccordionGroup>
6144

6245
### Updating the Content
@@ -66,25 +49,23 @@ your docs.
6649

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

7560
Learn more about this in our [local development guide](/development).
76-
7761
</Accordion>
7862

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

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

8970
```json
9071
"name": "Your Company"
@@ -102,11 +83,9 @@ your docs.
10283
```
10384

10485
A full list of supported configurations can be found at [global settings](/settings/global).
105-
10686
</Accordion>
10787

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

11291
```md
@@ -118,25 +97,21 @@ your docs.
11897
```
11998

12099
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-
122100
</Accordion>
123101

124102
<Accordion icon="rocket" title="Pushing changes">
125-
126103
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).
127104

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

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

139-
1. Add your `openapi.yaml` or `openapi.json` file into your docs repository or define the `openapi` field in `docs.json` with a URL.
114+
1. Add your `openapi.yaml` or `openapi.json` file into your docs repository or define the `openapi` field in `mint.json` with a URL.
140115

141116
```json
142117
"openapi": "link-to-your-openapi-file"
@@ -148,18 +123,15 @@ your docs.
148123
npx @mintlify/scraping@latest openapi-file <path-or-url-to-openapi-file>
149124
```
150125

151-
3. Finally, include the generated endpoint MDX files to your `docs.json` under `navigation`.
126+
3. Finally, include the generated endpoint MDX files to your `mint.json` under `navigation`.
152127

153128
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-
155129
</Accordion>
156130

157131
<Accordion icon="chart-simple" title="Adding analytics">
158-
159132
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).
160133

161134
We also support integrations with a range of analytics providers. You can find the list of providers [here](/integrations/analytics/overview).
162-
163135
</Accordion>
164136
</AccordionGroup>
165137

@@ -171,16 +143,14 @@ your docs.
171143
### Publishing
172144

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

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>
148+
Navigate to your [dashboard settings](https://www.dashboard.mintlify.com/settings) to add a custom domain.
180149

150+
<Frame>![Custom Domain](/images/custom-domain.png)</Frame>
181151
</Accordion>
182152

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

0 commit comments

Comments
 (0)