An open API service indexing awesome lists of open source software.

https://github.com/edgeapp/edge-docs

Documentation for the Edge SDK for Javascript
https://github.com/edgeapp/edge-docs

Last synced: about 1 year ago
JSON representation

Documentation for the Edge SDK for Javascript

Awesome Lists containing this project

README

          

Edge Developer Docs
------------------------------

### Prerequisites

You're going to need:

- **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.

### Getting Set Up

```shell
# run this to run locally
bundle install
bundle exec middleman server
```

You can now see the docs at http://localhost:4567. Whoa! That was fast!

To build the docs to static HTML files:
```shell
bundle exec middleman build --clean
```

The docs will be in the ```build``` directory