The KUDO web site is build using VuePress.

• Install NodeJS
• Install Yarn

In the root of the project, run

yarn install
yarn docs:dev

The output will inform you about the address the site is served (usually http://localhost:8080).

You can choose to install and run the above dependencies in a Docker container instead, if you do not wish to pollute your local environment.

First, build the development image with:

make dev-image

And then run VuePress in a container from this image by doing:

make dev

Please follow the documentation guidelines, which are pretty high level for now.

Events are rendered from markdown pages located in the events folder. The format is documented here.

Custom components that you should consider using when writing documentation are described here.