From 4ffc8fdbce57e0ed4d8d523c503a776fbd17cf4b Mon Sep 17 00:00:00 2001 From: Seth Tisue Date: Thu, 17 Dec 2015 09:55:22 -0500 Subject: [PATCH 1/2] restore instructions for running with global Jekyll at @heathermiller's request --- README.md | 37 ++++++++++++++++++++++++++++++++----- 1 file changed, 32 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 001fde49f..57f3dde78 100644 --- a/README.md +++ b/README.md @@ -6,11 +6,23 @@ It's a static site generated by [Jekyll](https://github.com/mojombo/jekyll), and ## Dependencies -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. +This site uses a Jekyll, a Ruby framework. The required Jekyll version is 1.5.1. -## Building & Viewing +## Building the site -cd into the directory where you cloned this repository, then install the required gems with `bundle install`. This will automatically put the gems into `./bundle-vendor/bundle`. +There are two ways to run Jekyll to build the site: + +* using Bundler, so Jekyll and accompanying gems are installed only inside this directory +* using globally installed Jekyll and accompanying gems + +The latter method is the one currently actually used on +scala-lang.org, but the former method may be more convenient for users +who are comfortable using Bundler and who don't want anything else +installed system-wide. + +### Building with Bundler + +`cd` into the directory where you cloned this repository, then install the required gems with `bundle install`. This will automatically put the gems into `./bundle-vendor/bundle`. Start the server in the context of the bundle: @@ -25,9 +37,18 @@ and watch the output. You should see something like: Generating... done. Auto-regeneration: enabled for '/Users/ben/src/scala-lang' -The generated site is available at `http://localhost:4000`. +### Building with global Jekyll -Jekyll will automatically watch for changes on the filesystem. When you change a file, the console will show that jekyll is regenerating. Wait until it says `done` to refresh your browser. +You can install Jekyll 1.5.1 on your system without involving Bundler by using RubyGems: + + gem install jekyll -v 1.5.1 + +After cloning, cd into the directory where you cloned this repository and run: + + jekyll serve + +from this point, everything else should be the same, regardless of which method +you used to run Jekyll. ### Windows and UTF-8 @@ -36,6 +57,12 @@ console in which you are running jekyll can work with UTF-8 characters. As descr [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. +## Viewing the site + +Regardless of your method of running Jekyll, the generated site is available at `http://localhost:4000`. + +Jekyll will automatically watch for changes on the filesystem. When you change a file, the console will show that jekyll is regenerating. Wait until it says `done` to refresh your browser. + ## YAML Front Matter The "YAML Front Matter" is nothing more than the header on each page that you intend for Jekyll to parse. It contains information such as the name of the HTML template (layout) chosen for the specific document, and the title of the document. An example YAML front matter might look like: From 396ab5db4683383395c29e3d400d0eadaa2c3586 Mon Sep 17 00:00:00 2001 From: Seth Tisue Date: Thu, 17 Dec 2015 10:16:54 -0500 Subject: [PATCH 2/2] put the non-Bundler instructions first at @heathermiller's request --- README.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 57f3dde78..bd6f2707a 100644 --- a/README.md +++ b/README.md @@ -12,21 +12,23 @@ This site uses a Jekyll, a Ruby framework. The required Jekyll version is 1.5.1. There are two ways to run Jekyll to build the site: -* using Bundler, so Jekyll and accompanying gems are installed only inside this directory * using globally installed Jekyll and accompanying gems +* using Bundler, so Jekyll and accompanying gems are installed only inside this directory -The latter method is the one currently actually used on -scala-lang.org, but the former method may be more convenient for users -who are comfortable using Bundler and who don't want anything else +The former method is the one currently actually used on +scala-lang.org. The latter method may be more convenient for users who +are comfortable using Bundler and who don't want anything else installed system-wide. -### Building with Bundler +### Building with global Jekyll -`cd` into the directory where you cloned this repository, then install the required gems with `bundle install`. This will automatically put the gems into `./bundle-vendor/bundle`. +Install Jekyll 1.5.1 on your system using RubyGems: -Start the server in the context of the bundle: + gem install jekyll -v 1.5.1 - bundle exec jekyll serve +After cloning, cd into the directory where you cloned this repository and run: + + jekyll serve and watch the output. You should see something like: @@ -37,15 +39,13 @@ and watch the output. You should see something like: Generating... done. Auto-regeneration: enabled for '/Users/ben/src/scala-lang' -### Building with global Jekyll - -You can install Jekyll 1.5.1 on your system without involving Bundler by using RubyGems: +### Building with Bundler - gem install jekyll -v 1.5.1 +`cd` into the directory where you cloned this repository, then install the required gems with `bundle install`. This will automatically put the gems into `./bundle-vendor/bundle`. -After cloning, cd into the directory where you cloned this repository and run: +Start the server in the context of the bundle: - jekyll serve + bundle exec jekyll serve from this point, everything else should be the same, regardless of which method you used to run Jekyll.