Quickstart

Deploy your documentation site and make your first changes.

Prerequisites: Create an account and complete onboarding.

Deploy your site

After onboarding, your site automatically deploys to:

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

Find your URL on the dashboard Overview page.

Make your first edit

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. Click Publish

Your changes deploy immediately.

Code editor

1. Install the CLI:

   npm i -g mint
   

2. Run mint new to create a project

3. Edit index.mdx and change the title to “Hello World”

4. Preview locally:

   mint dev
   

5. Push to your repository to deploy

Add a custom domain

Navigate 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

Organize navigation

Structure your documentation

Add components

Enhance with interactive elements