flytbase / apidoc

Beautiful static documentation for your API

Documentation for Flytbase API.

This documentation was created with Slate. Check it out here.

Making Changes

Prerequisites

You're going to need:

• Linux or OS X — Windows may work, but is unsupported.
• Ruby, version 2.2.5 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 your forked repository (not our original one) to your hard drive with git clone https://github.com/YOURUSERNAME/apidoc.git
3. cd apidoc
4. Initialize and start local documentation server. This can be done 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.

Now that the docs are all set up on your machine, you'll probably want to learn more about editing Slate markdown. If you'd prefer to use Docker, instructions are available in the wiki.

Need Help? Found a bug?

• Feel free to submit pull requests with bug fixes or changes.

• As a rule of thumb, it is suggested that small and granular changes be made in each pull request to keep the review and merge overhead small.