Skip to content

Commit 715cee8

Browse files
mintlify-development[bot]mintlify-development[bot]
authored
Documentation edits made through Mintlify web editor
1 parent 57798ba commit 715cee8

19 files changed

+1878
-152
lines changed

‎NationalParksPoster.jpg‎

976 KB
Loading

‎analytics/amplitude.mdx‎

Lines changed: 158 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,158 @@
1+
---
2+
title: "Quickstart"
3+
description: "Start building modern documentation in under five minutes"
4+
icon: "rocket"
5+
---
6+
7+
<Frame>
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" />
11+
</Frame>
12+
13+
## Getting Started
14+
15+
Welcome! Follow the instructions below to learn how to deploy, update and
16+
supercharge your documentation with Mintlify.
17+
18+
### Creating the Repository
19+
20+
Mintlify docs are rendered from MDX files and configurations defined in our
21+
[starter kit](https://github.com/mintlify/starter). We use GitHub to integrate
22+
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.
23+
24+
<AccordionGroup>
25+
<Accordion icon="message-bot" title="Install the GitHub app">
26+
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.
27+
28+
<Frame>
29+
![GitHub Bot Verification](https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/github-bot-verification.png)
30+
</Frame>
31+
</Accordion>
32+
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)
38+
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>
45+
</AccordionGroup>
46+
47+
### Updating the Content
48+
49+
Mintlify enables you to easily customize the style, structure, and content of
50+
your docs.
51+
52+
<AccordionGroup>
53+
<Accordion icon="rectangle-terminal" title="Editing locally (recommended for developers)">
54+
1. Install [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git).
55+
56+
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+
58+
3. Use your favorite IDE to open the repository.
59+
60+
4. Install our Mintlify CLI to preview changes with `npm i -g mintlify`.
61+
62+
Learn more about this in our [local development guide](/development).
63+
</Accordion>
64+
65+
<Accordion icon="pen-to-square" title="Editing with the web editor">
66+
Learn more about how to use the web editor on our [guide](/web-editor).
67+
</Accordion>
68+
69+
<Accordion icon="palette" title="Customizing to your brand">
70+
Easily customize colors, logos and buttons among other configurations in our `mint.json` file. Start with these basic configurations:
71+
72+
```json
73+
"name": "Your Company"
74+
"logo": {
75+
"light": "/logo/light.svg",
76+
"dark": "/logo/dark.svg",
77+
"href": "https://yourcompany.com"
78+
},
79+
"favicon": "/favicon.svg",
80+
"colors": {
81+
"primary": "#2AB673",
82+
"light": "#55D799",
83+
"dark": "#117866",
84+
},
85+
```
86+
87+
A full list of supported configurations can be found at [global settings](/settings/global).
88+
</Accordion>
89+
90+
<Accordion icon="pencil" title="Adding content">
91+
Add content with simple MDX files. Initiate your pages with this template:
92+
93+
```md
94+
---
95+
title: "Page Title"
96+
sidebarTitle: "Sidebar title (optional - if different from page title)"
97+
description: "Subtitle (optional)"
98+
---
99+
```
100+
101+
Learn more about adding images, tables, lists, and more using the [MDX syntax](/text). We also offer a [wide array of components](/content/components).
102+
</Accordion>
103+
104+
<Accordion icon="rocket" title="Pushing changes">
105+
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).
106+
107+
<Frame>
108+
![Manual
109+
Update](https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/manual-update.png)
110+
</Frame>
111+
</Accordion>
112+
113+
<Accordion icon="code-branch" title="Generating API references">
114+
You can easily set up your API references using an OpenAPI document.
115+
116+
1. Add your `openapi.yaml` or `openapi.json` file into your docs repository or define the `openapi` field in `mint.json` with a URL.
117+
118+
```json
119+
"openapi": "link-to-your-openapi-file"
120+
```
121+
122+
2. Use our [scraper](/api-playground/openapi/setup#autogenerate-files-recommended) to autogenerate your OpenAPI endpoints files as:
123+
124+
```bash
125+
npx @mintlify/scraping@latest openapi-file <path-or-url-to-openapi-file>
126+
```
127+
128+
3. Finally, include the generated endpoint MDX files to your `mint.json` under `navigation`.
129+
130+
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).
131+
</Accordion>
132+
133+
<Accordion icon="chart-simple" title="Adding analytics">
134+
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).
135+
136+
We also support integrations with a range of analytics providers. You can find the list of providers [here](/integrations/analytics/overview).
137+
</Accordion>
138+
</AccordionGroup>
139+
140+
<Note>
141+
We provide a white-glove migration service as part of our Enterprise plan.
142+
Interested? You can request it by [contacting us](mailto:[email protected]).
143+
</Note>
144+
145+
### Publishing
146+
147+
<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.
149+
150+
Navigate to your [dashboard settings](https://www.dashboard.mintlify.com/settings) to add a custom domain.
151+
152+
<Frame>![Custom Domain](/images/custom-domain.png)</Frame>
153+
</Accordion>
154+
155+
Congrats! You've set up your Mintlify Docs and it's looking amazing! Need
156+
support or want to give some feedback? You can join our
157+
[community](https://mintlify.com/community) or drop us an email at
158+
[[email protected]](mailto:[email protected]).

‎analytics/clearbit.mdx‎

Lines changed: 158 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,158 @@
1+
---
2+
title: "Quickstart"
3+
description: "Start building modern documentation in under five minutes"
4+
icon: "rocket"
5+
---
6+
7+
<Frame>
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" />
11+
</Frame>
12+
13+
## Getting Started
14+
15+
Welcome! Follow the instructions below to learn how to deploy, update and
16+
supercharge your documentation with Mintlify.
17+
18+
### Creating the Repository
19+
20+
Mintlify docs are rendered from MDX files and configurations defined in our
21+
[starter kit](https://github.com/mintlify/starter). We use GitHub to integrate
22+
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.
23+
24+
<AccordionGroup>
25+
<Accordion icon="message-bot" title="Install the GitHub app">
26+
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.
27+
28+
<Frame>
29+
![GitHub Bot Verification](https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/github-bot-verification.png)
30+
</Frame>
31+
</Accordion>
32+
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)
38+
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>
45+
</AccordionGroup>
46+
47+
### Updating the Content
48+
49+
Mintlify enables you to easily customize the style, structure, and content of
50+
your docs.
51+
52+
<AccordionGroup>
53+
<Accordion icon="rectangle-terminal" title="Editing locally (recommended for developers)">
54+
1. Install [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git).
55+
56+
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+
58+
3. Use your favorite IDE to open the repository.
59+
60+
4. Install our Mintlify CLI to preview changes with `npm i -g mintlify`.
61+
62+
Learn more about this in our [local development guide](/development).
63+
</Accordion>
64+
65+
<Accordion icon="pen-to-square" title="Editing with the web editor">
66+
Learn more about how to use the web editor on our [guide](/web-editor).
67+
</Accordion>
68+
69+
<Accordion icon="palette" title="Customizing to your brand">
70+
Easily customize colors, logos and buttons among other configurations in our `mint.json` file. Start with these basic configurations:
71+
72+
```json
73+
"name": "Your Company"
74+
"logo": {
75+
"light": "/logo/light.svg",
76+
"dark": "/logo/dark.svg",
77+
"href": "https://yourcompany.com"
78+
},
79+
"favicon": "/favicon.svg",
80+
"colors": {
81+
"primary": "#2AB673",
82+
"light": "#55D799",
83+
"dark": "#117866",
84+
},
85+
```
86+
87+
A full list of supported configurations can be found at [global settings](/settings/global).
88+
</Accordion>
89+
90+
<Accordion icon="pencil" title="Adding content">
91+
Add content with simple MDX files. Initiate your pages with this template:
92+
93+
```md
94+
---
95+
title: "Page Title"
96+
sidebarTitle: "Sidebar title (optional - if different from page title)"
97+
description: "Subtitle (optional)"
98+
---
99+
```
100+
101+
Learn more about adding images, tables, lists, and more using the [MDX syntax](/text). We also offer a [wide array of components](/content/components).
102+
</Accordion>
103+
104+
<Accordion icon="rocket" title="Pushing changes">
105+
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).
106+
107+
<Frame>
108+
![Manual
109+
Update](https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/manual-update.png)
110+
</Frame>
111+
</Accordion>
112+
113+
<Accordion icon="code-branch" title="Generating API references">
114+
You can easily set up your API references using an OpenAPI document.
115+
116+
1. Add your `openapi.yaml` or `openapi.json` file into your docs repository or define the `openapi` field in `mint.json` with a URL.
117+
118+
```json
119+
"openapi": "link-to-your-openapi-file"
120+
```
121+
122+
2. Use our [scraper](/api-playground/openapi/setup#autogenerate-files-recommended) to autogenerate your OpenAPI endpoints files as:
123+
124+
```bash
125+
npx @mintlify/scraping@latest openapi-file <path-or-url-to-openapi-file>
126+
```
127+
128+
3. Finally, include the generated endpoint MDX files to your `mint.json` under `navigation`.
129+
130+
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).
131+
</Accordion>
132+
133+
<Accordion icon="chart-simple" title="Adding analytics">
134+
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).
135+
136+
We also support integrations with a range of analytics providers. You can find the list of providers [here](/integrations/analytics/overview).
137+
</Accordion>
138+
</AccordionGroup>
139+
140+
<Note>
141+
We provide a white-glove migration service as part of our Enterprise plan.
142+
Interested? You can request it by [contacting us](mailto:[email protected]).
143+
</Note>
144+
145+
### Publishing
146+
147+
<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.
149+
150+
Navigate to your [dashboard settings](https://www.dashboard.mintlify.com/settings) to add a custom domain.
151+
152+
<Frame>![Custom Domain](/images/custom-domain.png)</Frame>
153+
</Accordion>
154+
155+
Congrats! You've set up your Mintlify Docs and it's looking amazing! Need
156+
support or want to give some feedback? You can join our
157+
[community](https://mintlify.com/community) or drop us an email at
158+
[[email protected]](mailto:[email protected]).

0 commit comments

Comments
 (0)