Skip to content
Beautiful static documentation for your API
JavaScript CSS Shell Other
Branch: master
Clone or download
Pull request Compare This branch is 198 commits ahead, 92 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
source
.gitignore
.rbenv-gemsets
.ruby-version
.travis.yml
CHANGELOG.md
Dockerfile
Gemfile
Gemfile.lock
LICENSE
README.md
config.rb
deploy.sh
doc.sh
docker-compose.yml
font-selection.json

README.md

Documentation of RW API

To see the documentation, you access to:

https://resource-watch.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

  • Keep in mind that this documentation is used for Resource Watch, Aqueduct and Global Forest Watch - each of these projects will have it's own /source/index-<project initials>.html.md
  • 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:

Slate: API Documentation Generator

You can’t perform that action at this time.