Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

npm install

Local Development

npm run start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

Regenerating templated docs (Radar engineers only)

Some of our content is auto-generated by templates, such as our chains directory. In order to regenerate these parts of the documentation, run npm run regenerate-templated-docs.

Deployment

GIT_USER=<Your GitHub username> USE_SSH=true npm run deploy

This command is a convenient way to build the website and push to the gh-pages branch.

If you need to modify the deploy (e.g. push to a different branch), please check out the Docusaurus docs on environment variables.

Considerations

• Docusaurus caches compiled assets. If you make a change to the config file (e.g. changing baseUrl), you'll need to run npm run clear before building or your urls() may not update appropriately.