Skip to main content

​
Set up your environment

Learn how to update docs locally and deploy changes.

​
Edit and preview

Clone this repository locally and open it in your editor. Follow the official GitHub guide for cloning repositories.
Install the CLI and preview the site locally.
  1. Install the CLI: npm i -g mintlify
  2. From apps/docs, run: mintlify dev --port 3004

​
Deploy your changes

Commit and push your changes to trigger deployment. Our CI will build the docs and deploy to the configured environment.

​
Update your docs

Add content directly in MDX files and use the shared components.

Branding

Configure logos and colors in mint.json.

Add API Docs

Add endpoints or link external API specs within project docs.

Write Content

Structure pages and use MDX components.

Add a Project

Create a new project section with consistent pages.