Quickstart

Deploy your documentation site and make your first change.

Deploy a live documentation site and make your first change.

Choose your repository

Mintlify uses a docs-as-code approach. Every page on your site has a corresponding file stored in your documentation repository. You can use your own Git repository or a Mintlify-hosted repository.

Mintlify-hosted

Mintlify creates a private GitHub repository connected to your deployment.

Choose this if:

• You only work in the web editor
• You want to get started quickly
• You want Mintlify to manage your repository

Your own repository

Connect your own Git repository to your deployment.

Choose this if:

• You work locally and sync to your remote repository
• You already have a documentation repository
• You want documentation under your GitHub organization

Start with Mintlify-hosted. You can migrate to your own repository anytime.

Deploy your site

Mintlify-hosted

1. Create your account

   Go to mintlify.com/start and create your account.

2. Skip GitHub connection

   Click Skip when prompted to connect GitHub.

3. Complete onboarding

   Follow the onboarding prompts. Mintlify creates a private repository in the mintlify-community organization and configures the GitHub app.

4. Your site is deployed

   Your documentation is deployed at your .mintlify.app URL.

Your own repository

1. Create your account

   Go to mintlify.com/start and create your account.

2. Connect GitHub

   Log in to your GitHub account and authenticate.

3. Complete onboarding

   Follow the onboarding prompts to create a repository.

4. Install the GitHub App

   Install the GitHub App to enable automatic deployments.

5. Optional: Select a repository

   To use a different repository, select it on the Git settings page. Your repository must have a valid docs.json file.

6. Your site is deployed

   Your documentation is deployed at your .mintlify.app URL. Future changes automatically trigger new deployments.

Learn more about the GitHub App at GitHub.

View your site

Your site is deployed at https://<your-project-name>.mintlify.app.

Find your URL on the Overview page of your dashboard.

Use this URL for testing and sharing with your team. Add a custom domain before sharing with users.

Make your first change

1. Open the web editor

   Go to the web editor in your dashboard.

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 toolbar.

4. View live

   Check deployment status on the Overview page. Refresh your site to see your changes.

Next steps

Learn about the web editor

Explore editing features and workflows.

Set up local development

Use the CLI to preview your documentation locally as you write and edit.

Add a custom domain

Use your own domain for your documentation site.