@@ -3,92 +3,36 @@ title: Quickstart
33description : Get started with Mintlify in minutes 
44--- 
55
6- ## Welcome to Mintlify  
6+ ## Get started  
77
8- Get your documentation site up and running in just a few minutes with this quickstart guide.
9- 
10- ## Prerequisites  
11- 
12- Before you begin, make sure you have:
13- -  A GitHub account
14- -  Basic familiarity with Markdown
15- -  Your documentation content ready
16- 
17- ## Step 1: Create your documentation  
8+ Create your documentation in 3 steps:
189
1910<Steps >
20-   <Step  title = " Initialize your project" 
21-     Start by creating a new repository or using an existing one for your documentation.
22-     
23-     ```bash
24-     mkdir my-docs
25-     cd my-docs
26-     ```
27-   </Step >
28- 
29-   <Step  title = " Add your first page" 
30-     Create an ` index.mdx `  file in your project root:
31-     
11+   <Step  title = " Create index.mdx" 
3212    ``` mdx index.mdx 
3313    --- 
3414    title: Welcome
35-     description: Welcome to my documentation
3615    ---
37-     
3816    # Welcome to my docs
39-     
40-     This is your first documentation page.
4117    ``` 
4218  </Step >
4319
44-   <Step  title = " Configure navigation" 
45-     Create a ` docs.json `  file to configure your site:
46-     
20+   <Step  title = " Add docs.json" 
4721    ``` json docs.json 
4822    {
4923      "name" : " My Documentation" 
50-       " navigation" 
51-         " pages" " index" 
52-       }
24+       "navigation" : { "pages" : [" index" 
5325    }
5426    ``` 
5527  </Step >
56- </Steps >
57- 
58- ## Step 2: Connect to Mintlify  
59- 
60- <CardGroup  cols = { 2 } >
61-   <Card  title = " GitHub Integration" icon = " github" href = " /settings/github" 
62-     Connect your repository to automatically deploy changes
63-   </Card >
64-   <Card  title = " Custom Domain" icon = " globe" href = " /settings/custom-domain" 
65-     Set up your custom domain for professional branding
66-   </Card >
67- </CardGroup >
6828
69- ## Step 3: Customize your site  
70- 
71- Once your basic site is running, you can:
72- 
73- -  ** Add more pages**  - Create additional ` .mdx `  files and add them to your navigation
74- -  ** Style your site**  - Configure themes and colors in your ` docs.json ` 
75- -  ** Add components**  - Use Mintlify's built-in components for rich content
76- -  ** Set up analytics**  - Track how users interact with your documentation
29+   <Step  title = " Connect GitHub" 
30+     Link your repository in [ GitHub settings] ( /settings/github )  to deploy automatically.
31+   </Step >
32+ </Steps >
7733
7834## Next steps  
7935
80- <Card  title = " Installation Guide" icon = " download" href = " /installation" 
81-   Learn about advanced installation options and local development
82- </Card >
83- 
84- ## Need help?  
85- 
86- If you run into any issues:
87- 
88- 1 .  Check our [ troubleshooting guide] ( /editor/troubleshooting ) 
89- 2 .  Browse our [ component library] ( /components/accordions )  for examples
90- 3 .  [ Contact support] ( /contact-support )  if you need assistance
91- 
92- <Tip >
93- Your documentation will automatically update when you push changes to your connected repository.
94- </Tip >
36+ -  Add more ` .mdx `  files and update navigation
37+ -  Customize styling in ` docs.json ` 
38+ -  See [ installation guide] ( /installation )  for advanced options
0 commit comments