kudobuilder / kudo.dev

https://kudo.dev

KUDO Website

The KUDO web site is build using VuePress.

Building the site locally

• Install NodeJS
• Install Yarn

In the root of the project, run

yarn install
make build
yarn docs:lint
yarn docs:dev

#or make local-run target calls yarm docs:dev
make local-run

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

Via Docker

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 docker-build

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

make docker-run

Documentation Guidelines

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

Adding Events

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

Custom Components

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