Skip to main content
Set up and deploy your documentation site in minutes.
Prerequisites: Before you begin, create an account and complete onboarding.

​
Getting started

After onboarding, your site deploys to https://<your-project-name>.mintlify.app. Find your URL on the Overview page of your dashboard.
Mintlify Domain
Use this URL for testing and sharing with your team.

​
Install the GitHub App

Install the GitHub App to automate deployment when you push changes.
  1. Navigate to Settings in your Mintlify dashboard.
  2. Select GitHub App from the sidebar.
  3. Select Install GitHub App. This opens a new tab to the GitHub App installation page.
  4. Select the organization or user account where you want to install the app.
  5. Select the repositories that you want to connect.
GitHub App Installation
Update the GitHub App permissions if you move your documentation to a different repository.

​
Authorize your GitHub account

  1. Navigate to Settings in your Mintlify dashboard.
  2. Select My Profile from the sidebar.
  3. Select Authorize GitHub account. This opens a new tab to the GitHub authorization page.
An admin for your GitHub organization may need to authorize your account depending on your organization settings.

​
Editing workflows

Choose your preferred workflow:

Code-based workflow

For users who prefer working with existing tools in their local environment. Click to jump to this section.

Web editor workflow

For users who prefer a visual interface in their web browser. Click to jump to this section.

​
Code-based workflow

Work locally with your existing development tools and Git workflow.

​
Install the CLI

Prerequisite: The CLI requires Node.js v19 or higher.
Install the mint CLI: 
npm i -g mint

​
Edit the documentation

Edit your documentation files. For example, update the introduction page title:
  1. Open your repository created during onboarding.
  2. Open index.mdx and locate the top of the file:
index.mdx
---
title: "Introduction"
description: "This is the introduction to the documentation"
---
  1. Update the title field to "Hello World".
index.mdx
---
title: "Hello World"
description: "This is the introduction to the documentation"
---

​
Preview the changes

Preview changes locally: 
mint dev
Your preview will be available at localhost:3000.
Mintlify Dev

​
Push the changes

Push changes to your repository. Mintlify automatically builds and deploys updates. Monitor deployment status in your GitHub commit history or the dashboard.

Jump to adding a custom domain

Optionally, skip the web editor workflow and jump to adding a custom domain.

​
Web editor workflow

Edit documentation in your browser with a visual interface.

​
Access the web editor

  1. Log in to your dashboard.
  2. Select Editor on the left sidebar.
If you have not installed the GitHub App, you will be prompted to install the app when you open the web editor.
The Mintlify web editor in the visual editor mode

​
Edit the documentation

Navigate to index.mdx in the file explorer and update the title field to “Hello World”.
Editing in Web Editor
The editor provides a rich set of formatting tools and components. Type / in the editor to open the command menu and access these tools.

​
Publish your changes

Select Publish in the top-right corner to deploy your changes.
Use branches to preview and review changes through pull requests before deploying to your live site.
See the web editor documentation for details on branches and pull requests.

​
Adding a custom domain

Add a custom domain for production. Navigate to the Domain Setup page in your dashboard.
Custom Domain
Enter your domain (for example, docs.yourcompany.com) and follow the provided instructions to configure DNS settings with your domain provider.
DNS changes can take up to 48 hours to propagate, though changes often complete much sooner.

​
Next steps

Your documentation site is live. Here are suggested next steps:

Configure your global settings

Configure site-wide styling, navigation, integrations, and more with the docs.json file.

Customize your theme

Learn how to customize colors, fonts, and the overall appearance of your documentation site.

Organize navigation

Structure your documentation with intuitive navigation to help users find what they need.

Add interactive components

Enhance your documentation with interactive components like accordions, tabs, and code samples.

Set up API references

Create interactive API references with OpenAPI and AsyncAPI specifications.

​
Troubleshooting

Common troubleshooting solutions:
Make sure you have Node.js v19+ installed and that you run the mint dev command from the directory containing your docs.json file.
Deployment can take upwards to a few minutes. Check your GitHub Actions (for code-based workflow) or deployment logs in the Mintlify dashboard to ensure there are no build errors.
Verify that your DNS records are set up correctly and allow sufficient time for DNS propagation (up to 48 hours). You can use tools like DNSChecker to verify your CNAME record.