Join Our Discord · Roadmap · X · Notifications Directory
Available in: Node.js · PHP · Laravel · Go · Ruby · Kotlin · Python · Java · .NET · Elixir · Rust
Checkout this video on how to contribute in Novu's documentation
First, install the Mintlify CLI locally. To install, use the following command
npm i -g mintlify
Note: Please install Node.js (version 18 or higher) before proceeding.
Run the following command at the root of the documentation (where mint.json is) to preview the documentation changes
mintlify dev
All changes to the docs should be submitted against the staging
branch. Preview the documentation changes.
PRs from staging
to main
will be deployed to production automatically after merge.
- Mintlify dev isn't running - Run
mintlify install
it'll re-install dependencies. - Page loads as a 404 - Make sure you are running in a folder with
mint.json