Skip to content

Dbljump API documentation built with Slate.

License

Notifications You must be signed in to change notification settings

dbljump/api-docs-slate

 
 

Repository files navigation

Dbljump API docs powered by Slate

Note that setup instructions are based on those in the Slate readme at Github. Check there for the latest.

Prerequisites

  • Linux or OS X — Windows may work, but is unsupported.
  • Ruby, version 2.2.5 or newer
  • Bundler — If Ruby is already installed, but the bundle command doesn't work, just run gem install bundler in a terminal.

Installation

  1. Clone this repository using the instructions on Bitbucket
  2. Go to your clone's folder, e.g. cd ~/slate
  3. Bundle and start the server
#either run this to run locally
bundle install
middleman server

# OR run this to run with vagrant
vagrant up

Local

With the server running, you can now see the docs at http://localhost:4567.

Publishing to GitHub Pages

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

./deploy.sh

Re-set the custom domain name (http://docs.dbljump.com), as the deploy script removes it.

About

Dbljump API documentation built with Slate.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 89.6%
  • CSS 6.3%
  • HTML 1.8%
  • Shell 1.3%
  • Ruby 1.0%