Skip to content

Commit 8436887

Browse files
socSethTisue
soc
authored and
SethTisue
committed
for local use, recommend Bundler and provide config
so that people can test the site locally without having to install stuff systemwide on their local machines originally contributed by @soc as part of a larger PR, so I've retained him as author on the commit. the only significant thing I (@SethTisue) did differently was specify Jekyll 2, not 3, in Gemfile.lock, since Jekyll 2 is what we're using in production
1 parent 344f42b commit 8436887

File tree

7 files changed

+197
-11
lines changed

7 files changed

+197
-11
lines changed

‎.bundle/config

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
BUNDLE_PATH: vendor/bundle
3+
BUNDLE_DISABLE_SHARED_GEMS: '1'

‎.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,4 @@
11
_site/
2-
.DS_Store
2+
.DS_Store
3+
/vendor/bundle/
4+
/.jekyll-metadata

‎Gemfile

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
source 'https://rubygems.org'
2+
gem 'jekyll'

‎Gemfile.lock

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
GEM
2+
remote: https://rubygems.org/
3+
specs:
4+
blankslate (2.1.2.4)
5+
celluloid (0.16.0)
6+
timers (~> 4.0.0)
7+
classifier-reborn (2.0.3)
8+
fast-stemmer (~> 1.0)
9+
coffee-script (2.4.1)
10+
coffee-script-source
11+
execjs
12+
coffee-script-source (1.9.1.1)
13+
colorator (0.1)
14+
execjs (2.5.2)
15+
fast-stemmer (1.0.2)
16+
ffi (1.9.10)
17+
hitimes (1.2.2)
18+
jekyll (2.4.0)
19+
classifier-reborn (~> 2.0)
20+
colorator (~> 0.1)
21+
jekyll-coffeescript (~> 1.0)
22+
jekyll-gist (~> 1.0)
23+
jekyll-paginate (~> 1.0)
24+
jekyll-sass-converter (~> 1.0)
25+
jekyll-watch (~> 1.1)
26+
kramdown (~> 1.3)
27+
liquid (~> 2.6.1)
28+
mercenary (~> 0.3.3)
29+
pygments.rb (~> 0.6.0)
30+
redcarpet (~> 3.1)
31+
safe_yaml (~> 1.0)
32+
toml (~> 0.1.0)
33+
jekyll-coffeescript (1.0.1)
34+
coffee-script (~> 2.2)
35+
jekyll-gist (1.2.1)
36+
jekyll-paginate (1.1.0)
37+
jekyll-sass-converter (1.2.0)
38+
sass (~> 3.2)
39+
jekyll-watch (1.2.1)
40+
listen (~> 2.7)
41+
kramdown (1.5.0)
42+
liquid (2.6.2)
43+
listen (2.10.1)
44+
celluloid (~> 0.16.0)
45+
rb-fsevent (>= 0.9.3)
46+
rb-inotify (>= 0.9)
47+
mercenary (0.3.5)
48+
parslet (1.5.0)
49+
blankslate (~> 2.0)
50+
posix-spawn (0.3.11)
51+
pygments.rb (0.6.3)
52+
posix-spawn (~> 0.3.6)
53+
yajl-ruby (~> 1.2.0)
54+
rb-fsevent (0.9.5)
55+
rb-inotify (0.9.5)
56+
ffi (>= 0.5.0)
57+
redcarpet (3.3.1)
58+
safe_yaml (1.0.4)
59+
sass (3.4.16)
60+
timers (4.0.1)
61+
hitimes
62+
toml (0.1.2)
63+
parslet (~> 1.5.0)
64+
yajl-ruby (1.2.1)
65+
66+
PLATFORMS
67+
ruby
68+
69+
DEPENDENCIES
70+
jekyll
71+
72+
BUNDLED WITH
73+
1.10.6

‎README.md

