Skip to content

Latest commit

 

History

History
45 lines (23 loc) · 1.96 KB

README.md

File metadata and controls

45 lines (23 loc) · 1.96 KB
Raw

Adafruit IO API Documentation

Repository of documentation for Adafruit IO's HTTP and MQTT API. This is a fork of the Slate documentation project. Slate is a set of templates and conventions applied to the middleman static site generator, so our documentation source mostly markdown formatted text and some Ruby, but the output is static HTML, css, and javascript.

You can visit the live documentation site at https://io.adafruit.com/api/docs/#adafruit-io

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.