Website

This directory contains the whole content for the CANopen Stack Project website. The site is a static generated website out of a collection of markdown files. The used generator is Material for MkDocs. The resulting website is hosted on GitHub Pages.

Contribution

In case you want to enhance the website content, you need to install MkDocs:

Prepare Environment

# ensure python3 is installed (on my machine at time of writing: 3.9.x)
$ py --version

# install static website generator: MkDocs
$ py -m pip install -r ./requirements.txt

Local server

During writing new content, a hot-reloading website is helpful. Start your server on your local machine:

# start development server in repository root (unix, powershell)
$ mkdocs serve

Deploy website manually

When deployment of the website via commandline is required, you can do it by typing

# deploy a new website version
$ mike deploy --push --update-aliases vx.y.z latest

# manage the alias 'latest'
$ mike set-default --push latest

# list all website versions
$ mike list [version-or-alias]

# delete a website version
$ mike delete [version-or-alias]

Automatic deployment

The GitHub Action website.yml is defined to deploy (or overwrite) a website version. This action is triggered when a new release is pushed.