Ruby CSS HTML Shell
Latest commit 50d87db Nov 3, 2017 @3flex 3flex committed with jodosha Update whoami fixtures (#139)
Permalink
Failed to load latest commit information.
_test
content Switch to the wikipedia article for ISO 8601 as the old link was no l… Sep 24, 2017
fixtures Update whoami fixtures (#139) Nov 3, 2017
layouts Update some urls to point to the new repository (#148) Jul 28, 2017
lib API v2: rename auth_info into auth_code Sep 5, 2016
.gitignore Ignore s3_website.jar Oct 14, 2015
.ruby-gemset rvm rvmrc to ruby-version Apr 9, 2013
.ruby-version Upgrade Ruby Dec 11, 2016
.travis.yml Use bundler to run rake tasks May 2, 2016
Gemfile Update nanoc to 4.4 (#134) Dec 21, 2016
Gemfile.lock Update nanoc to 4.4 (#134) Dec 21, 2016
Guardfile Add guard-nanoc Jun 9, 2015
README.md update the link to nanoc website Aug 18, 2017
Rakefile Update nanoc to 4.4 (#134) Dec 21, 2016
Rules Remove old CNAME file Jul 9, 2016
nanoc.yaml
s3_website.yml Add redirects from default URL to v1 Jun 9, 2015

README.md

DNSimple API Documentation

This is the DNSimple API documentation built with nanoc.

Setup

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

$ nanoc --help

Development

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

Deployment

Each commit to master is deployed automatically via Travis.

Manual deployment

To publish the site manually you will need Java (as the static deployer is written in Scala).

Add a .env file with following variables, replacing ACCESS_ID and ACCESS_KEY with the real values.

S3_ID=ACCESS_ID
S3_SECRET=ACCESS_KEY

Finally, run:

$ rake publish