handbook.koor.tech

This is the Koor Technologies, Inc. company and employee handbook built using MkDocs and the beautiful Material for MkDocs theme.

Contributing

You currently need to have Docker installed to be able to preview and build the site locally.

Please submit any code or text changes using a pull request.

Local Preview

For the preview we are using a Docker image which contains the right mkdocs version, theme and plugins.

Assuming you have Docker installed and running, you should be able to run the following command to get a local preview:

make serve

Building & Deploying

To build the handbook locally run:

make build