TheProfs / bitpaper-api-docs

Bitpaper's Public REST API documentation

Bitpaper API Docs

Bitpaper's public REST API docs, built using Slate.

Install

Ensure you have all system dependencies installed, clone this repository, cd into it and then:

$ gem update --system
$ gem install bundler
$ bundle install

Usage

Run development server

bundle exec middleman server
# then visit http://192.168.10.1:4567

Edit documentation

Simply edit src/index.html.md. More info on Slate's homepage.

Some sections are includes found in src/includes/

Deploy to production

# Build docs
$ bundle exec middleman build

# Push to main branch:
$ git add --all
$ git commit -am"Added POST/ user"
$ git push origin main

Pushing to main branch automatically deploys on Heroku as bitpaper-api-docs, which is publicly accessible at https://developers.bitpaper.io

Authors

Bitpaper LTD