|  | 
|  | 1 | +--- | 
|  | 2 | +title: Quickstart | 
|  | 3 | +description: Get started with Mintlify in minutes | 
|  | 4 | +--- | 
|  | 5 | + | 
|  | 6 | +## Welcome to Mintlify | 
|  | 7 | + | 
|  | 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 | 
|  | 18 | + | 
|  | 19 | +<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 | +     | 
|  | 32 | +    ```mdx index.mdx | 
|  | 33 | +    --- | 
|  | 34 | +    title: Welcome | 
|  | 35 | +    description: Welcome to my documentation | 
|  | 36 | +    --- | 
|  | 37 | +     | 
|  | 38 | +    # Welcome to my docs | 
|  | 39 | +     | 
|  | 40 | +    This is your first documentation page. | 
|  | 41 | +    ``` | 
|  | 42 | +  </Step> | 
|  | 43 | + | 
|  | 44 | +  <Step title="Configure navigation"> | 
|  | 45 | +    Create a `docs.json` file to configure your site: | 
|  | 46 | +     | 
|  | 47 | +    ```json docs.json | 
|  | 48 | +    { | 
|  | 49 | +      "name": "My Documentation", | 
|  | 50 | +      "navigation": { | 
|  | 51 | +        "pages": ["index"] | 
|  | 52 | +      } | 
|  | 53 | +    } | 
|  | 54 | +    ``` | 
|  | 55 | +  </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> | 
|  | 68 | + | 
|  | 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 | 
|  | 77 | + | 
|  | 78 | +## Next steps | 
|  | 79 | + | 
|  | 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> | 
0 commit comments