HTML Ruby CSS JavaScript
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
_data Update maintenance status for Ruby 2.3 branch Apr 4, 2018
_includes Convert faq-notice to markdown Apr 16, 2017
_layouts <meta charset> should be before <title> (#1421) Jul 7, 2016
_plugins Remove pl from translation-status page Apr 8, 2017
admin Remove languages (suggested by @sorah) May 20, 2014
bg Fix url of maglev Apr 2, 2018
de Fix url of maglev Apr 2, 2018
en Fix url of maglev Apr 2, 2018
es Translated news of 2017-12-14 (es) Apr 26, 2018
fr Remove rubydox.net references in documents page (fr, tr) (#1745) Feb 21, 2018
id Translate CVE-2018-8777: DoS by large request in WEBrick news (id) (#… Apr 26, 2018
images Rename image file for more consistency Nov 23, 2014
it Fix typo (it) Dec 22, 2017
ja Fix url of maglev Apr 2, 2018
javascripts Simplify mobile menu behavior, avoid disabling top-level menu items w… Nov 28, 2013
ko Fix url of maglev Apr 2, 2018
pl Fix url of maglev Apr 2, 2018
pt Translate September 2016 posts (pt) Apr 26, 2018
ru Fix url of maglev Apr 2, 2018
security/20080823rexml Remove trailing whitespace Nov 8, 2014
stylesheets Add CSS for releases list Dec 12, 2016
tr Fix typo in to ruby from java post (tr) (#1758) Mar 7, 2018
vi Fix typo in latest news in 2.4.1 release post (vi) (#1779) Apr 25, 2018
zh_cn Fix url of maglev Apr 2, 2018
zh_tw Translate latest release posts and news (zh_tw) Mar 30, 2018
.gitignore ignore bin and update latest dependency Jul 12, 2013
.travis.yml workaround for 'bundler/dep_proxy' error. Apr 11, 2018
404.md Add simple custom 404 page Nov 30, 2015
Gemfile update bundles and bump ruby version to 2.5.1 Apr 11, 2018
Gemfile.lock update bundles and bump ruby version to 2.5.1 Apr 11, 2018
Procfile use unicorn instead of passenger, because to prevent to shell-shock risk Oct 23, 2014
README.md Remove mention of Pygments from README Mar 12, 2016
Rakefile Provide a 'build' task for all languages (#1678) Oct 23, 2017
_config.yml Update svn versions and branches in _config.yml Feb 27, 2018
config.ru Use https instead of http for svn.ruby-lang.org Sep 24, 2017
favicon.ico Proposed design for www.ruby-lang.org Nov 21, 2013
index.html Add body on index for crawlers and some browsers (#1560) Apr 17, 2017
security.asc Update pgp public key. It will expire at 2017-07-14 Jul 11, 2017
unicorn.rb use unicorn instead of passenger, because to prevent to shell-shock risk Oct 23, 2014

README.md

www.ruby-lang.org

Join the chat at https://gitter.im/ruby/www.ruby-lang.org

Build Status

This is the Jekyll source of the www.ruby-lang.org website.

How to Contribute?

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 our guidelines for contributors.

Get It!

Bundler will take care of the dependencies, so unless you already 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.git
cd www.ruby-lang.org/
bundle install

Make Changes

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 changes on Heroku, you need to

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

See the project's wiki for some guidelines on how your commits and PRs should look like.

Preview Your Changes

Preview Locally

Generate the website with

bundle exec rake build

Then start a local web server with

bundle exec rake serve

Open http://localhost:9292/ in your browser to access the preview.

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

Preview on Heroku

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

  • Sign up for Heroku if you do not have an account yet.

  • Install the Heroku 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 login
    heroku 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 with heroku open or retrieve the preview URL using heroku info and open it in your browser.

Testing

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

bundle exec rake check         # perform various tests on the source files
bundle exec rake check:markup  # check markup for all generated pages
bundle exec rake check:links   # check for 404's (needs a running local server)

More Information

For more information see the wiki.