Skip to content

Commit e141434

Browse files
mintlify-development[bot]mintlify-development[bot]
authored
Update quickstart.mdx
1 parent 1c9f74f commit e141434

File tree

1 file changed

+128
-86
lines changed

1 file changed

+128
-86
lines changed

‎quickstart.mdx‎

Lines changed: 128 additions & 86 deletions
Original file line numberDiff line numberDiff line change
@@ -1,126 +1,168 @@
11
---
2-
title: Quickstart
3-
description: Get up and running with Mintlify in minutes
2+
title: "Quickstart"
3+
description: "Get your documentation site up and running in minutes with Mintlify"
4+
icon: "rocket"
45
---
56

6-
Get your documentation site up and running in under 5 minutes.
7+
Get your documentation site live in under 5 minutes. This guide walks you through creating, customizing, and deploying your first Mintlify docs site.
78

89
## Prerequisites
910

10-
- [Node.js](https://nodejs.org/en/) (version 18 or higher)
1111
- A GitHub account
1212
- Basic familiarity with Markdown
1313

14-
## Installation
14+
## Step 1: Create your docs repository
1515

1616
<Steps>
17-
<Step title="Install the Mintlify CLI">
18-
Install the Mintlify CLI globally using npm:
19-
17+
<Step title="Fork the starter template">
18+
Visit the [Mintlify starter template](https://github.com/mintlify/starter) and click **Use this template** to create a new repository.
19+
</Step>
20+
21+
<Step title="Clone your repository">
2022
```bash
21-
npm i -g mintlify
23+
git clone https://github.com/your-username/your-docs-repo.git
24+
cd your-docs-repo
2225
```
2326
</Step>
27+
</Steps>
2428

25-
<Step title="Initialize your project">
26-
Create a new documentation project:
27-
29+
## Step 2: Install and preview locally
30+
31+
<Steps>
32+
<Step title="Install the Mintlify CLI">
2833
```bash
29-
mintlify init
34+
npm i -g mintlify
3035
```
31-
32-
This creates a `mint.json` configuration file and sample documentation files.
3336
</Step>
34-
35-
<Step title="Start the development server">
36-
Preview your documentation locally:
37-
37+
38+
<Step title="Preview your docs">
3839
```bash
3940
mintlify dev
4041
```
41-
42-
Your documentation will be available at `http://localhost:3000`.
42+
Your docs will be available at `http://localhost:3000`
4343
</Step>
4444
</Steps>
4545

46-
## Create your first page
47-
48-
1. Open the generated `introduction.mdx` file
49-
2. Replace the content with your own:
50-
51-
```mdx
52-
---
53-
title: Welcome to my docs
54-
description: This is my awesome documentation
55-
---
56-
57-
# Welcome
58-
59-
This is my first documentation page built with Mintlify.
60-
61-
## Getting started
62-
63-
Add your content here using Markdown and MDX components.
64-
```
65-
66-
3. Save the file and see your changes instantly in the browser
67-
68-
## Configure your site
46+
## Step 3: Customize your site
6947

70-
Edit `mint.json` to customize your documentation:
71-
72-
```json mint.json
73-
{
74-
"name": "My Documentation",
75-
"logo": {
76-
"dark": "/logo/dark.svg",
77-
"light": "/logo/light.svg"
78-
},
79-
"favicon": "/favicon.svg",
80-
"colors": {
81-
"primary": "#0D9373",
82-
"light": "#07C983",
83-
"dark": "#0D9373"
84-
},
85-
"navigation": [
48+
<Steps>
49+
<Step title="Update mint.json">
50+
Edit the `mint.json` file to configure your site:
51+
52+
```json mint.json
53+
{
54+
"name": "Your Docs",
55+
"logo": {
56+
"dark": "/logo/dark.svg",
57+
"light": "/logo/light.svg"
58+
},
59+
"favicon": "/favicon.svg",
60+
"colors": {
61+
"primary": "#0D9373",
62+
"light": "#07C983",
63+
"dark": "#0D9373"
64+
}
65+
}
66+
```
67+
</Step>
68+
69+
<Step title="Add your first page">
70+
Create a new `.mdx` file in your repository:
71+
72+
```markdown introduction.mdx
73+
---
74+
title: 'My First Page'
75+
description: 'This is my first documentation page'
76+
---
77+
78+
# Welcome to my docs
79+
80+
This is the beginning of something great!
81+
```
82+
</Step>
83+
84+
<Step title="Update navigation">
85+
Add your new page to the navigation in `mint.json`:
86+
87+
```json mint.json
8688
{
87-
"group": "Get Started",
88-
"pages": ["introduction"]
89+
"navigation": [
90+
{
91+
"group": "Get Started",
92+
"pages": ["introduction"]
93+
}
94+
]
8995
}
90-
]
91-
}
92-
```
96+
```
97+
</Step>
98+
</Steps>
9399

