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:
- Install Ruby (use RVM or RubyInstaller)
- Run
bundle install
To deploy the docs:
make.sh
update_gh-pages.sh
Notes:
- The generated static pages under
build/selfcontainedare pushed to thegh-pagesbranch (not served by GitHub pages) - The
gh-pagesbranch is then deployed by Cloudflare (https://docs.killbill.io/) - Minification of assets is handled by Cloudflare (check-in the unminified version)
- Site-root files are generated in
build/rootbymake.shand copied to the root ofgh-pagesbyupdate_gh-pages.sh:robots.txt,_headersand_redirectscome fromstatic/sitemap.xml(latest pages only) is generated byscripts/generate_sitemap.rb404.htmlis built fromuserguide/site/404.adoc(Cloudflare Pages serves it, with a 404 status, for missing paths)
- Pages link to their
/latest/URL as canonical (html5/document.html.slim). Old version directories ongh-pagesare never rebuilt, soupdate_gh-pages.shrunsscripts/canonicalize_versions.rbto add a canonical link to the same page under/latest/(ornoindexwhen there is none, seescripts/canonical-overrides.txt)