Skip to main content

​
Deploy your site

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

​
Make your first change

Edit index.mdx in the web editor or locally with the CLI: 
npm i -g mint
mint dev
Publish from the web editor or 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.