Quickstart

Start building modern documentation in under five minutes

Getting Started

Welcome to Mintlify! Here’s how to get your documentation up and running quickly.

1. Create Your Documentation Repository

1. Clone our starter template into a new repository
2. Install our GitHub app to enable automatic deployments

2. Edit Your Content

Choose your preferred editing method:

Local Development (Recommended)

1. Install git
2. Clone your repository: git clone <your-repo>
3. Install Mintlify CLI: npm i -g mintlify
4. Start local development: mintlify dev

Web Editor

Use our web editor for quick updates. Learn more in our web editor guide.

3. Customize Your Docs

Update your mint.json file to match your brand:

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

4. Add Content

Create new pages using MDX files with this template:

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

5. Deploy

Push your changes to GitHub to automatically deploy your updates.

Need help? Join our community or contact [e-mail].