Skip to content
This repository was archived by the owner on Mar 28, 2019. It is now read-only.

sparkswap/slate

Repository files navigation

API Docs

Getting Started

Prerequisites

This project requires Go, Ruby, and Node.js (don't @ me).

  1. Make sure you have ruby installed (preferably using a version manager like rbenv)
  2. Install bundler for ruby gem install bundler
  3. Make sure you have go installed brew install go
  4. Install protobuf (access to protoc) brew install protobuf
  5. Install protoc-gen-doc go get -u github.com/pseudomuto/protoc-gen-doc/cmd/protoc-gen-doc
  6. Make sure you have node.js installed (recommended using nvm)

Installing dependencies

bundle install npm install

Generating Slate-compatible Markdown

./generate-md.sh

Running the development server

./dev.sh

Deploying

./deploy.sh

About

Slate API Docs for the Broker - DEPRECATED

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 99