Skip to content

Latest commit

 

History

History
47 lines (29 loc) · 966 Bytes

README.md

File metadata and controls

47 lines (29 loc) · 966 Bytes
Raw

Docs

Kill Bill documentation (user guides and tutorials).

The site is built using Asciidoctor.

Edit and Syntax

The documentation is in the userguide directory.

AsciiDoc syntax: https://docs.asciidoctor.org/asciidoc/latest/syntax-quick-reference/

Development

To generate the documentation locally:

make.sh

Generated html files are in the build directory.

To run the site locally:

ruby server.rb

Prerequisites:

Deployment

To deploy the docs:

make.sh
update_gh-pages.sh

Notes:

  • The generated static pages under build/selfcontained are pushed to the gh-pages branch (not served by GitHub pages)
  • The gh-pages branch is then deployed by Cloudflare (https://docs.killbill.io/)
  • Minification of assets is handled by Cloudflare (check-in the unminified version)