DNSimple API Documentation
This is the DNSimple API documentation built with nanoc.
Ruby 2 is required to build the site, all the dependencies are managed using Bundler.
git clone https://github.com/dnsimple/dnsimple-developer.git cd dnsimple-developer bundle
For a list of
nanoc commands type
To build the openapi.json file, run
rake compile before starting nanoc.
nanoc ships with an autocompiler that automatically compiles changed files on every HTTP request.
bundle exec nanoc live Loading site… done 11:56:37 - INFO - Compilation succeeded. [2016-12-21 11:56:37] INFO WEBrick 1.3.1 [2016-12-21 11:56:37] INFO ruby 2.3.3 (2016-11-21) [x86_64-darwin16] [2016-12-21 11:56:37] INFO WEBrick::HTTPServer#start: pid=63695 port=3000
Each commit to master is deployed automatically via Travis.
To publish the site manually you will need Java (as the static deployer is written in Scala).
.env file with following variables, replacing
ACCESS_KEY with the real values.