Skip to main content

​
Running Documentation Locally

You can preview documentation changes locally using the Mintlify CLI.

​
Prerequisites

Install Node.js (v18 or higher) and npm.

​
Install Mintlify CLI

npm i -g mintlify

​
Preview Documentation

Navigate to the docs directory and start the development server: 
cd apps/docs
mintlify dev
The documentation will be available at http://localhost:3000.

​
Making Changes

  1. Edit MDX files in the apps/docs directory
  2. Changes will hot-reload automatically
  3. Check for broken links: mintlify broken-links
  4. Validate accessibility: mintlify a11y

​
Project Structure

apps/docs/
├── mint.json           # Mintlify configuration
├── introduction.mdx    # Home page
├── quickstart.mdx      # Getting started guide
├── guides/             # User guides
│   ├── overview.mdx
│   ├── transactions.mdx
│   └── integrations.mdx
├── api-reference/      # API documentation
│   ├── introduction.mdx
│   └── endpoint/
└── images/             # Screenshots and images
    └── screenshots/    # Automated screenshots

​
Troubleshooting

Stop other services running on port 3000, or specify a different port:
mintlify dev --port 3001
Hard refresh your browser (Ctrl+Shift+R on Windows/Linux, Cmd+Shift+R on Mac)