Learn how to contribute to the Prefect docs.
justfile
with common commands to simplify development. We recommend using just to run these commands.
brew install just
or cargo install just
cargo install just
or check your package managerscoop install just
or cargo install just
just docs
to start the documentation server.http://localhost:3000
.
cd docs
to navigate to the docs directory.nvm use node
to use the correct Node.js version.npm i -g mintlify
to install Mintlify.mintlify dev
to start the development server.http://localhost:3000
.
See the Mintlify documentation for more information on how to install Mintlify, build previews, and use Mintlify’s features while writing docs.
.mdx
files, which are Markdown files that can contain JavaScript and React components.