Quickstart

Start building modern documentation in under five minutes

Getting Started

Follow these steps to set up your documentation with Mintlify:

1. Create Your Documentation Repository

1. Use our starter template to create a new repository
2. Install our GitHub app from your dashboard settings for automatic deployments

2. Update Your Content

Choose your preferred editing method:

Local Development (Recommended)

1. Clone your repository: git clone <your-repo>
2. Install Mintlify CLI: npm i -g mintlify
3. Start editing in your IDE
4. Preview changes locally with mintlify dev

Web Editor

Use our web editor for quick updates - learn more in our web editor guide.

3. Customize Your Docs

Update mint.json with your brand settings:

{
  "name": "Your Company",
  "logo": {
    "light": "/logo/light.svg",
    "dark": "/logo/dark.svg"
  },
  "colors": {
    "primary": "#2AB673"
  }
}

4. Add Content

Create new pages using MDX:

---
title: "Page Title"
description: "Page description"
---

5. Deploy

1. Commit and push your changes
2. Your site will automatically update
3. Add a custom domain through your dashboard settings

Need help? Join our community or email us at [e-mail].