Skip to main content

Deploy your documentation site

Go to mintlify.com/start to deploy your site. Connect your GitHub account and select a repository for your documentation. Your site deploys automatically at https://<your-project-name>.mintlify.app. Find your URL on the Overview page of your dashboard.

Make your first change

Edit index.mdx in the web editor or locally with the CLI:
---
title: "Introduction"
description: "Your custom description here"
---
Push your changes to deploy automatically.

Next steps

Use the web editor

Edit documentation in your browser and preview how your pages will 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.