Documentation site for ALISS API
Clone or download
Pull request Compare This branch is 22 commits ahead, 19 commits behind lord:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
lib
source
.editorconfig
.gitignore
.travis.yml
CHANGELOG.md
CODE_OF_CONDUCT.md
Gemfile
Gemfile.lock
LICENSE
README.md
Vagrantfile
config.rb
deploy.sh
font-selection.json

README.md

ALISS API Docs

The documetation for the ALISS.org API, available to view here.

Built with the Slate docs generator.

Getting Started with Slate

Prerequisites

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 bundle command doesn't work, just run gem install bundler in a terminal.

Getting Set Up

  1. Fork this repository on GitHub.
  2. Clone this repo to your hard drive with git clone https://github.com/aliss/Docs.git ALISS-docs
  3. cd ALISS-docs
  4. 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!

Now that Slate is all set up on your machine, you'll probably want to learn more about editing Slate markdown, or how to publish your docs.

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: git push

Run ./deploy.sh

Note on JavaScript Runtime

For those who don't have JavaScript runtime or are experiencing JavaScript runtime issues with ExecJS, it is recommended to add the rubyracer gem to your gemfile and run bundle again.

Contributor credits

Slate was built by Robert Lord while interning at TripIt.

Thanks to the following people who have submitted major pull requests:

Also, thanks to Sauce Labs for sponsoring the development of the responsive styles.

Special Thanks