The open-source notification infrastructure for developers

The ultimate service for managing multi-channel notifications with a single API.

Available in: Node.js · PHP · Laravel · Go · Ruby · Kotlin · Python · Java · .NET · Elixir · Rust

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

Name		Name	Last commit message	Last commit date
Latest commit History 894 Commits
_snippets		_snippets
activity-feed		activity-feed
additional-resources		additional-resources
api-reference		api-reference
architecture		architecture
channels-and-providers		channels-and-providers
community		community
content-creation-design		content-creation-design
cookbook		cookbook
demos		demos
faqs		faqs
getting-started		getting-started
guides		guides
images		images
logo		logo
notification-center		notification-center
platform		platform
quickstarts		quickstarts
resources		resources
sdks		sdks
security-and-compliance		security-and-compliance
self-hosting-novu		self-hosting-novu
subscribers		subscribers
tenants		tenants
use-cases		use-cases
workflows		workflows
.env.local		.env.local
.gitignore		.gitignore
.nvmrc		.nvmrc
README.md		README.md
background.png		background.png
favicon.ico		favicon.ico
favicon.png		favicon.png
introduction.mdx		introduction.mdx
mint.json		mint.json
openapi.json		openapi.json
techstack.md		techstack.md
techstack.yml		techstack.yml

Provide feedback