Skip to content
API documentation for Adafruit IO
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
lib touch-ups, split cook book into separate html, start replacing HTTP R… Apr 26, 2019
source add current Pagination documentation May 3, 2019
.gitignore add .gitignore. use .erb for index, etc to allow for image_tag helpers Mar 15, 2019
CHANGELOG.md
CODE_OF_CONDUCT.md init repo with files from brentru/slate Mar 15, 2019
Dockerfile add --verbose to Dockerfile Apr 26, 2019
Gemfile update gem versions due to github vuln warnings Apr 30, 2019
Gemfile.lock update gem versions due to github vuln warnings Apr 30, 2019
LICENSE init repo with files from brentru/slate Mar 15, 2019
README.md
Vagrantfile init repo with files from brentru/slate Mar 15, 2019
config.rb TURNS OUT minify_html isn't even a thing Apr 29, 2019
deploy.sh
docker-compose.yml init repo with files from brentru/slate Mar 15, 2019
font-selection.json init repo with files from brentru/slate Mar 15, 2019

README.md

Adafruit IO API Documentation

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

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.

Contributing

Contributions are welcome!

This project is based on slate. All source for the documentation sections are in Markdown formatted text files in the source/includes directory.

If you see a change you'd like to make, you can fork this repository, commit your changes to your copy of the project, and submit it as a pull request. If you have a question or find that something is missing or incorrectly documented, you can let us know by creating a new issue on this project.

You can’t perform that action at this time.