Skip to main content
Get your documentation site live in under 10 minutes. This guide walks you through setup, editing, and deployment.
Prerequisites: Create an account and complete onboarding first.

​
Your site is already live

After onboarding, your documentation automatically deploys to: 
https://<your-project-name>.mintlify.app
Find your URL on the Overview page of your dashboard.
Mintlify Domain

​
Connect GitHub

Set up automatic deployments when you push changes:
  1. Go to Settings → GitHub App in your dashboard
  2. Click Install GitHub App
  3. Select your organization and repositories
  4. Authorize your GitHub account in Settings → My Profile
GitHub App Installation
Organization admins may need to approve the authorization depending on your GitHub settings.

​
Choose your editing workflow

Pick the workflow that fits your team:

Code-based

Work locally with your favorite editor and Git workflow

Web editor

Edit directly in your browser with a visual interface

​
Code-based editing

​
Install the CLI

Install the Mintlify CLI to work locally: 
npm i -g mint
Requires Node.js v19+. Having issues? Check the troubleshooting section below.

​
Make your first edit

  1. Open your repository from onboarding
  2. Edit index.mdx and change the title:
index.mdx
---
title: "Hello World"
description: "This is the introduction to the documentation"
---

​
Preview locally

Run the development server: 
mint dev
Your preview opens at localhost:3000.
Mintlify Dev

​
Deploy changes

Push your changes to GitHub. Mintlify automatically builds and deploys your updates. Monitor deployment status in your GitHub commit history or dashboard.

​
Web editor

​
Access the editor

  1. Go to your dashboard
  2. Click Editor in the sidebar
The Mintlify web editor

​
Make your first edit

  1. Select index.mdx in the file explorer
  2. Change the title to “Hello World”
Editing in Web Editor
Type / to open the command menu and access formatting tools and components.

​
Publish changes

Click Publish in the top-right corner. Your changes deploy immediately.
Use branches to preview changes through pull requests before going live.

​
Add a custom domain

Replace your .mintlify.app subdomain with your own domain:
  1. Go to Domain Setup in your dashboard
  2. Enter your domain (e.g., docs.yourcompany.com)
  3. Add this DNS record with your domain provider:
Custom Domain
DNS changes can take up to 48 hours to propagate.

​
Next steps

Your documentation site is live! Here’s what to do next:

Configure settings

Customize styling, navigation, and integrations

Customize theme

Update colors, fonts, and appearance

Organize navigation

Structure your content for easy discovery

Add components

Use interactive elements like tabs and accordions

​
Troubleshooting

Ensure you have Node.js v19+ installed and run mint dev from the directory containing your docs.json file.
Deployment takes a few minutes. Check GitHub Actions or dashboard deployment logs for build errors.
Verify DNS records are correct and allow time for propagation. Use DNSChecker to verify your CNAME record.
⌘I