diff --git a/.bundle/config b/.bundle/config new file mode 100644 index 000000000..57d4641d1 --- /dev/null +++ b/.bundle/config @@ -0,0 +1,3 @@ +--- +BUNDLE_PATH: vendor/bundle +BUNDLE_DISABLE_SHARED_GEMS: '1' diff --git a/.gitignore b/.gitignore index f11e63506..c05f72793 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ _site/ -.DS_Store \ No newline at end of file +.DS_Store +vendor/bundle diff --git a/Gemfile b/Gemfile new file mode 100644 index 000000000..167ee20bb --- /dev/null +++ b/Gemfile @@ -0,0 +1,2 @@ +source 'https://rubygems.org' +gem 'jekyll' diff --git a/Gemfile.lock b/Gemfile.lock new file mode 100644 index 000000000..0a04a1a4f --- /dev/null +++ b/Gemfile.lock @@ -0,0 +1,39 @@ +GEM + remote: https://rubygems.org/ + specs: + colorator (0.1) + ffi (1.9.10) + jekyll (3.0.1) + colorator (~> 0.1) + jekyll-sass-converter (~> 1.0) + jekyll-watch (~> 1.1) + kramdown (~> 1.3) + liquid (~> 3.0) + mercenary (~> 0.3.3) + rouge (~> 1.7) + safe_yaml (~> 1.0) + jekyll-sass-converter (1.3.0) + sass (~> 3.2) + jekyll-watch (1.3.0) + listen (~> 3.0) + kramdown (1.9.0) + liquid (3.0.6) + listen (3.0.5) + rb-fsevent (>= 0.9.3) + rb-inotify (>= 0.9) + mercenary (0.3.5) + rb-fsevent (0.9.6) + rb-inotify (0.9.5) + ffi (>= 0.5.0) + rouge (1.10.1) + safe_yaml (1.0.4) + sass (3.4.19) + +PLATFORMS + ruby + +DEPENDENCIES + jekyll + +BUNDLED WITH + 1.10.6 diff --git a/README.md b/README.md index 3f5ae2eb2..e50306d1d 100644 --- a/README.md +++ b/README.md @@ -4,25 +4,56 @@ This repository contains the _static_ source of [scala-lang.org](http://scala-la 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. -## Dependencies +## Dependencies ## -You'll need Jekyll installed to generate and test the site. To get it, most people can install via RubyGems: +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. - gem install jekyll +## Building & Viewing ## -OSX users might have to update RubyGems: +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`. - sudo gem update --system +Start the server in the context of the bundle: -If in doubt, head over to the [Jekyll wiki](https://github.com/mojombo/jekyll/wiki) for installation instructions. + bundle exec jekyll serve -i -## Building +The generated site is available at `http://localhost:4000` -After cloning, cd into the `scala/scala-lang` directory and run: +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: - jekyll serve +bundle exec jekyll serve -i +Configuration file: /home/soc/Entwicklung/scala-lang/_config.yml + Source: /home/soc/Entwicklung/scala-lang + Destination: /home/soc/Entwicklung/scala-lang/_site + Incremental build: enabled + Generating... + done in 1.04 seconds. + Auto-regeneration: enabled for '/home/soc/Entwicklung/scala-lang' +Configuration file: /home/soc/Entwicklung/scala-lang/_config.yml + Server address: http://127.0.0.1:4000/ + Server running... press ctrl-c to stop. -To see the generated site, just visit `http://localhost:4000`. + + $ bundle exec jekyll serve -i + Configuration file: /Users/ben/src/scala.github.com/_config.yml + Source: /Users/ben/src/scala.github.com + Destination: /Users/ben/src/scala.github.com/_site + Incremental build: enabled + Generating... + done in 1.04 seconds. + Auto-regeneration: enabled for '/Users/ben/src/scala-lang' + +When you change a file, this output will tell you that jekyll is regenerating. It's not done until it says `done.` + + Server running... press ctrl-c to stop. + Regenerating: 1 file(s) at 2014-11-29 09:19:04 ...done in 0.9704294 seconds. + Regenerating: 3 file(s) at 2014-11-29 09:21:39 ...done in 1.9161814 seconds. + Regenerating: 2 file(s) at 2014-11-29 09:25:10 ...done in 1.2371298 seconds. + Regenerating: 2 file(s) at 2014-11-29 09:27:49 + +If you get `incompatible encoding` errors when generating the site under Windows, then ensure that the +console in which you are running jekyll can work with UTF-8 characters. As described in the blog +[Solving UTF problem with Jekyll on Windows](http://joseoncode.com/2011/11/27/solving-utf-problem-with-jekyll-on-windows/) +you have to execute `chcp 65001`. This command is best added to the `jekyll.bat`-script. ## YAML Front Matter diff --git a/_config.yml b/_config.yml index da3698bc3..fb6d69cfd 100644 --- a/_config.yml +++ b/_config.yml @@ -2,4 +2,6 @@ title: The Scala Programming Language scalaversion: "2.11.7" devscalaversion: "2.12.0-M3" + baseurl: "" +exclude: ["vendor"] \ No newline at end of file diff --git a/_includes/footer.html b/_includes/footer.html index 6236d409f..2030decfd 100644 --- a/_includes/footer.html +++ b/_includes/footer.html @@ -1,105 +1,2 @@ - -
- - - - - - - - - - - - - - - - - - - - - - - {% unless page.layout == 'page' %} - - - - {% endunless %} - - - -