ComponentKit Documentation

We use Jekyll to build the site using Markdown and host it on Github Pages.

Installation

To contribute to the site or add to the documentation, you will have to set up a local copy of the site on your development machine.

Dependencies

Github Pages uses Jekyll to host a site and Jekyll has the following dependencies.

• Ruby (version >= 1.8.7)
• RubyGems (version >= 1.3.7)
• Bundler

Mac OS X comes pre-installed with Ruby, but you may need to update RubyGems (via gem update --system). Otherwise, RVM and rbenv are popular ways to install Ruby. Once you have RubyGems and installed Bundler (via gem install bundler), use it to install the dependencies:

$ cd componentkit # Go to folder
$ bundle install # Might need sudo.

Instructions

Use Jekyll to serve the website locally (by default, at http://localhost:4000):

$ cd componentkit # Go to folder
$ git checkout docs
$ bundle exec jekyll serve -w
$ open http://localhost:4000/