Lines changed: 28 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,43 @@ This repository contains the _static_ source of [scala-lang.org](http://scala-la
44

55
It's a static site generated by [Jekyll](https://github.com/mojombo/jekyll), and uses a whole host of open-source tools including a touch of Twitter's Bootstrap.
66

7-
## Dependencies
7+
## Dependencies ##
88

9-
You'll need Jekyll installed to generate and test the site. To get it, most people can install via RubyGems:
9+
This site uses a Jekyll, a Ruby framework. You'll need Ruby and Bundler installed; see [Jekyll installation instructions](http://jekyllrb.com/docs/installation/) for the details.
1010

11-
gem install jekyll
11+
## Building & Viewing ##
1212

13-
OSX users might have to update RubyGems:
13+
cd into the directory where you cloned this repository, then install the required gems with `bundle install`. This will automatically put the gems into `./vendor/bundle`.
1414

15-
sudo gem update --system
15+
Start the server in the context of the bundle:
1616

17-
If in doubt, head over to the [Jekyll wiki](https://github.com/mojombo/jekyll/wiki) for installation instructions.
17+
bundle exec jekyll serve -i
1818

19-
## Building
19+
The generated site is available at `http://localhost:4000`
2020

21-
After cloning, cd into the `scala/scala-lang` directory and run:
21+
Jekyll will automatically watch for changes on the filesystem, and regenerate the site. It can take a few minutes for your changes to appear. Watch the output from `jekyll serve`. When you start up you'll see this:
2222

23-
jekyll serve
23+
$ bundle exec jekyll serve -i
24+
Configuration file: /Users/ben/src/scala.github.com/_config.yml
25+
Source: /Users/ben/src/scala.github.com
26+
Destination: /Users/ben/src/scala.github.com/_site
27+
Incremental build: enabled
28+
Generating...
29+
done in 1.04 seconds.
30+
Auto-regeneration: enabled for '/Users/ben/src/scala-lang'
2431

25-
To see the generated site, just visit `http://localhost:4000`.
32+
When you change a file, this output will tell you that jekyll is regenerating. It's not done until it says `done.`
33+
34+
Server running... press ctrl-c to stop.
35+
Regenerating: 1 file(s) at 2014-11-29 09:19:04 ...done in 0.9704294 seconds.
36+
Regenerating: 3 file(s) at 2014-11-29 09:21:39 ...done in 1.9161814 seconds.
37+
Regenerating: 2 file(s) at 2014-11-29 09:25:10 ...done in 1.2371298 seconds.
38+
Regenerating: 2 file(s) at 2014-11-29 09:27:49
39+
40+
If you get `incompatible encoding` errors when generating the site under Windows, then ensure that the
41+
console in which you are running jekyll can work with UTF-8 characters. As described in the blog
42+
[Solving UTF problem with Jekyll on Windows](http://joseoncode.com/2011/11/27/solving-utf-problem-with-jekyll-on-windows/)
43+
you have to execute `chcp 65001`. This command is best added to the `jekyll.bat`-script.
2644

2745
## YAML Front Matter
2846

‎_config.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,6 @@ title: The Scala Programming Language
22

33
scalaversion: "2.11.7"
44
devscalaversion: "2.12.0-M3"
5+
56
baseurl: ""
7+
exclude: ["vendor"]

‎_data/languages.yml

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
ar:
2+
name: "العربية"
3+
4+
bn:
5+
name: "বাংলা"
6+
7+
ca:
8+
name: "Català"
9+
10+
cs:
11+
name: "Čeština"
12+
13+
de:
14+
name: "Deutsch"
15+
16+
en:
17+
name: "English"
18+
19+
es:
20+
name: "Español"
21+
22+
fa:
23+
name: "فارسی"
24+
25+
fi:
26+
name: "Suomi"
27+
28+
fr:
29+
name: "Français"
30+
31+
he:
32+
name: "עברית"
33+
34+
hi:
35+
name: "हिन्दी"
36+
37+
hu:
38+
name: "Magyar"
39+
40+
id:
41+
name: "Bahasa Indonesia"
42+
43+
it:
44+
name: "Italiano"
45+
46+
ja:
47+
name: "日本語"
48+
49+
ko:
50+
name: "한국어"
51+
52+
nl:
53+
name: "Nederlands"
54+
55+
no:
56+
name: "Norsk (Bokmål)"
57+
58+
pl:
59+
name: "Polski"
60+
61+
pt:
62+
name: "Português"
63+
64+
"pt-br":
65+
name: "Português (Brasil)"
66+
67+
ru:
68+
name: "Русский"
69+
70+
sv:
71+
name: "Svenska"
72+
73+
tr:
74+
name: "Türkçe"
75+
76+
vi:
77+
name: "Tiếng Việt"
78+
79+
uk:
80+
name: "Українська"
81+
82+
"zh-cn":
83+
name: "中文 (简体)"
84+
85+
"zh-tw":
86+
name: "中文 (繁體)"

0 commit comments

Comments
 (0)