Quickstart

Start building modern documentation in under five minutes

Getting Started

Follow these steps to deploy and update your documentation with Mintlify.

1. Create Your Repository

1. Clone our starter template into a new repository
2. Install our GitHub app from your dashboard settings for automatic deployments

2. Update Content

Choose your preferred editing method:

• Local Development (Recommended):
  1. Clone your repository
  2. Install Mintlify CLI: npm i -g mintlify
  3. Start local development server
• Web Editor: Edit directly through our web interface at dashboard.mintlify.com

3. Customize Your Docs

Update mint.json to configure your documentation:

{
  "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: "Description"
---

5. Deploy

1. Push changes to your repository
2. Verify deployment on your dashboard
3. Optional: Add a custom domain in dashboard settings

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