Get started in three steps
Get your documentation site running locally and make your first customization.Step 1: Set up your local environment
Clone your docs locally
Clone your docs locally
During the onboarding process, you created a GitHub repository with your
docs content if you didn’t already have one. You can find a link to this
repository in your dashboard. To clone the
repository locally so that you can make and preview changes to your docs,
follow the Cloning a
repository
guide in the GitHub docs.
Start the preview server
Start the preview server
- Install the Mintlify CLI:
npm i -g mint2. Navigate to your docs directory and run:mint dev3. Openhttp://localhost:3000to see your docs live!Your preview updates automatically as you edit files.
Step 2: Deploy your changes
Install our GitHub app
Install our GitHub app
Install the Mintlify GitHub app from your dashboard.Our GitHub app automatically deploys your changes to your docs site, so you don’t need to manage deployments yourself.
Update your site name and colors
Update your site name and colors
For a first change, let’s update the name and colors of your docs site.
- Open
docs.jsonin your editor. - Change the
"name"field to your project name. - Update the
"colors"to match your brand. - Save and see your changes instantly at
http://localhost:3000.
Try changing the primary color to see an immediate difference!
Step 3: Go live
Publish your docs
Publish your docs
- Commit and push your changes. 2. Your docs will update and be live in moments!