Skip to main content
Get your documentation site live in minutes. This guide walks you through creating an account, deploying your first site, and making your first update.

​
Create your account

Sign up for Mintlify to get started. You can sign up with GitHub, GitLab, or email.

​
Deploy your site

Once you create an account, Mintlify automatically deploys your documentation site to https://<your-project-name>.mintlify.app. Your site includes:
  • A starter template with example pages
  • Pre-configured navigation and settings
  • A custom subdomain for your documentation

​
Make your first update

You have two options for editing your documentation:

​
Option 1: Use the visual editor

The fastest way to make changes is through the visual editor:
1

Open the editor

Navigate to the visual editor from your dashboard.
2

Edit a page

Select any page from the sidebar to start editing. Press / to add components like callouts, code blocks, and more.
3

Publish your changes

Click Publish to deploy your changes immediately to your live site.

​
Option 2: Edit locally with the CLI

For more control and local development, use the CLI:
1

Install the CLI

Install the Mintlify CLI globally:
npm i -g mint
2

Clone your repository

Clone your documentation repository from GitHub or GitLab to your local machine.
3

Preview locally

Navigate to your documentation directory and run:
mint dev
Your documentation will be available at http://localhost:3000.
4

Make changes

Edit your MDX files in your preferred code editor. Changes appear in real-time in your local preview.
5

Push to deploy

Commit and push your changes to your repository. Mintlify automatically deploys your updates.

​
Next steps

CLI installation

Set up local development with the Mintlify CLI

Visual editor

Learn how to use the browser-based editor

Organize your docs

Configure navigation and structure your content

Customize your site

Apply themes and customize your documentation’s appearance