Quickstart

Get started with Mintlify by deploying your documentation site in minutes and making your first content change with the web editor or Git.

Deploy a live documentation site and make your first change.

Before you begin

Mintlify uses a docs-as-code approach: every page has a corresponding file in your documentation repository. Edit locally or in the web editor and sync changes to your remote repository.

Using an AI coding tool? Add the Mintlify skill and MCP server for better results.

Install the Mintlify skill and MCP servers for AI coding tools.

CopiedCopy promptOpen in Cursor

Deploy your documentation site

Go to mintlify.com/start and complete onboarding. You’ll connect GitHub, create or select a repository, and install the GitHub App for automatic deployments. Your site deploys to a .mintlify.app URL.

Optional: Skip connecting a Git provider during onboarding

Skip the Git connection to get started immediately. Mintlify creates a private repository for you so you can use the web editor right away. Migrate to your own repository later from Git Settings. See Clone to your own repository.

View your deployed site

Find your URL at https://<your-project-name>.mintlify.app on the Overview page of your dashboard.

Before sharing with users, add a custom domain.

Make your first change

CLI

1. Install the CLI

   Requires Node.js v20.17.0 or higher.

   npm

   npm i -g mint
   

   See Install the CLI for details.

2. Clone your repository

   Follow Clone your repository if you haven’t already.

3. Edit a page

   Update the description in index.mdx:

   ---
   title: "Introduction"
   description: "Your custom description here"
   ---
   
4. Preview locally

   Run mint dev and open http://localhost:3000.

5. Push your changes

   git add .
   git commit -m "Update description"
   git push
   

   Mintlify deploys automatically. Check status on the Overview page.

Web editor

1. Open the web editor

   Go to the web editor in your dashboard.

2. Edit a page

   Open the Introduction page and update the description.

   
3. Publish

   Click Publish in the top-right toolbar.

4. View live

   Check deployment status on the Overview page, then refresh your site.

Next steps

Use the web editor

Edit documentation in your browser and preview how your pages look when published.

Explore CLI commands

Find broken links, check accessibility, validate OpenAPI specs, and more.

Add a custom domain

Use your own domain for your documentation site.