Quickstart

Start building modern documentation in under five minutes

Getting Started

Follow these steps to set up and customize your documentation with Mintlify.

Setting Up Your Repository

Create your documentation repository

1. Use our starter template to create a new public repository
2. If you’ve already created a repo through our onboarding, find it on your dashboard
3. For manual setup, create your repo and contact us for deployment

Install the GitHub app

Install our GitHub app from your dashboard settings for automatic deployments.

Customizing Your Docs

Edit locally

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

View our local development guide for more details.

Configure your brand

Update mint.json with your brand settings:

"name": "Your Company"
"logo": {
  "light": "/logo/light.svg",
  "dark": "/logo/dark.svg",
  "href": "https://yourcompany.com"
},
"favicon": "/favicon.svg",
"colors": {
  "primary": "#2AB673",
  "light": "#55D799",
  "dark": "#117866",
}

See all options in global settings.

Add content

Create MDX files with this header format:

---
title: "Page Title"
sidebarTitle: "Sidebar title (optional)"
description: "Subtitle (optional)"
---

Learn about MDX syntax and components.

Deploy changes

Commit and push your changes to update your site. If needed, manually deploy through the dashboard.

Add API references

1. Add OpenAPI spec file or URL in mint.json:

"openapi": "link-to-your-openapi-file"

2. Generate endpoint files:

npx @mintlify/scraping@latest openapi-file <path-or-url-to-openapi-file>

3. Add generated files to navigation in mint.json

See our complete OpenAPI guide.

Set up analytics

Access built-in analytics on your dashboard or integrate with supported providers.

Publishing

Add custom domain

Set up your custom domain through dashboard settings.

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