adafruit-mirror/Adafruit_IO_Documentation
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
No description
71 commits 24 branches 0 tags 1.9 MiB
JavaScript 64.4%
HTML 27.4%
SCSS 6.1%
Shell 1.1%
Ruby 0.9%
Find a file
brentru 328ef1cee6 finish up mqtt data format page
2019-04-29 13:20:29 -04:00
.github add page build -> slack workflow 2019-03-15 11:05:09 -04:00
lib touch-ups, split cook book into separate html, start replacing HTTP Request w/ blockquote style 2019-04-26 15:21:48 -04:00
source finish up mqtt data format page 2019-04-29 13:20:29 -04:00
.gitignore add .gitignore. use .erb for index, etc to allow for image_tag helpers 2019-03-15 12:28:39 -04:00
CHANGELOG.md init repo with files from brentru/slate 2019-03-15 10:05:13 -04:00
CODE_OF_CONDUCT.md init repo with files from brentru/slate 2019-03-15 10:05:13 -04:00
config.rb TURNS OUT minify_html isn't even a thing 2019-04-29 11:47:41 -04:00
deploy.sh init repo with files from brentru/slate 2019-03-15 10:05:13 -04:00
docker-compose.yml init repo with files from brentru/slate 2019-03-15 10:05:13 -04:00
Dockerfile add --verbose to Dockerfile 2019-04-26 15:47:16 -04:00
font-selection.json init repo with files from brentru/slate 2019-03-15 10:05:13 -04:00
Gemfile init repo with files from brentru/slate 2019-03-15 10:05:13 -04:00
Gemfile.lock manual favicon generation 2019-04-29 12:08:23 -04:00
LICENSE init repo with files from brentru/slate 2019-03-15 10:05:13 -04:00
README.md touch README 2019-03-15 11:47:13 -04:00
Vagrantfile init repo with files from brentru/slate 2019-03-15 10:05:13 -04:00

README.md

Adafruit IO API Documentation

Repository of documentation for Adafruit IO's HTTP and MQTT API.

Contributing

Contributions are welcome!

Building locally

To build this project locally:

  1. Fork this repository on GitHub.

  2. Clone your forked repository:

git clone git@github.com:YOURUSERNAME/Adafruit_IO_Documentation.git

  1. cd Adafruit_IO_Documentation

  2. Next, you can initialize and start Slate. You can either do this with Docker or Vagrant.

using Docker

To run Slate:

docker-compose up

The API documentation will be located at http://localhost:4567/

Building a static copy of the documentation into build:

docker run --rm -v $PWD:/usr/src/app/source -w /usr/src/app/source slate_app bundle exec middleman build --clean

using Vagrant

To run slate: vagrant up.

This project is based on slate.