Skip to main content

​
Get started in three steps

Get your documentation site running locally and make your first customization.

​
Step 1: Set up your local environment

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.
  1. Install the Mintlify CLI: npm i -g mint
  2. Navigate to your docs directory and run: mint dev
  3. Open http://localhost:3000 to see your docs live!
Your preview updates automatically as you edit files.

​
Step 2: Deploy your changes

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.
For a first change, let’s update the name and colors of your docs site.
  1. Open docs.json in your editor.
  2. Change the "name" field to your project name.
  3. Update the "colors" to match your brand.
  4. Save and see your changes instantly at http://localhost:3000.
Try changing the primary color to see an immediate difference!

​
Step 3: Go live

  1. Commit and push your changes.
  2. Your docs will update and be live in moments!

​
Next steps

Now that you have your docs running, explore these key features:
Example XML feed: Download feed.xml to see how static XML files are served.

Write Content

Learn MDX syntax and start writing your documentation.

Customize style

Make your docs match your brand perfectly.

Add code examples

Include syntax-highlighted code blocks.

API documentation

Auto-generate API docs from OpenAPI specs.

​
Essential features

Content management

  • Create and organize MDX files
  • Use frontmatter for metadata
  • Add images and assets
  • Structure with headings and sections

Customization options

  • Configure site colors and branding
  • Customize navigation structure
  • Add custom CSS and components
  • Set up search functionality

Developer tools

  • Hot reload preview server
  • Automatic deployments via GitHub
  • Version control integration
  • CLI commands for common tasks

Documentation features

  • Syntax-highlighted code blocks
  • Interactive API documentation
  • Search and navigation
  • Mobile-responsive design

​
Quick tips

Getting started

  • Install Mintlify CLI globally
  • Clone your repository locally
  • Run mint dev to preview
  • Make changes and see updates instantly

Best practices

  • Keep content organized in folders
  • Use descriptive file names
  • Write clear, concise documentation
  • Test your changes locally first

Troubleshooting

  • Check your docs.json configuration
  • Verify file paths and links
  • Review console for errors
  • Consult the Mintlify documentation
Need help? See our full documentation or join our community.