Before you begin
- A GitHub or GitLab account with access to the repo you want to use (or permission to create one)
- Admin access to your Mintlify organization if one already exists
Steps
1
Connect your repository
Go to dashboard.mintlify.com and click New project. Select your Git provider, then choose the repository that contains—or will contain—your documentation.Mintlify installs a GitHub App (or GitLab webhook) that watches for pushes. Every push to your default branch triggers a new deployment automatically.
2
Wait for the initial deploy
Mintlify clones your repo and builds the site. The first build typically takes under two minutes. When it finishes, your site is live at a
*.mintlify.app URL shown on the project overview page.If your repo doesn’t have a
docs.json yet, Mintlify generates a starter configuration. You can customize it after the first deploy.3
Make your first edit
Choose how you prefer to work:Web editor — Click Edit in the dashboard. The browser-based editor lets you modify pages and publish without touching the command line. Changes deploy automatically when you click Publish.CLI — Install the Mintlify CLI with
npm i -g mintlify, clone your repo, and run mintlify dev to start a local preview server. Edit your MDX files, see changes instantly, then push to Git to deploy.4
Preview before publishing
Every pull request automatically gets a preview deployment with its own unique URL. Share the link with teammates for review before merging to your default branch.
Next steps
- Review key concepts to understand how projects, pages, and navigation fit together.
- Open docs.json settings to set your site name, colors, and logo.
- Invite editors so teammates can contribute.