See the GitHub Pages here.
The following steps are necessary to build the site locally.
This site is built with Jekyll, a Ruby gem. It requires:
- Ruby version 2.7.0, including all development headers (check your Ruby version using
ruby -v) - RubyGems (check your Gems version using
gem -v) - GCC and Make (check versions using
gcc -v,g++ -v, andmake -v)
Steps:
- Install Jekyll prerequisites:
sudo apt-get install ruby-full build-essential zlib1g-dev
- Set up a gem installation directory for your user account:
echo '# Install Ruby Gems to ~/gems' >> ~/.bashrc
echo 'export GEM_HOME="$HOME/gems"' >> ~/.bashrc
echo 'export PATH="$HOME/gems/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc
- install Jekyll and Bundler:
gem install jekyll bundler
Run the following from the root of the repo:
bundle install
bundle exec jekyll build --trace
To serve the site locally (and automatically rebuild on any changes), run the following:
bundle exec jekyll serve --livereload --host localhost --port 4444 --livereload-port 35730
- If build errors persist even if there is nothing referring to those variables (and/or the file no longer has that many lines for which the build error produces the failing line reference), run
bundle exec jekyll cleanand rebuild. Also try manually removing the.jekyll_cachedirectory. - If a complaint is given about
port is in use or requires root privileges, check if the port is in use withsudo ss -tulpn | grep 4444. If the port is not in use, try removing the--livereloadflag, as it sometimes seems to override the--portflag (actually, the livereload exposes a second port, and that is changed with the--livereload-portflag).