Skip to content

Commit 1e064e2

Browse files
Update quickstart.mdx
1 parent 166aee8 commit 1e064e2

File tree

1 file changed

+26
-126
lines changed

1 file changed

+26
-126
lines changed

quickstart.mdx

Lines changed: 26 additions & 126 deletions
Original file line numberDiff line numberDiff line change
@@ -1,158 +1,58 @@
11
---
22
title: "Quickstart"
3-
description: "Get your documentation site live in under 10 minutes"
3+
description: "Get your documentation site live in under 5 minutes"
44
icon: "rocket"
55
---
66

7-
Transform your documentation from idea to live site in minutes. No complex setup, no waiting around.
7+
## 1. Create your site
88

9-
<CardGroup cols={2}>
10-
<Card title="🚀 Launch in 5 minutes" icon="clock">
11-
Get a live site with zero configuration
12-
</Card>
13-
<Card title="✨ Edit anywhere" icon="edit">
14-
Browser editor or local development
15-
</Card>
16-
</CardGroup>
17-
18-
## Get started now
19-
20-
### 1. Create your site
21-
22-
Visit [mintlify.com/start](https://mintlify.com/start) and sign up. Your documentation site is created instantly and goes live at:
9+
Visit [mintlify.com/start](https://mintlify.com/start) and sign up. Your site goes live instantly at:
2310

2411
```
2512
https://your-project-name.mintlify.app
2613
```
2714

28-
That's it. You now have a live documentation site.
29-
30-
### 2. Make it yours
15+
## 2. Edit your content
3116

3217
<Tabs>
33-
<Tab title="Quick edits">
34-
**Edit in your browser** - no downloads needed
35-
36-
1. Open your [dashboard](https://dashboard.mintlify.com)
37-
2. Click **Editor**
38-
3. Edit any page
18+
<Tab title="Browser editor">
19+
1. Open [dashboard](https://dashboard.mintlify.com)
20+
2. Click **Editor**
21+
3. Edit pages
3922
4. Hit **Publish**
40-
41-
Changes go live instantly.
4223
</Tab>
4324

44-
<Tab title="Full control">
45-
**Work locally** with your preferred tools
46-
25+
<Tab title="Local development">
4726
```bash
4827
npm i -g mint
4928
mint dev
5029
```
5130

52-
Edit `.mdx` files, preview at `localhost:3000`, push to deploy.
31+
Edit `.mdx` files, preview at `localhost:3000`.
5332
</Tab>
5433
</Tabs>
5534

56-
### 3. Connect GitHub (optional)
57-
58-
Enable automatic deployments:
59-
60-
1. **Settings****GitHub App****Install GitHub App**
61-
2. **Settings****My Profile****Authorize GitHub account**
62-
63-
Now every push to your repo updates your site automatically.
64-
65-
## Essential customizations
66-
67-
<CardGroup cols={2}>
68-
<Card title="Brand it" icon="paintbrush">
69-
**Update `docs.json`**
70-
71-
```json
72-
{
73-
"name": "Your Docs",
74-
"logo": "/logo.png",
75-
"colors": {
76-
"primary": "#0D9373"
77-
}
78-
}
79-
```
80-
</Card>
81-
82-
<Card title="Organize content" icon="folder">
83-
**Structure your navigation**
84-
85-
```json
86-
{
87-
"navigation": [
88-
{
89-
"group": "Getting Started",
90-
"pages": ["quickstart", "setup"]
91-
}
92-
]
93-
}
94-
```
95-
</Card>
96-
</CardGroup>
35+
## 3. Customize
9736

98-
### Add your domain
37+
Update `docs.json`:
9938

100-
Replace `.mintlify.app` with your own domain:
101-
102-
1. **Settings****Custom Domain**
103-
2. Enter your domain: `docs.yoursite.com`
104-
3. Add CNAME record:
105-
106-
```
107-
CNAME docs cname.mintlify.app
39+
```json
40+
{
41+
"name": "Your Docs",
42+
"logo": "/logo.png",
43+
"colors": { "primary": "#0D9373" },
44+
"navigation": [
45+
{ "group": "Getting Started", "pages": ["quickstart"] }
46+
]
47+
}
10848
```
10949

110-
<Info>
111-
DNS changes take 5-30 minutes. Use [DNSChecker](https://dnschecker.org) to verify.
112-
</Info>
50+
## Add custom domain
11351

114-
## What you can build
115-
116-
<CardGroup cols={3}>
117-
<Card title="Rich content" icon="file-text" href="/writing-content/page">
118-
MDX, components, interactive elements
119-
</Card>
120-
<Card title="API docs" icon="code" href="/api-playground/overview">
121-
Auto-generated from OpenAPI specs
122-
</Card>
123-
<Card title="Custom themes" icon="palette" href="/themes">
124-
Colors, fonts, layouts
125-
</Card>
126-
</CardGroup>
127-
128-
## Common issues
129-
130-
<AccordionGroup>
131-
<Accordion title="Changes not showing up?">
132-
**GitHub users:** Check Actions tab for build status (takes 1-3 minutes)
133-
134-
**Web editor:** Changes are instant - try refreshing your site
135-
</Accordion>
136-
137-
<Accordion title="mint dev not working?">
138-
Make sure you're in the right directory (where `docs.json` lives) and using Node.js v19+:
139-
140-
```bash
141-
node --version # Should be v19+
142-
cd path/to/your/docs
143-
mint dev
144-
```
145-
</Accordion>
146-
147-
<Accordion title="Domain not connecting?">
148-
1. Double-check your CNAME record
149-
2. Wait for DNS propagation (up to 30 minutes)
150-
3. Verify with [DNSChecker](https://dnschecker.org)
151-
</Accordion>
152-
</AccordionGroup>
52+
1. **Settings****Custom Domain**
53+
2. Enter: `docs.yoursite.com`
54+
3. Add CNAME: `docs → cname.mintlify.app`
15355

15456
---
15557

156-
**Need help?** [Contact support](contact-support) or join our [community](https://community.mintlify.com).
157-
158-
**Ready for more?** Explore [advanced features](/writing-content/page) and [integrations](/integrations/overview).
58+
**Need help?** [Contact support](contact-support)

0 commit comments

Comments
 (0)