Contributing

This website is built using Docusaurus (facebook/docusaurus), a modern static website generator.

Run locally

Make sure Node.js (LTS or above) is installed.

Install the dependencies:

npm install

Start the local development server (by default it opens a window in the browser on localhost:3000):

npm start

From there, you can edit the files and see changes in live in the browser.

To see the search in action, build and use the results to run the website:

npm run build
npm run serve

Important

Make sure to review this customizations when doing upgrades

npm run swizzle @docusaurus/theme-classic -- DocItem/Layout

Files are in src/theme/DocItem/Layout.

Tip

Run the command to see what is possible to swizzle:

npm run swizzle @docusaurus/theme-classic -- --list

Check YAML files:

docker run --rm -v "$(pwd)":/data cytopia/yamllint .

Check Markdown files:

docker run --rm -v "$(pwd)":/workdir davidanson/markdownlint-cli2 "**/*.md"