Quickstart

Deploy your documentation site and make your first changes.

Prerequisites: Create an account and complete onboarding.

Your documentation site

After onboarding, your site is live at:

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

Find your URL on the Overview page of your dashboard.

Connect GitHub

Install the GitHub App to automate deployments:

1. Go to Settings → GitHub App in your dashboard.
2. Select Install GitHub App and choose your organization.
3. Select the repositories to connect.

Then authorize your account:

1. Go to Settings → My Profile.
2. Select Authorize GitHub account.

Choose your workflow

Pick the workflow that fits your team:

Code-based workflow

Work locally with your code editor and Git.

Install the CLI (requires Node.js v19+):

npm

npm i -g mint

Create a project:

mint new

Edit your docs. Open index.mdx and change the title:

index.mdx

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

Preview locally:

mint dev

Your preview is at localhost:3000.

Push to deploy. Mintlify automatically builds and deploys your changes.

Web editor workflow

Edit directly in your browser with a visual interface.

Open the editor:

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

Edit your docs. Select index.mdx and update the title to “Hello World”.

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

Publish. Click the Publish button to deploy your changes.

Learn more in the web editor documentation.

Add a custom domain

Go to Domain Setup in your dashboard.

Enter your domain (e.g., docs.yourcompany.com) and add this DNS record:

DNS changes can take up to 48 hours to propagate.

Next steps

Configure settings

Customize styling, navigation, and integrations in docs.json.

Customize theme

Change colors, fonts, and appearance.

Organize navigation

Structure your documentation for easy navigation.

Add components

Use interactive components like accordions and tabs.

Set up API docs

Create API references with OpenAPI specifications.