To build the docs, run this from the project root:

python docs/scripts/build_docs.py

It should generate new markdown files in docs/_docs.

To convert images to webp, run this from the project root:

# convert docs/assets/images/examples
python docs/scripts/convert_to_webp.py  -d docs/assets/images/examples --height 400

The weblinx homepage is built with jekyll, which uses ruby. If you do not have ruby installed, please install it, then install bundler:

# Install ruby and gem
sudo apt-get install ruby-dev

# install bundler
gem install bundler -v 2.4.22

to run it locally, run this from the project root:

cd docs
bundle install
bundle exec jekyll serve