Quickstart - Mintlify

After you complete this guide, you’ll have a live documentation site ready to customize and update.

Before you begin

Mintlify uses a docs-as-code approach to manage your documentation. Every page on your site has a corresponding file stored in your documentation . When you connect your documentation repository to your project, you can work on your documentation locally or in the web editor and sync any changes to your remote repository.

Deploy your documentation site

Go to mintlify.com/start and complete the onboarding process. During onboarding, you’ll connect your GitHub account, create or select a repository for your documentation, and install the GitHub App to enable automatic deployments. After onboarding, your documentation site is deployed and accessible at your .mintlify.app URL.

View your deployed site

Your documentation site is now deployed at https://<your-project-name>.mintlify.app. Find your exact URL on the Overview page of your dashboard.

Make your first change

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.