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 documentation site and make your first change.

Mintlify uses a docs-as-code approach: every page maps to a 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 site

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

Skip connecting a Git provider

Skip the Git connection during onboarding to start in the web editor immediately. Mintlify creates a private repository for you. Migrate to your own repository later from Git Settings. See Clone to your own repository.

View your site

Find your URL on the Overview page of your dashboard. Before sharing with users, consider adding 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 troubleshooting and cloning your repository.

2. Edit and preview

   Update the description in index.mdx, then preview at http://localhost:3000:

   mint dev
   
3. Push your changes

   Commit and push to trigger a deployment:

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

Web editor

1. Edit a page

   Open the web editor, open the Introduction page, and update the description.

   
2. Publish

   Click Publish in the top-right of the toolbar. Refresh your site once deployment completes.

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.