Quickstart

Deploy your documentation site and make your first changes.

Create an account and complete onboarding to get your live documentation site at https://<your-project-name>.mintlify.app.

Install the GitHub App

1. Navigate to Settings in your dashboard.
2. Select GitHub App from the sidebar.
3. Select Install GitHub App and choose your repositories.

Choose your workflow

Code-based workflow

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

npm

npm i -g mint

Create a new project:

mint new

Edit your documentation files, then preview locally:

mint dev

Push changes to your repository to deploy automatically.

Web editor workflow

1. Log in to your dashboard.
2. Select Editor on the left sidebar.
3. Edit your documentation files in the browser.
4. Select Publish to deploy your changes.

Add a custom domain

Navigate to Domain Setup and add a CNAME record:

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

Next steps

Configure settings

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

Customize theme

Change colors, fonts, and appearance.

Organize navigation

Structure your documentation with intuitive navigation.

Add components

Use interactive components like accordions, tabs, and code samples.

Set up API references

Create interactive API docs with OpenAPI specifications.