Quickstart

Build modern documentation in under five minutes

Getting Started

Hey there! Let’s walk through how to set up, update, and make your documentation amazing with Mintlify.

Setting Up Your Documentation

Mintlify creates documentation from MDX files (special markdown files) and settings in our starter kit. We use GitHub to keep your docs connected with your code. To begin, you can either:

• Sign up through our dashboard, or
• Copy our starter kit

Set up the GitHub app

To make sure your changes show up automatically, you’ll need to install our GitHub app. You can find it in the dashboard under Settings. Once it’s installed correctly, you’ll see a check mark next to your repository’s commit hash.

Working with a monorepo

Want to keep your docs with your code? No problem! You can:

1. Move your docs into your code repository
2. Tell us where to find your mint.json file in the dashboard

Making Changes

Here’s how you can customize your docs to look and work exactly how you want.

Edit on your computer (best for developers)

1. First, install git if you haven’t already.
2. Copy your docs to your computer using git clone <your-repo>. New to this? Check out how to set up SSH keys.
3. Open the files in your favorite code editor.
4. Install our preview tool with npm i -g mintlify.

Want more details? Check out our local development guide.

Edit in your browser

Find out how to use our web editor in our guide.

Match your brand's style

You can easily change colors, logos, and buttons in the mint.json file. Here are the basics:

"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 our global settings.

Add new content

Create new pages using MDX files. Start each page with:

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

Learn how to add images, tables, and more in our MDX guide. We also have many ready-to-use components.

Save your changes

When you’re ready to update your site, save your changes and push them to GitHub. Need help? Here’s a simple guide. If something goes wrong, you can always update through our dashboard.

Add API documentation

Want to document your API? It’s easy with an OpenAPI file:

1. Add your openapi.yaml or openapi.json file to your docs, or link to it in mint.json:

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

2. Convert your OpenAPI file into docs pages:

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

3. Add the new files to your navigation in mint.json.

Need more help? Check out our guides on setting up OpenAPI, API authentication, and manual API docs.

Track your docs' performance

See how people use your docs with our built-in analytics. Find page views, search data, and more in your dashboard.

Want to use other analytics tools? Check out our supported integrations.

Need help moving your existing docs to Mintlify? Our Enterprise plan includes a full migration service. Interested? Email us.

Publishing Your Docs

Use your own web address

Want your docs on your website’s domain? You can do this for free!

Just go to your dashboard settings to set up your custom domain.

Great job! Your Mintlify docs are ready to go! Need help or have feedback? Join our community or email us at [e-mail].