Quickstart

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

Make your first change

CLI

1. Install the CLI

   The CLI requires Node.js v20.17.0 or higher. Use an LTS version for stability.

   npm

   npm i -g mint
   

   See Install the CLI for full details and troubleshooting.

2. Clone your repository

   If you haven’t already cloned your repository locally, follow the instructions in Clone your repository.

3. Edit a page

   Open index.mdx in your preferred editor and update the description in the frontmatter:

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

   Run the following command from your documentation directory:

   mint dev
   

   View your preview at http://localhost:3000.

5. Push your changes

   Commit and push your changes to trigger a deployment:

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

   Mintlify automatically deploys your changes. View your deployment status on the Overview page of your dashboard.

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 the Publish button in the top-right of the web editor toolbar.

4. View live

   On the Overview page of your dashboard, you can see your site’s deployment status. When it finishes deploying, refresh your documentation site to see your changes live.

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.

AI-assisted editing

Cursor / VS Code

Install the Mintlify skill to get context on Mintlify project structure, components, and documentation best practices:

npx skills add https://mintlify.com/docs

Then add the Mintlify MCP server for access to documentation search. Follow the setup instructions at mintlify.com/docs/ai/model-context-protocol.

Other AI editors

Install the Mintlify skill to get context on Mintlify project structure, components, and documentation best practices:

npx skills add https://mintlify.com/docs

Then add the Mintlify MCP server for access to documentation search. Follow the setup instructions at mintlify.com/docs/ai/model-context-protocol.