@@ -4,126 +4,155 @@ description: "Get your documentation site live in under 10 minutes"
44icon : " rocket"
55---
66
7- Create beautiful documentation in minutes. This guide gets you from zero to a live documentation site with automatic deployments .
7+ Transform your documentation from idea to live site in minutes. No complex setup, no waiting around .
88
9- ## Step 1: Create your account
10-
11- Sign up at [ mintlify.com/start] ( https://mintlify.com/start ) . Your first documentation site is created automatically during onboarding.
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 >
1217
13- Your site goes live immediately at ` https://<your-project-name>.mintlify.app ` .
18+ ## Get started now
1419
15- ## Step 2: Connect GitHub
20+ ### 1. Create your site
1621
17- Enable automatic deployments by connecting your GitHub repository.
22+ Visit [ mintlify.com/start ] ( https://mintlify.com/start ) and sign up. Your documentation site is created instantly and goes live at:
1823
19- <Steps >
20- <Step title = " Install GitHub App" >
21- Go to ** Settings** → ** GitHub App** and click ** Install GitHub App** . Select your organization and repositories.
22- </Step >
23- <Step title = " Authorize account" >
24- Navigate to ** Settings** → ** My Profile** and click ** Authorize GitHub account** .
25- </Step >
26- </Steps >
24+ ```
25+ https://your-project-name.mintlify.app
26+ ```
2727
28- ## Step 3: Start editing
28+ That's it. You now have a live documentation site.
2929
30- Choose how you want to work with your documentation:
30+ ### 2. Make it yours
3131
3232<Tabs >
33- <Tab title = " Web Editor " >
34- Edit directly in your browser - no setup required.
33+ <Tab title = " Quick edits " >
34+ ** Edit in your browser** - no downloads needed
3535
3636 1. Open your [ dashboard] ( https://dashboard.mintlify.com )
37- 2. Click ** Editor** in the sidebar
38- 3. Select any file to start editing
39- 4. Click ** Publish** to deploy changes instantly
37+ 2. Click ** Editor**
38+ 3. Edit any page
39+ 4. Hit ** Publish**
4040
41- <Frame >
42- <img alt = " Web editor" src = " /images/quickstart/web-editor-light.png" className = " block dark:hidden" />
43- <img alt = " Web editor" src = " /images/quickstart/web-editor-dark.png" className = " hidden dark:block" />
44- </Frame >
41+ Changes go live instantly.
4542 </Tab >
4643
47- <Tab title = " Local Development " >
48- Work locally with your favorite tools and Git workflow.
44+ <Tab title = " Full control " >
45+ ** Work locally** with your preferred tools
4946
50- ** Install CLI:**
5147 ```bash
5248 npm i -g mint
49+ mint dev
5350 ```
5451
55- ** Edit and preview:**
56- 1. Edit any ` .mdx ` file in your repository
57- 2. Run ` mint dev ` to preview at ` localhost:3000 `
58- 3. Push changes to GitHub for automatic deployment
59-
60- <Warning >
61- Requires Node.js v19+. Check with ` node --version ` .
62- </Warning >
52+ Edit ` .mdx ` files, preview at ` localhost:3000 ` , push to deploy.
6353 </Tab >
6454</Tabs >
6555
66- ## Step 4: Customize your site
56+ ### 3. Connect GitHub (optional)
6757
68- Make it yours with these quick customizations :
58+ Enable automatic deployments :
6959
70- <CardGroup cols = { 3 } >
71- <Card title = " Brand colors" icon = " palette" >
72- Update ` docs.json ` with your brand colors and logo
73- </Card >
74- <Card title = " Navigation" icon = " bars" >
75- Organize pages into groups and sections
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+ ```
7680 </Card >
77- <Card title = " Custom domain" icon = " globe" >
78- Replace ` .mintlify.app ` with your own domain
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+ ```
7995 </Card >
8096</CardGroup >
8197
82- ### Add a custom domain
98+ ### Add your domain
99+
100+ Replace ` .mintlify.app ` with your own domain:
83101
84- 1 . Go to ** Settings** → ** Custom Domain**
85- 2 . Enter your domain (e.g., ` docs.company .com ` )
86- 3 . Add this CNAME record to your DNS :
102+ 1 . ** Settings** → ** Custom Domain**
103+ 2 . Enter your domain: ` docs.yoursite .com `
104+ 3 . Add CNAME record:
87105
88- | Type | Name | Value | TTL |
89- | ------ | ------ | ------- | ----- |
90- | CNAME | docs | cname.mintlify.app | 3600 |
106+ ```
107+ CNAME docs cname.mintlify.app
108+ ```
91109
92110<Info >
93- DNS changes take 5-30 minutes to propagate .
111+ DNS changes take 5-30 minutes. Use [ DNSChecker ] ( https://dnschecker.org ) to verify .
94112</Info >
95113
96- ## What's next?
114+ ## What you can build
97115
98- <CardGroup cols = { 2 } >
99- <Card title = " Write content" icon = " pen " href = " /writing-content/page" >
100- Learn MDX syntax and use interactive components
116+ <CardGroup cols = { 3 } >
117+ <Card title = " Rich content" icon = " file-text " href = " /writing-content/page" >
118+ MDX, components, interactive elements
101119 </Card >
102120 <Card title = " API docs" icon = " code" href = " /api-playground/overview" >
103- Generate interactive API documentation
104- </Card >
105- <Card title = " Themes" icon = " paintbrush" href = " /themes" >
106- Customize colors, fonts, and styling
121+ Auto-generated from OpenAPI specs
107122 </Card >
108- <Card title = " Analytics " icon = " chart-line " href = " /analytics/overview " >
109- Track usage and optimize your documentation
123+ <Card title = " Custom themes " icon = " palette " href = " /themes " >
124+ Colors, fonts, layouts
110125 </Card >
111126</CardGroup >
112127
113- ## Troubleshooting
128+ ## Common issues
114129
115130<AccordionGroup >
116- <Accordion title = " Site not updating after pushing changes" >
117- Check GitHub Actions for build errors. Builds typically take 1-3 minutes.
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
118135 </Accordion >
119136
120- <Accordion title = " Local preview not working" >
121- Ensure Node.js v19+ is installed and run ` mint dev ` from your project root (where ` docs.json ` exists).
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+ ```
122145 </Accordion >
123146
124- <Accordion title = " Custom domain not connecting" >
125- Verify your CNAME record and wait for DNS propagation. Use [ DNSChecker] ( https://dnschecker.org ) to verify.
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 )
126151 </Accordion >
127152</AccordionGroup >
128153
129- Need more help? [ Contact support] ( contact-support ) or check our [ community forum] ( https://community.mintlify.com ) .
154+ ---
155+
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 ) .
0 commit comments