This documentation was generated using docsify.

Docsify loads and parses your Markdown files and displays them as a website.

nodejs installed.

It is recommended to install docsify-cli globally, which helps initializing and previewing the website locally.

npm i docsify-cli -g

Run the local server with docsify serve. You can preview your site in your browser on http://localhost:3000.

docsify serve docs

Be sure to be outside of the Wago network, as the firewall will block the pulling of the docker image.

Open WSL, go in the project root directory. Not the docs directory.

Then to generate the documentation, run:

./gen-pdf.sh

The documentations will be generated under docs/pdf

Check that there are no tabs before an image include

!> always check that all images are included correctly before pushing on main