Bring Developer Site
CSS RAML HTML JavaScript Ruby
Latest commit 92cbf65 Feb 21, 2017 @robinsk robinsk committed on GitHub Merge pull request #117 from selbekk/master
Add some god damn padding.

README.md

Bring Developer

This repository contains the code behind http://developer.bring.com/

Our developer site is based on Jekyll and RAML. Jekyll is a static site generator, and RAML is a a YAML-based modeling language for APIs. We also use the lovely inuitcss CSS framework.

We currently use RAML 0.8 and ePages' RAML parser gem to parse the RAML files, and have a custom Jekyll plugin for converting the RAML files to HTML files.

The plugin reads a RAML->HTML map from config and outputs HTML files accordingly. RAML 0.8 has a couple of quirks, for example it doesn't have support for multiple examples, resulting in neat hacks here and there to string the page together. We're hoping to migrate to the newly launched RAML 1.0 spec soon.

Run locally

Jekyll can serve the site locally and auto-watch for changes:

brew install node
bundle install
bundle exec rake serve

This will clean the build, install necessary SASS dependencies and launch the site at http://127.0.0.1:4000/

Build release

Build a release (populate the _site dir) by running

bundle exec rake build