Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
The DNSimple API Documentation.
CSS HTML Ruby Shell
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
content
layouts
lib
.gitignore
.ruby-gemset
.ruby-version
Gemfile
Gemfile.lock
README.md
Rakefile
Rules
nanoc.yaml
s3_website.yml

README.md

DNSimple API Documentation

This is the DNSimple API documentation built with nanoc.

Setup

Ruby 1.9 is required to build the site, all the dependencies are managed using Bundler.

$ git clone https://github.com/aetrion/developer.dnsimple.com.git dnsimple-developer
$ cd dnsimple-developer
$ bundle

For a list of nanoc commands type

$ nanoc --help

Development

nanoc ships with an autocompiler that automatically compiles changed files on every HTTP request.

$ nanoc aco

Running on http://0.0.0.0:3000/
[2012-09-26 15:07:52] INFO  WEBrick 1.3.1
[2012-09-26 15:07:52] INFO  ruby 1.9.2 (2012-04-20) [x86_64-darwin12.1.0]
[2012-09-26 15:07:52] INFO  WEBrick::HTTPServer#start: pid=23121 port=3000

Deployment

To publish the site to S3, thus allowing HTTPS:

First, install Java (note on OS X I had to install the full JDK to get the command line java). Next, add a .env file with following:

S3_ID=ACCESS_ID
S3_SECRET=ACCESS_KEY

Finally, run:

$ rake publish
Something went wrong with that request. Please try again.