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 your 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. Your site then deploys to a .mintlify.app URL.

Optional: Skip connecting a Git provider during onboarding

Skip the Git provider connection to get started quickly. Mintlify creates a private repository and configures the GitHub App for you. To migrate to your own repository later, use the Git setup wizard in Git Settings. See Clone to your own repository.

View your deployed site

Find your site’s URL (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 and preview

   Update the description in index.mdx, then run mint dev and view your preview at http://localhost:3000.

4. Push your changes

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

   Mintlify automatically deploys your changes.

Web editor

1. Open the web editor

   Navigate 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. Track deployment status on the Overview page.

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.