A simple application that uses Ruby to generate markdown data for Whonix and Kicksecure HTML packages sites.
Markdown will be placed in ./docs
In order for it to work, Ruby 3 must be installed. Also, you must have the respective kicksecure or whonix package repository.
- Install Ruby. You can use apt-get, rbenv, RVM, or asdf to do this. The repo author prefers rbenv.
- Download the packages repository
ruby --version # verify this is >= 3.0.0
sudo apt install rsync
rsync-ssl --recursive --delete --times --perms rsync://whonix.org/whonix/developer-meta-files/internal/ ../whonix-repository
From the root of this repository:
# ruby runner.rb <os_type> <repository_path>
ruby runner.rb whonix ../whonix-repository
From the root of this directory, ensure the following directory structure with tree -L 1 ..
./
├── kicksecure-packages
├── kicksecure-repository
├── package_parser
├── whonix-packages
└── whonix-repository
cd
back in to the directory the following command
./build-site.sh <os_type> <desired_static_output_path>
example:
./build-site.sh whonix ../whonix-packages-html