ALISS API Docs
Built with the Slate docs generator.
Getting Started with Slate
You're going to need:
- Linux or OS X — Windows may work, but is unsupported.
- Ruby, version 2.3.1 or newer
- Bundler — If Ruby is already installed, but the
bundlecommand doesn't work, just run
gem install bundlerin a terminal.
Getting Set Up
- Fork this repository on GitHub.
- Clone this repo to your hard drive with
git clone https://github.com/aliss/Docs.git ALISS-docs
- Initialize and start Slate. You can either do this locally, or with Vagrant:
# either run this to run locally bundle install bundle exec middleman server # OR run this to run with vagrant vagrant up
You can now see the docs at http://localhost:4567. Whoa! That was fast!
If you'd prefer to use Docker, instructions are available in the wiki.
Publishing Your Docs to GitHub Pages
Make sure you're working on a fork in your own account, not our original repo: git remote show origin.
Commit your changes to the markdown source:
git commit -a -m "Update index.md"
Push the markdown source changes to GitHub:
Thanks to the following people who have submitted major pull requests:
Also, thanks to Sauce Labs for sponsoring the development of the responsive styles.