Dbljump API docs powered by Slate

This repository uses the legacy Slate documentation toolchain.

Prerequisites

Clone the repository, install its locked dependencies, and start the local preview server:

git clone https://github.com/dbljump/api-docs-slate.git
cd api-docs-slate
bundle install
bundle exec middleman server

With the server running, view the docs at http://localhost:4567.

To verify a production build:

bundle exec middleman build --clean

Commit changes to master branch, then run the deploy script:

./deploy.sh

The deploy script builds the site and pushes the generated output to the gh-pages branch.