https://github.com/anders94/api-docs
https://github.com/anders94/api-docs
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/anders94/api-docs
- Owner: anders94
- License: other
- Created: 2018-12-07T19:54:03.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2021-07-13T15:46:50.000Z (almost 5 years ago)
- Last Synced: 2025-03-26T09:21:15.629Z (about 1 year ago)
- Language: JavaScript
- Size: 334 KB
- Stars: 1
- Watchers: 2
- Forks: 13
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Poloniex API Documentation
==========================
This repository holds the `slate` based documentation for the Poloniex HTTP and Websocket based public facing API.
This is a complete content rewrite of the documentation without changes to the API's functionality.
Prerequisites
-------------
* ruby 2.3.1 or newer
* bundler
If you need bundler:
```shell
gem install bundler
```
Initialize
----------
```shell
git clone https://github.com/poloniex/api-docs
cd api-docs/
bundle install
```
Run
---
```shell
bundle exec middleman server
```
See
---
Navigate to http://localhost:4567
Edits
-----
All content lives in [source/](source/). Each section is an included file in the [source/includes/](source/includes/)
directory. Once you have edited a file, reloading the browser will show the incorporated changes.
Deploy
------
To deploy a set of flat files:
```bundle exec middleman build --clean```
Everything should end up in the `build/` directory.