Kill Bill documentation
Kill Bill documentation (user guides and tutorials).
The site is built using Asciidoctor.
The documentation is in the userguide
directory.
AsciiDoc syntax: https://docs.asciidoctor.org/asciidoc/latest/syntax-quick-reference/
To generate the documentation locally:
make.sh
Generated html files are in the build
directory.
To run the site locally:
ruby server.rb
Prerequisites:
bundle install
To deploy the docs:
make.sh
update_gh-pages.sh
Notes:
build/selfcontained
are pushed to the gh-pages
branch (not served by GitHub pages)gh-pages
branch is then deployed by Cloudflare (https://docs.killbill.io/)