Skip to content

qoolife/developer.qoolife.com

Repository files navigation

developer.qoolife.com

Dependency Status

This is the developer documentation site for the Qoolife Developer Portal.

It's powered by nanoc and ready for deployment on heroku. And it's open source, you're encouraged to fork it and use it to document your API.

Setup

Ruby 1.9 is required to build the site.

Clone the repo, run bundle install to install the required gems, and launch nanoc with nanoc autocompile. You'll have your site running at http://localhost:3000

Changing content

Some basic understanding of nanoc is required, but the thing is: put your content on the content folder and run nanoc compile to generate the site on the output folder.

Deployment on Heroku

After updating your content and compiling the site, add the changes to your git repo and just git push heroku master will work on the Heroku cedar stack.

If you need to tweak something, take a look at the Gemfile, config.ru and Procfile files.