adafruit-mirror/Adafruit_IO_Documentation
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
No description
207 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
dependabot[bot] 2f8e67aa61
Bump rexml from 3.3.6 to 3.3.9 
Bumps [rexml](https://github.com/ruby/rexml) from 3.3.6 to 3.3.9.
- [Release notes](https://github.com/ruby/rexml/releases)
- [Changelog](https://github.com/ruby/rexml/blob/master/NEWS.md)
- [Commits](https://github.com/ruby/rexml/compare/v3.3.6...v3.3.9)

---
updated-dependencies:
- dependency-name: rexml
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-10-28 18:53:53 +00:00
.github update as many dependencies as possible to pull project forward 2023-10-16 11:58:32 -05:00
lib add error message display helper 2019-09-24 13:37:12 -04:00
source Merge pull request #63 from adafruit/issue-50-update-key-images 2024-10-24 09:06:18 -05:00
.gitignore ignore sass-cache 2019-07-05 11:28:50 -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 update to latest dependencies, add sprockets hack to fix issue with js 2021-03-02 11:47:36 -06:00
deploy.sh init repo with files from brentru/slate 2019-03-15 10:05:13 -04:00
docker-compose.yml update as many dependencies as possible to pull project forward 2023-10-16 11:58:32 -05:00
Dockerfile update as many dependencies as possible to pull project forward 2023-10-16 11:58:32 -05:00
font-selection.json init repo with files from brentru/slate 2019-03-15 10:05:13 -04:00
Gemfile Bump nokogiri from 1.15.6 to 1.16.5 2024-05-13 23:33:17 +00:00
Gemfile.lock Bump rexml from 3.3.6 to 3.3.9 2024-10-28 18:53:53 +00:00
LICENSE init repo with files from brentru/slate 2019-03-15 10:05:13 -04:00
README.md Update README.md 2019-07-01 10:55:43 -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. 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.