https://github.com/killbill/killbill-docs
Kill Bill documentation
https://github.com/killbill/killbill-docs
billing killbill payments subscriptions
Last synced: about 1 year ago
JSON representation
Kill Bill documentation
- Host: GitHub
- URL: https://github.com/killbill/killbill-docs
- Owner: killbill
- License: apache-2.0
- Created: 2013-08-10T16:05:50.000Z (over 12 years ago)
- Default Branch: v3
- Last Pushed: 2025-03-27T08:29:27.000Z (about 1 year ago)
- Last Synced: 2025-03-29T03:11:14.066Z (about 1 year ago)
- Topics: billing, killbill, payments, subscriptions
- Language: CSS
- Homepage: https://killbill.io
- Size: 257 MB
- Stars: 39
- Watchers: 5
- Forks: 83
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Docs
Kill Bill documentation (user guides and tutorials).
The site is built using [Asciidoctor](http://asciidoctor.org/docs/).
## 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:
* Install Ruby (use [RVM](https://rvm.io/) or [RubyInstaller](https://rubyinstaller.org/))
* Run `bundle install`
## 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)