Quickstart

Deploy your documentation site and make your first changes.

Get your documentation site live in minutes.

Prerequisites: Create an account and complete onboarding.

Your site is live

After onboarding, your site is automatically deployed to:

https://<your-project-name>.mintlify.app

Find your URL in the dashboard.

Setup GitHub

Install the GitHub App to automatically deploy changes:

1. Go to Settings > GitHub App in your dashboard
2. Click Install GitHub App
3. Select your organization and repositories

Then authorize your account:

1. Go to Settings > My Profile
2. Click Authorize GitHub account

Choose your workflow

Pick the editing workflow that works best for you:

Code-based workflow

Edit locally with your preferred tools and Git

Web editor workflow

Edit directly in your browser with a visual interface

Code-based workflow

Work locally with your preferred development tools.

Install the CLI

Prerequisite: Requires Node.js v19 or higher.

npm

npm i -g mint

Create and edit

Run mint new to create a new project, then edit your MDX files. For example, open index.mdx:

index.mdx

---
title: "Hello World"
description: "This is the introduction to the documentation"
---

Preview locally

mint dev

Your preview runs at localhost:3000.

Deploy

Push your changes to GitHub. Mintlify automatically builds and deploys your site.

Web editor workflow

Edit your docs directly in the browser with a visual interface.

Open the editor

1. Go to your dashboard
2. Click Editor in the sidebar

Type / to open the command menu and access formatting tools.

Edit and publish

Select any file from the sidebar, make your changes, then click Publish. Your changes deploy immediately.

Learn more in the web editor documentation.

Add a custom domain

Go to Domain Setup and enter your domain (e.g., docs.yourcompany.com).

Add this DNS record with your domain provider:

Record Type	Name	Value	TTL
CNAME	docs	cname.vercel-dns.com	3600

DNS changes can take up to 48 hours to propagate.

Next steps

Configure settings

Customize styling, navigation, and integrations

Customize theme

Change colors, fonts, and appearance

Organize navigation

Structure your documentation

Add components

Use interactive elements like accordions and tabs

Set up API references

Create interactive API docs with OpenAPI