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.
- Get Bundler, the Ruby dependency manager, if you don't have it already.
$ git clone https://github.com/iron-io/docs.git && cd docs
$ bundle install
- In the project directory, run
bundle exec jekyll serve
- Open your browser to http://localhost:4000/
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)
- Fork https://github.com/iron-io/docs to your GitHub account.
- Log in (or sign up) at http://c9.io using GitHub.
- Click on 'docs' under 'PROJECTS ON GITHUB' in the left menu.
- Click the green 'CLONE TO EDIT' button.
- 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!