|
1 | | -# www.ruby-lang.org on Jekyll |
| 1 | +www.ruby-lang.org reloaded |
| 2 | +========================== |
2 | 3 |
|
3 | 4 | This is the official port of the |
4 | 5 | [www.ruby-lang.org](http://www.ruby-lang.org/) website to |
5 | | -[Jekyll](http://www.jekyllrb.com/). You can view the live site at |
6 | | -[ruby-lang.github.com](http://ruby-lang.github.com/). |
| 6 | +[Jekyll](http://www.jekyllrb.com/). You can view the live preview |
| 7 | +at [ruby-lang.github.io](http://ruby-lang.github.io/). |
7 | 8 |
|
8 | | -Right now we are in the middle of the transition from the |
9 | | -current Radiant CMS based site to this Jekyll based site. |
| 9 | +Right now, [we](https://github.com/ruby/www.ruby-lang.org/wiki/Team) are in the middle of the transition from the |
| 10 | +current RadiantCMS-based website to this Jekyll-based site. |
10 | 11 |
|
11 | | -## How to Contribute |
| 12 | +## How to Contribute? |
12 | 13 |
|
13 | 14 | You can contribute by comparing |
14 | 15 | [ruby-lang.github.com](http://ruby-lang.github.com/) |
15 | 16 | to [www.ruby-lang.org](http://www.ruby-lang.org/) |
16 | 17 | and reporting any inconsistencies between the two sites. |
17 | 18 |
|
18 | | -Changes of the content (corrections, improvements, ...) |
19 | | -will have to wait until after the migration. |
| 19 | +Changes of the content (corrections, improvements, …) and the design |
| 20 | +will have to wait until after the migration! |
20 | 21 |
|
21 | | -## Get It |
| 22 | +Further details about contributing are [available in the wiki](https://github.com/ruby/www.ruby-lang.org/wiki). |
22 | 23 |
|
23 | | -In order to preview your changes to the site you need to have |
| 24 | +## Get It! |
| 25 | + |
| 26 | +In order to preview your changes to the website, you need to have |
24 | 27 | [Jekyll and Pygments installed](https://github.com/mojombo/jekyll/wiki/install) |
25 | | -on your system. |
| 28 | +on your local system. |
26 | 29 |
|
27 | 30 | Clone the repository, create the site and start a local server: |
28 | 31 |
|
29 | | - $ git clone https://github.com/ruby/www.ruby-lang.org.git |
30 | | - $ cd www.ruby-lang.org/ |
31 | | - $ rake preview |
32 | | - |
33 | | -Then open `http://localhost:4000/` in your browser. |
34 | | - |
35 | | -Note that creating the site may take several minutes. |
| 32 | +``` |
| 33 | +git clone https://github.com/ruby/www.ruby-lang.org.git |
| 34 | +cd www.ruby-lang.org/ |
| 35 | +bundle install |
| 36 | +rake preview |
| 37 | +``` |
36 | 38 |
|
37 | | -To create the site without starting a local server use |
| 39 | +Then, open [http://localhost:4000/](http://localhost:4000/) in your browser. |
38 | 40 |
|
39 | | - $ rake generate |
| 41 | +Note that creating the website may take several minutes. |
40 | 42 |
|
41 | | -## Todo |
| 43 | +To create the website *without starting a local server*, use: |
42 | 44 |
|
43 | | -1. Compare [ruby-lang.github.com](http://ruby-lang.github.com/) to |
44 | | - [www.ruby-lang.org](http://www.ruby-lang.org/). Submit Issues for any |
45 | | - formatting mistakes. |
46 | | -2. Auto-generate the Top Projects page using a `rake` task that pulls |
47 | | - statistics from [www.rubygems.org](http://www.rubygems.org/). |
| 45 | +``` |
| 46 | +rake generate |
| 47 | +``` |
0 commit comments