94-
## Deploy your site
100+
## Step 4: Deploy your site
101+
102+
<Steps>
103+
<Step title="Connect to Mintlify">
104+
1. Go to [mintlify.com](https://mintlify.com) and sign in with GitHub
105+
2. Click **Create new docs** and select your repository
106+
3. Your site will automatically deploy
107+
</Step>
108+
109+
<Step title="Get your live URL">
110+
Your docs are now live at `https://your-repo-name.mintlify.app`
111+
</Step>
112+
</Steps>
95113

96114
<CardGroup cols={2}>
97-
<Card title="Deploy with GitHub" icon="github" href="/settings/github">
98-
Connect your repository and deploy automatically
115+
<Card title="Customize your site" icon="palette" href="/settings">
116+
Configure colors, fonts, and branding to match your style
117+
</Card>
118+
119+
<Card title="Add components" icon="puzzle-piece" href="/text">
120+
Enhance your docs with interactive components and rich content
121+
</Card>
122+
123+
<Card title="Set up analytics" icon="chart-line" href="/integrations/analytics/overview">
124+
Track how users interact with your documentation
99125
</Card>
126+
100127
<Card title="Custom domain" icon="globe" href="/settings/custom-domain">
101-
Set up your own domain name
128+
Use your own domain for a professional look
102129
</Card>
103130
</CardGroup>
104131

132+
## Troubleshooting
133+
134+
<AccordionGroup>
135+
<Accordion title="CLI installation fails">
136+
If you encounter permission errors, try:
137+
```bash
138+
sudo npm i -g mintlify
139+
```
140+
141+
Or use a Node version manager like [nvm](https://github.com/nvm-sh/nvm).
142+
</Accordion>
143+
144+
<Accordion title="Local preview not working">
145+
Make sure you're in the correct directory and have a valid `mint.json` file. Try:
146+
```bash
147+
mintlify install
148+
mintlify dev
149+
```
150+
</Accordion>
151+
152+
<Accordion title="Deployment issues">
153+
Check that:
154+
- Your repository is public or you've granted Mintlify access
155+
- Your `mint.json` file is valid JSON
156+
- All referenced pages exist in your repository
157+
</Accordion>
158+
</AccordionGroup>
159+
105160
## Next steps
106161

107-
<CardGroup cols={2}>
108-
<Card title="Add components" icon="puzzle-piece" href="/components/accordions">
109-
Enhance your docs with interactive components
110-
</Card>
111-
<Card title="Set up analytics" icon="chart-line" href="/integrations/analytics/overview">
112-
Track how users interact with your documentation
113-
</Card>
114-
<Card title="Configure navigation" icon="list" href="/navigation">
115-
Organize your content with custom navigation
116-
</Card>
117-
<Card title="Customize themes" icon="palette" href="/themes">
118-
Make your documentation match your brand
162+
<CardGroup cols={1}>
163+
<Card title="Learn about pages and navigation" icon="map" href="/pages">
164+
Understand how to structure and organize your documentation
119165
</Card>
120166
</CardGroup>
121167

122-
## Need help?
123-
124-
<Card title="Contact support" icon="life-buoy" href="/contact-support">
125-
Get help from our support team
126-
</Card>
168+
Your documentation site is now live! Continue customizing and adding content to create the perfect docs experience for your users.

0 commit comments

Comments
 (0)