Repository files navigation

This is theJekyll source ofthewww.ruby-lang.org website.

You can contribute by reporting errors or suggesting improvements.Just open an issue or pull request.

This is a big project with many translations involved.Please help us stay on top of things by following ourguidelines for contributors.

Bundler will take care of the dependencies, so unless youalready have done so, you might need to install bundler with:

gem install bundler

Then clone the repository and install the dependencies:

git clone https://github.com/ruby/www.ruby-lang.org.gitcd www.ruby-lang.org/bundle configset --local without productionbundle install

Making changes is easy:just locate the Markdown source of the page you want to improve,then make your changes or add content.

If you plan to submit a pull request or want to preview your changeson Heroku, you need to

• create a topic branch,
• commit your changes to this branch.

See theproject's wiki for some guidelines on howyour commits and PRs should look like.

Generate the website with

bundleexec rake build

Then start a local web server with

bundleexec rake serve

Openhttp://localhost:4000/in your browser to access the preview.

Note: The build of the site will take several minutes.

Alternatively, you can use Jekyll directly.

bundle exec jekyll serve --watch --future --incremental

If your draft uses future date, you may want to use--future option.

In case a build is not possible on your local machineor you want to test your changes under production conditionsyou can also create a preview on Heroku.

• Sign up forHeroku if you do not havean account yet.

• Install theHeroku Toolbelt.

• Unless you already have,cd into your local working copy of this repo.

• Create a preview app on Heroku using the custom buildpack:

  heroku loginheroku create --buildpack https://github.com/ruby/heroku-buildpack-www-ruby-lang.git

• Push your feature branch:

  git push heroku feature_branch:master

  To create a preview of the master branch:

  git push heroku master

Open the preview in your browser withheroku open orretrieve the preview URL usingheroku info and open it in your browser.

Besides generating and previewing the siteyou can perform additional tests with these tasks:

bundleexec rake lint# run linter on markdown filesbundleexec rake check:markup# check markup for all generated pagesbundleexec rake check:links# check for 404's (needs a running local server)

For more information see thewiki.