The source for the Ember.js Guides.
Please see CONTRIBUTING.md.
Please see TRANSLATIONS.md.
The Guides' content is in the source folder. The left nav bar is produced from
data/pages.yml. lib contains Middleman plugins, and spec contains tests
for those plugins.
The Guides are built with Middleman, which runs on Ruby 1.9.3 or newer (2.0.0 recommended).
Mac users should install Ruby using rbenv to avoid changing their OS dependencies:
brew install rbenv
Follow the rbenv installation instructions to install the Ruby version specified here, then go through the init steps, set a global version, and restart the terminal. If gem env home shows rbenv in the path, your installation was successful. You should not have to sudo install any gems.
Once you have installed Ruby, you will need bundler and Middleman:
gem install bundler middleman
During build, Middleman will require Aspell to look for misspellings. On Macs, it can be installed via Homebrew:
brew install aspell --with-lang-enOn Windows, you can download an installer, but unfortunately it is unmaintained. On Linux, you can install with your distribution's package manager. On all platforms, you can also build the most recent version from source.
Some Mac users may also need to install openSSL, which will be indicated in an error during the bundle command. See Troubleshooting.md.
To get started:
git clone git://github.com/emberjs/guides.git
cd guides
bundle
bundle exec middlemanThen visit http://localhost:4567/.
If you run into problems, check Troubleshooting.md.
If you have a false hit during spellchecking, you can add the word to /data/spelling-exceptions.txt.
Words are line separated and case insensitive.
See MAINTAINERS.md.