Currently Ruby code is used to generate the HTML files from the source text files. The ruby-vips Ruby gem is used for image manipulation, and the Liquid Ruby gem is used for the HTML templates.

The top-level Ruby script is Compiler.rb, it needs three arguments:

• Source file directory
• Configuration file (see configuration)
• HTML target directory (must exist)

(There is a potential fourth argument for debugging purposes).

The Ruby code maintains a special file _images.yaml in the source file directory which caches information about the image files there. This file will be regenerated if deleted.

The following Bash script will build the Jadawin documentation into HTML files in a html folder:

gem install bundler ruby-vips liquid
BUNDLE_GEMFILE=ruby/Gemfile;export BUNDLE_GEMFILE
mkdir html
bundle exec ruby ruby/Compiler.rb docs config.yaml html