|  | 
|  | 1 | +--- | 
|  | 2 | +title: Quickstart | 
|  | 3 | +description: Get up and running with Mintlify in minutes | 
|  | 4 | +--- | 
|  | 5 | + | 
|  | 6 | +Get your documentation site up and running in under 5 minutes. | 
|  | 7 | + | 
|  | 8 | +## Prerequisites | 
|  | 9 | + | 
|  | 10 | +- [Node.js](https://nodejs.org/en/) (version 18 or higher) | 
|  | 11 | +- A GitHub account | 
|  | 12 | +- Basic familiarity with Markdown | 
|  | 13 | + | 
|  | 14 | +## Installation | 
|  | 15 | + | 
|  | 16 | +<Steps> | 
|  | 17 | +  <Step title="Install the Mintlify CLI"> | 
|  | 18 | +    Install the Mintlify CLI globally using npm: | 
|  | 19 | +     | 
|  | 20 | +    ```bash | 
|  | 21 | +    npm i -g mintlify | 
|  | 22 | +    ``` | 
|  | 23 | +  </Step> | 
|  | 24 | + | 
|  | 25 | +  <Step title="Initialize your project"> | 
|  | 26 | +    Create a new documentation project: | 
|  | 27 | +     | 
|  | 28 | +    ```bash | 
|  | 29 | +    mintlify init | 
|  | 30 | +    ``` | 
|  | 31 | +     | 
|  | 32 | +    This creates a `mint.json` configuration file and sample documentation files. | 
|  | 33 | +  </Step> | 
|  | 34 | + | 
|  | 35 | +  <Step title="Start the development server"> | 
|  | 36 | +    Preview your documentation locally: | 
|  | 37 | +     | 
|  | 38 | +    ```bash | 
|  | 39 | +    mintlify dev | 
|  | 40 | +    ``` | 
|  | 41 | +     | 
|  | 42 | +    Your documentation will be available at `http://localhost:3000`. | 
|  | 43 | +  </Step> | 
|  | 44 | +</Steps> | 
|  | 45 | + | 
|  | 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 | 
|  | 69 | + | 
|  | 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": [ | 
|  | 86 | +    { | 
|  | 87 | +      "group": "Get Started", | 
|  | 88 | +      "pages": ["introduction"] | 
|  | 89 | +    } | 
|  | 90 | +  ] | 
|  | 91 | +} | 
|  | 92 | +``` | 
|  | 93 | + | 
|  | 94 | +## Deploy your site | 
|  | 95 | + | 
|  | 96 | +<CardGroup cols={2}> | 
|  | 97 | +  <Card title="Deploy with GitHub" icon="github" href="/settings/github"> | 
|  | 98 | +    Connect your repository and deploy automatically | 
|  | 99 | +  </Card> | 
|  | 100 | +  <Card title="Custom domain" icon="globe" href="/settings/custom-domain"> | 
|  | 101 | +    Set up your own domain name | 
|  | 102 | +  </Card> | 
|  | 103 | +</CardGroup> | 
|  | 104 | + | 
|  | 105 | +## Next steps | 
|  | 106 | + | 
|  | 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 | 
|  | 119 | +  </Card> | 
|  | 120 | +</CardGroup> | 
|  | 121 | + | 
|  | 122 | +## Need help? | 
|  | 123 | + | 
|  | 124 | +<Card title="Contact support" icon="life-buoy" href="/contact-support"> | 
|  | 125 | +  Get help from our support team | 
|  | 126 | +</Card> | 
0 commit comments