This is the source code for the Noir documentation site at noir-lang.org.
This website is built using Docusaurus 3, a modern static website generator.
Interested in contributing to the docs?
Check out the contributing guide here.
This project requires recent versions of rust and cargo to be installed. Any build errors should indicate dependencies that need installing, and at what version.
On the root folder of the repository, run:
yarn
yarn build
yarn workspace docs version
This command fetches and compiles the list of documentation versions to build with.
yarn workspace docs dev
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
yarn workspace docs build
This command generates static content into the build directory and can be served using any static
contents hosting service. You can see a preview by running:
yarn workspace docs serve