README.md

Documentation of SKYDIPPER API

To see the documentation, you access to:

https://skydipper.github.io/doc-api

Requirements

• Ruby
• Bundler gem

Installation and usage

To install dependencies, use:

bundle install

To run the application server, use:

bundle exec middleman server

Deploying to production

deploy.sh

Contributor guidelines

• Contrary to what you may believe, Markdown rendering is not an exact science. Do test your changes by running the app server locally and checking the end result on the browser. Markdown preview tools output is known to be different from the HTML generated by this tool.

Credits

Created with slate project: