Overview & License

This project holds the documentation website for Krossboard.

This project is Open Sourced under the terms of the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International Public License (also known as CC-BY-NC-SA). See the LICENSE file for more details.

Contributions

Contributions are welcomed for typos, misspellings, or inaccurate information in the documentation.

Each contribution should be submitted through a Github pull request. By submitting a contribution, you accept that it'll be published under the same terms of CC-BY-NC-SA License.

Requirements

Hugo static site generator v0.75.x minimum (v0.75.1 is the version currently used by the CI).

sudo snap install hugo --classic

View the site in development mode

hugo server

Then open http://localhost:1313/

Build a distribution

hugo --minify

The will compile the content and generate the static site in the folder ./public.

Deploy a distribution locally

The site can be deployed locally using a rudimentary web server to serve files in the public/ directory with TLS enabled.

The following tools are used:

• mkcert - a simple tool for making locally-trusted development certificates.
• ran - a simple static web server (written in Go).

Steps are following:

• if not already done, generate a locally-trusted certificate:

mkcert my-machine.local

• start the web server:

cd public
ran -cert=../my-machine.local.pem -key=../my-machine.local-key.pem .

The site is then available at: https://my-machine.local/