This repository holds the documentation site of
MANA, https://mpickpt.github.io/mana/. It
uses Jekyll and the Just the Docs theme, as the
DMTCP website does. The workflow
.github/workflows/pages.yml builds the site and deploys it to GitHub Pages
on each push to main.
The site is in the subdirectory /mana/ (baseurl in _config.yml). The
files in root/ are at https://mpickpt.github.io/ itself: index.html sends
the reader to /mana/.
To build the site on your computer, use Ruby 3.3:
bundle install
bundle exec jekyll serve # then open http://127.0.0.1:4000/mana/
Or use a container:
podman run --rm -v "$PWD":/srv:Z -w /srv -e BUNDLE_PATH=/tmp/bundle \
docker.io/library/ruby:3.3 \
bash -c 'bundle install && bundle exec jekyll build'
The pages follow a loose form of ASD-STE100 (Simplified Technical English): short sentences, active voice, simple tenses, one word for one meaning, and no semicolons.