https://github.com/killbill/slate
Kill Bill API documentation
https://github.com/killbill/slate
billing killbill payments subscriptions
Last synced: 11 months ago
JSON representation
Kill Bill API documentation
- Host: GitHub
- URL: https://github.com/killbill/slate
- Owner: killbill
- License: apache-2.0
- Created: 2018-01-05T23:41:05.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2025-07-18T22:15:23.000Z (11 months ago)
- Last Synced: 2025-07-19T02:16:15.819Z (11 months ago)
- Topics: billing, killbill, payments, subscriptions
- Language: JavaScript
- Homepage: https://killbill.io
- Size: 6.63 MB
- Stars: 0
- Watchers: 3
- Forks: 13
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# API docs
Kill Bill API documentation.
The site is built using [Middleman](https://github.com/middleman/middleman). See also https://github.com/slatedocs/slate.
## Edit and Syntax
The documentation is in the `source/includes` directory.
Markdown syntax: https://github.com/slatedocs/slate/wiki/Markdown-Syntax
## Development
To run the site locally:
```
middleman server
```
Prerequisites:
* Install Ruby (use [RVM](https://rvm.io/) or [RubyInstaller](https://rubyinstaller.org/))
* Run `bundle install`
## Deployment
To generate the files:
```
middleman build
```
Notes:
* The generated static pages under `build` are deployed by Cloudflare (https://apidocs.killbill.io/)
* The built pages are also pushed to the `gh-pages` branch for debugging (served by GitHub pages at https://killbill.github.io/slate/ for backward compatibility)
* Minification of assets is handled by Cloudflare (check-in the unminified version)