Skip to content
Source of the https://www.ruby-lang.org website.
Branch: master
Clone or download
Latest commit 6b26f6c Apr 23, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
_data
_includes Convert faq-notice to markdown Apr 16, 2017
_layouts <meta charset> should be before <title> (#1421) Jul 7, 2016
_plugins Mark bg, fr, it, ru, vi as unmaintained Mar 13, 2019
admin Revive YAML front matter Mar 4, 2019
bg Update GitHub page for wxruby and fxruby in to ruby from java documen… Apr 12, 2019
de Update GitHub page for wxruby and fxruby in to ruby from java documen… Apr 12, 2019
en Add a note about merge commits Apr 22, 2019
es Fix typos (es) Apr 21, 2019
fr Update GitHub page for wxruby and fxruby in to ruby from java documen… Apr 12, 2019
id Update GitHub page for wxruby and fxruby in to ruby from java documen… Apr 12, 2019
images
it Update GitHub page for wxruby and fxruby in to ruby from java documen… Apr 12, 2019
ja Add newlines Apr 21, 2019
javascripts
ko
lib Remove HOST constant Mar 4, 2019
pl Update GitHub page for wxruby and fxruby in to ruby from java documen… Apr 12, 2019
pt Update GitHub page for wxruby and fxruby in to ruby from java documen… Apr 12, 2019
ru
security/20080823rexml Remove trailing whitespace Nov 8, 2014
stylesheets Adjust CSS for code (#1933) Dec 31, 2018
test
tr Update GitHub page for wxruby and fxruby in to ruby from java documen… Apr 12, 2019
vi Update GitHub page for wxruby and fxruby in to ruby from java documen… Apr 12, 2019
zh_cn Add newlines Apr 21, 2019
zh_tw
.gitignore ignore bin and update latest dependency Jul 12, 2013
.travis.yml typo Mar 17, 2019
404.md Add simple custom 404 page Nov 30, 2015
Gemfile bump up 2.6.3. Apr 23, 2019
Gemfile.lock update bundles Apr 23, 2019
Procfile use unicorn instead of passenger, because to prevent to shell-shock risk Oct 23, 2014
README.md Update instructions for development setup Oct 30, 2018
Rakefile Remove HOST constant Mar 4, 2019
_config.yml [RU] config: little wording Apr 12, 2019
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 Mark bg, fr, it, ru, vi as unmaintained Mar 13, 2019
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 --without production

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.

You can’t perform that action at this time.