Quickstart

Deploy your documentation site and make your first change.

Deploy your site

Go to mintlify.com/start and complete the onboarding process. You’ll connect your GitHub account and create a repository for your documentation.

Your site deploys to https://<your-project-name>.mintlify.app. Find your URL on the dashboard.

Make your first change

CLI

1. Install the CLI

   npm

   npm i -g mint
   
2. Edit a page

   Open index.mdx and update the description:

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

   mint dev
   

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

4. Push your changes

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

Web editor

1. Open the web editor

   Navigate to the web editor.

2. Edit a page

   Open index.mdx and update the description:

   ---
   title: "Introduction"
   description: "Your custom description here"
   ---
   
3. Publish

   Click Publish in the top-right of the toolbar.

Next steps

Web editor

Edit documentation in your browser.

CLI commands

Preview locally and validate your docs.

Custom domain

Use your own domain.