alex-litvak / docs

Iron.io Dev Center documentation.

Iron.io Dev Center Documentation

The Dev Center docs are a Jekyll project. Refer to Jekyll's official docs and Using Jekyll with GitHub Pages for complete help. We give a quick start guide below.

Installation

1. Get Bundler, the Ruby dependency manager, if you don't have it already.
2. $ git clone https://github.com/iron-io/docs.git && cd docs
3. $ bundle install

Launching

1. In the project directory, run bundle exec jekyll serve
2. Open your browser to http://localhost:4000/

Development

In the project directory, run bundle exec jekyll serve --watch. This will auto-reload as you make changes to files.

Development using Cloud9 (http://c9.io)

1. Fork https://github.com/iron-io/docs to your GitHub account.
2. Log in (or sign up) at http://c9.io using GitHub.
3. Click on 'docs' under 'PROJECTS ON GITHUB' in the left menu.
4. Click the green 'CLONE TO EDIT' button.
5. In the terminal, run jekyll serve --watch --port $PORT.

When you are finished making your awesome edits, git commit && git push, then go back to GitHub to open a pull request.

Easy as pie and you never even had to leave your browser!