Quickstart

Deploy your documentation site and make your first changes.

Create an account and complete onboarding to get started.

Deploy your site

After onboarding, your documentation site deploys automatically to:

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

Find your URL on the Overview page of your dashboard.

Set up 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 repositories.
3. Go to Settings > My Profile and select Authorize GitHub account.

Edit your documentation

Choose your preferred workflow:

Web editor

1. Open the Editor in your dashboard.
2. Select index.mdx in the file explorer.
3. Update the title field to “Hello World”.
4. Select Publish to deploy your changes.

Local development

Install the CLI:

npm

npm i -g mint

Create a project and start editing:

mint new

Preview locally:

mint dev

Push changes to your repository to deploy automatically.

Add a custom domain

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

Configure your DNS:

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 for easy navigation.

Add components

Use interactive components like accordions and tabs.

Set up API docs

Create API references with OpenAPI specifications.