Riskboard - Documentation

Built with MkDocs and Material for MkDocs

Installation

make install

This will install required dependencies using pip.

Development

make serve

This will run mkdocs server on localhost:8000.

The markdown files are located in the docs directory. You can edit the configuration in mkdocs.yml.

Check the MkDocs documentation and Material for MkDocs documentation for more information.

Deployment

Docker

You can use the provided Dockerfile to build a docker image.

It will build the docs sources and run a nginx server to serve the static files.

Using docker-compose

docker-compose up --build

Using docker-cli

docker build -t docs .
docker run -p 8000:8000 docs

Github Pages

The documentation is automatically deployed on Github Pages when a commit is pushed on the main branch.

The configuration is located in the .github/workflows/ci.yml file.