/Squarelink-Docs

Squarelink API Documentation Pages (built using Slate)

Primary LanguageJavaScriptOtherNOASSERTION

Squarelink Developer Documentation

Documentation Home Page: https://squarelink.com/docs

Contributing to the Docs

  1. Fork this repository on GitHub.
  2. Clone your forked repository (not our original one) to your hard drive with git clone https://github.com/YOURUSERNAME/Squarelink-Docs.git
  3. cd slate
  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!

If you'd prefer to use Docker, instructions are available in the wiki.

Docs built with Slate

Slate: API Documentation Generator