jekyll 1.5.1 → 2.0.0.alpha.1

data/site/docs/templates.md

@@ -209,9 +209,7 @@ root of your source directory. This will embed the contents of
 
     The name of the file you wish to embed can be literal (as in the example above),
     or you can use a variable, using liquid-like variable syntax as in
-    <code>{% raw %}{% include {{my_variable}} %}{% endraw %}</code>.
-
-    Note that unlike usual liquid variable syntax, you cannot have spaces inside the curly braces.
+    <code>{% raw %}{% include {{ my_variable }} %}{% endraw %}</code>.
 
   </p>
 </div>
@@ -232,8 +230,14 @@ These parameters are available via Liquid in the include:
 
 Jekyll has built in support for syntax highlighting of [over 100
 languages](http://pygments.org/languages/) thanks to
-[Pygments](http://pygments.org/). To use Pygments, you must have Python installed on your
-system and set `pygments` to `true` in your site's configuration file.
+[Pygments](http://pygments.org/). To use Pygments, you must have Python installed
+on your system and set `highlighter` to `pygments` in your site's configuration
+file.
+
+Alternatively, you can use [Rouge](https://github.com/jayferd/rouge) to highlight
+your code snippets. It doesn't support as many languages as Pygments does but
+it should fit in most cases and it's written in pure Ruby ; you don't need Python
+on your system!
 
 To render a code block with syntax highlighting, surround your code as follows:
 
@@ -249,8 +253,9 @@ end
 
 The argument to the `highlight` tag (`ruby` in the example above) is the
 language identifier. To find the appropriate identifier to use for the language
-you want to highlight, look for the “short name” on the [Lexers
-page](http://pygments.org/docs/lexers/).
+you want to highlight, look for the “short name” on the [Pygments' Lexers
+page](http://pygments.org/docs/lexers/) or the [Rouge
+wiki](https://github.com/jayferd/rouge/wiki/List-of-supported-languages-and-lexers).
 
 #### Line numbers
 
@@ -290,7 +295,7 @@ will generate the correct permalink URL for the post you specify.
 {% endraw %}
 {% endhighlight %}
 
-If you organize your posts in subdirectories, you need to include subdirectory 
+If you organize your posts in subdirectories, you need to include subdirectory
 path to the post:
 
 {% highlight text %}

data/site/docs/troubleshooting.md

@@ -28,10 +28,13 @@ sudo yum install ruby-devel
 {% endhighlight %}
 
 On [NearlyFreeSpeech](http://nearlyfreespeech.net/) you need to run the
-command with the following environment variable:
+following commands before installing Jekyll:
 
 {% highlight bash %}
-RB_USER_INSTALL=true gem install jekyll
+export GEM_HOME=/home/private/gems
+export GEM_PATH=/home/private/gems:/usr/local/lib/ruby/gems/1.8/
+export PATH=$PATH:/home/private/gems/bin
+export RB_USER_INSTALL='true'
 {% endhighlight %}
 
 On OSX, you may need to update RubyGems:
@@ -41,7 +44,7 @@ sudo gem update --system
 {% endhighlight %}
 
 If you still have issues, you may need to [use XCode to install Command Line
-Tools](http://www.zlu.me/blog/2012/02/21/install-native-ruby-gem-in-mountain-lion-preview/)
+Tools](http://www.zlu.me/ruby/os%20x/gem/mountain%20lion/2012/02/21/install-native-ruby-gem-in-mountain-lion-preview.html)
 that will allow you to install native gems using the following command:
 
 {% highlight bash %}
@@ -123,8 +126,8 @@ bug](http://aaronqian.com/articles/2009/04/07/redcloth-ate-my-notextile.html)
 and will hopefully be fixed for 4.2. You can still use 4.1.9, but the
 test suite requires that 4.1.0 be installed. If you use a version of
 RedCloth that does not have the notextile tag, you may notice that
-syntax highlighted blocks from Pygments are not formatted correctly,
-among other things. If you’re seeing this just install 4.1.0.
+syntax highlighted blocks from Pygments or Rouge are not formatted
+correctly, among other things. If you’re seeing this just install 4.1.0.
 
 ### Liquid
 

data/site/docs/usage.md

@@ -24,6 +24,17 @@ $ jekyll build --watch
 #    watched for changes, and regenerated automatically.
 {% endhighlight %}
 
+<div class="note warning">
+  <h5>Destination folders are cleaned on site builds</h5>
+  <p>
+    The contents of <code>&lt;destination&gt;</code> are automatically
+    cleaned when the site is built.  Files or folders that are not
+    created by your site will be removed.  Do not use an important
+    location for <code>&lt;destination&gt;</code>; instead, use it as
+    a staging area and copy files from there to your web server. 
+  </p>
+</div>
+
 Jekyll also comes with a built-in development server that will allow you to
 preview what the generated site will look like in your browser locally.
 

data/site/docs/variables.md

@@ -244,6 +244,24 @@ following is a reference of the available data.
 
       </p></td>
     </tr>
+    <tr>
+      <td><p><code>page.next</code></p></td>
+      <td><p>
+
+        The next post relative to the position of the current post in 
+        <code>site.posts</code>. Returns <code>nil</code> for the last entry.
+
+      </p></td>
+    </tr>
+    <tr>
+      <td><p><code>page.previous</code></p></td>
+      <td><p>
+
+        The previous post relative to the position of the current post in 
+        <code>site.posts</code>. Returns <code>nil</code> for the first entry.
+
+      </p></td>
+    </tr>
   </tbody>
 </table>
 </div>

data/site/docs/windows.md

@@ -0,0 +1,44 @@
+---
+layout: docs
+title: Jekyll on Windows
+prev_section: configuration
+next_section: posts
+permalink: /docs/windows/
+---
+
+While Windows is not an officially-supported platform, it can be used to run
+Jekyll with the proper tweaks. This page aims to collect some of the general
+knowledge and lessons that have been unearthed by Windows users.
+
+## Installation
+
+Madhur Ahuja has written up instructions to get
+[Jekyll running on Windows][windows-installation] and it seems to work for most.
+
+## Encoding
+
+If you use UTF-8 encoding, make sure that no `BOM` header
+characters exist in your files or very, very bad things will happen to
+Jekyll. This is especially relevant if you're running Jekyll on Windows.
+
+Additionally, you might need to change the code page of the console window to UTF-8
+in case you get a "Liquid Exception: Incompatible character encoding" error during
+the site generation process. It can be done with the following command:
+
+{% highlight bash %}
+$ chcp 65001
+{% endhighlight %}
+
+[windows-installation]: http://www.madhur.co.in/blog/2011/09/01/runningjekyllwindows.html
+
+## Auto-regeneration
+
+As of v1.3.0, Jekyll uses the `listen` gem to watch for changes when the
+`--watch` switch is specified during a build or serve. While `listen` has
+built-in support for UNIX systems, it requires an extra gem for compatibility
+with Windows. Add the following to the Gemfile for your site:
+
+{% highlight ruby %}
+require 'rbconfig'
+gem 'wdm', '~> 0.1.0' if RbConfig::CONFIG['target_os'] =~ /mswin|mingw/i
+{% endhighlight %}

data/test/helper.rb

@@ -1,11 +1,9 @@
-if RUBY_VERSION > '1.9'
-  require 'simplecov'
-  require 'simplecov-gem-adapter'
-  SimpleCov.start('gem')
+require 'simplecov'
+require 'simplecov-gem-adapter'
+SimpleCov.start('gem')
 
-  require 'coveralls'
-  Coveralls.wear_merged!
-end
+require 'coveralls'
+Coveralls.wear_merged!
 
 require 'rubygems'
 require 'test/unit'
@@ -19,7 +17,6 @@ require 'rdiscount'
 require 'kramdown'
 require 'redcarpet'
 
-require 'redgreen' if RUBY_VERSION < '1.9'
 require 'shoulda'
 require 'rr'
 

data/test/source/_includes/include.html

@@ -0,0 +1 @@
+included

data/test/source/_includes/sig.markdown

@@ -1,3 +1,3 @@
---
+---
 Tom Preston-Werner
-github.com/mojombo
+github.com/mojombo

data/test/source/_posts/2013-12-17-include-variable-filters.markdown

@@ -0,0 +1,21 @@
+---
+title: Post
+layout: post
+include1: include.html
+include2: include
+include3: INCLUDE
+include4: params
+---
+
+Liquid tests
+- 1 {% include {{ page.include1 }} %}
+- 2 {% include {{ page.include2 | append: '.html' }} %}
+- 3 {% include {{ page.include3 | downcase | append: '.html' }} %}
+
+Whitespace tests
+- 4 {% include {{page.include1}} %}
+- 5 {% include {{   page.include1}} %}
+- 6 {% include {{  page.include3   | downcase |   append:  '.html'}} %}
+
+Parameters test
+- 7 {% include {{ page.include4 | append: '.html' }} var1='foo' var2='bar' %}

data/test/source/_posts/2013-12-20-properties.text

@@ -0,0 +1,11 @@
+---
+categories: foo bar baz
+foo: bar
+layout: default
+tags: ay bee cee
+title: Properties Post
+---
+
+All the properties.
+
+Plus an excerpt.

data/test/source/_sass/_grid.scss

@@ -0,0 +1 @@
+.half { width: 50%; }

data/test/source/css/main.scss

@@ -0,0 +1,4 @@
+---
+---
+
+@import "grid";

data/test/source/js/coffeescript.coffee

@@ -0,0 +1,10 @@
+---
+---
+
+$ ->
+  list   = [1, 2, 3, 4, 5]
+  square = (x) -> x * x
+  cube   = (x) -> square(x) * x
+  cubes  = (math.cube num for num in list)
+
+  alert "I knew it!" if elvis?

data/test/source/properties.html

@@ -0,0 +1,8 @@
+---
+foo: bar
+layout: default
+permalink: /properties/
+title: Properties Page
+---
+
+All the properties.

data/test/source/unpublished.html

@@ -0,0 +1,7 @@
+---
+layout: default
+title: Not published!
+published: false
+---
+
+This should *not* be published!

data/test/test_coffeescript.rb

@@ -0,0 +1,49 @@
+require 'helper'
+
+class TestCoffeeScript < Test::Unit::TestCase
+  context "converting CoffeeScript" do
+    setup do
+      @site = Jekyll::Site.new(Jekyll.configuration({
+        "source" => source_dir,
+        "destination" => dest_dir
+      }))
+      @site.process
+      @test_coffeescript_file = dest_dir("js/coffeescript.js")
+      @js_output = <<-JS
+(function() {
+  $(function() {
+    var cube, cubes, list, num, square;
+    list = [1, 2, 3, 4, 5];
+    square = function(x) {
+      return x * x;
+    };
+    cube = function(x) {
+      return square(x) * x;
+    };
+    cubes = (function() {
+      var _i, _len, _results;
+      _results = [];
+      for (_i = 0, _len = list.length; _i < _len; _i++) {
+        num = list[_i];
+        _results.push(math.cube(num));
+      }
+      return _results;
+    })();
+    if (typeof elvis !== \"undefined\" && elvis !== null) {
+      return alert(\"I knew it!\");
+    }
+  });
+
+}).call(this);
+JS
+    end
+
+    should "write a JS file in place" do
+      assert File.exists?(@test_coffeescript_file), "Can't find the converted CoffeeScript file in the dest_dir."
+    end
+
+    should "produce JS" do
+      assert_equal @js_output, File.read(@test_coffeescript_file)
+    end
+  end
+end

data/test/test_configuration.rb

@@ -4,14 +4,14 @@ class TestConfiguration < Test::Unit::TestCase
   context "#stringify_keys" do
     setup do
       @mixed_keys = Configuration[{
-        'markdown' => 'maruku',
+        'markdown' => 'kramdown',
         :permalink => 'date',
         'baseurl'  => '/',
         :include   => ['.htaccess'],
         :source    => './'
       }]
       @string_keys = Configuration[{
-        'markdown'  => 'maruku',
+        'markdown'  => 'kramdown',
         'permalink' => 'date',
         'baseurl'   => '/',
         'include'   => ['.htaccess'],
@@ -51,11 +51,12 @@ class TestConfiguration < Test::Unit::TestCase
   context "#backwards_compatibilize" do
     setup do
       @config = Configuration[{
-        "auto"    => true,
-        "watch"   => true,
-        "server"  => true,
-        "exclude" => "READ-ME.md, Gemfile,CONTRIBUTING.hello.markdown",
-        "include" => "STOP_THE_PRESSES.txt,.heloses, .git"
+        "auto"     => true,
+        "watch"    => true,
+        "server"   => true,
+        "exclude"  => "READ-ME.md, Gemfile,CONTRIBUTING.hello.markdown",
+        "include"  => "STOP_THE_PRESSES.txt,.heloses, .git",
+        "pygments" => true,
       }]
     end
     should "unset 'auto' and 'watch'" do
@@ -78,6 +79,11 @@ class TestConfiguration < Test::Unit::TestCase
       assert @config.backwards_compatibilize.has_key?("include")
       assert_equal @config.backwards_compatibilize["include"], %w[STOP_THE_PRESSES.txt .heloses .git]
     end
+    should "set highlighter to pygments" do
+      assert @config.has_key?("pygments")
+      assert !@config.backwards_compatibilize.has_key?("pygments")
+      assert_equal @config.backwards_compatibilize["highlighter"], "pygments"
+    end
   end
   context "#fix_common_issues" do
     setup do
@@ -100,31 +106,36 @@ class TestConfiguration < Test::Unit::TestCase
     end
 
     should "fire warning with no _config.yml" do
-      mock(YAML).safe_load_file(@path) { raise SystemCallError, "No such file or directory - #{@path}" }
+      mock(SafeYAML).load_file(@path) { raise SystemCallError, "No such file or directory - #{@path}" }
       mock($stderr).puts("Configuration file: none".yellow)
       assert_equal Jekyll::Configuration::DEFAULTS, Jekyll.configuration({})
     end
 
     should "load configuration as hash" do
-      mock(YAML).safe_load_file(@path) { Hash.new }
+      mock(SafeYAML).load_file(@path) { Hash.new }
       mock($stdout).puts("Configuration file: #{@path}")
       assert_equal Jekyll::Configuration::DEFAULTS, Jekyll.configuration({})
     end
 
     should "fire warning with bad config" do
-      mock(YAML).safe_load_file(@path) { Array.new }
+      mock(SafeYAML).load_file(@path) { Array.new }
       mock($stderr).puts(("WARNING: ".rjust(20) + "Error reading configuration. Using defaults (and options).").yellow)
       mock($stderr).puts("Configuration file: (INVALID) #{@path}".yellow)
       assert_equal Jekyll::Configuration::DEFAULTS, Jekyll.configuration({})
     end
 
     should "fire warning when user-specified config file isn't there" do
-      mock(YAML).safe_load_file(@user_config) { raise SystemCallError, "No such file or directory - #{@user_config}" }
+      mock(SafeYAML).load_file(@user_config) { raise SystemCallError, "No such file or directory - #{@user_config}" }
       mock($stderr).puts(("Fatal: ".rjust(20) + "The configuration file '#{@user_config}' could not be found.").red)
       assert_raises LoadError do
         Jekyll.configuration({'config' => [@user_config]})
       end
     end
+
+    should "not clobber YAML.load to the dismay of other libraries" do
+      assert_equal :foo, YAML.load(':foo')
+      # as opposed to: assert_equal ':foo', SafeYAML.load(':foo')
+    end
   end
   context "loading config from external file" do
     setup do
@@ -137,19 +148,19 @@ class TestConfiguration < Test::Unit::TestCase
     end
 
     should "load default config if no config_file is set" do
-      mock(YAML).safe_load_file(@paths[:default]) { Hash.new }
+      mock(SafeYAML).load_file(@paths[:default]) { Hash.new }
       mock($stdout).puts("Configuration file: #{@paths[:default]}")
       assert_equal Jekyll::Configuration::DEFAULTS, Jekyll.configuration({})
     end
 
     should "load different config if specified" do
-      mock(YAML).safe_load_file(@paths[:other]) { {"baseurl" => "http://wahoo.dev"} }
+      mock(SafeYAML).load_file(@paths[:other]) { {"baseurl" => "http://wahoo.dev"} }
       mock($stdout).puts("Configuration file: #{@paths[:other]}")
       assert_equal Jekyll::Configuration::DEFAULTS.deep_merge({ "baseurl" => "http://wahoo.dev" }), Jekyll.configuration({ "config" => @paths[:other] })
     end
 
     should "load default config if path passed is empty" do
-      mock(YAML).safe_load_file(@paths[:default]) { Hash.new }
+      mock(SafeYAML).load_file(@paths[:default]) { Hash.new }
       mock($stdout).puts("Configuration file: #{@paths[:default]}")
       assert_equal Jekyll::Configuration::DEFAULTS, Jekyll.configuration({ "config" => @paths[:empty] })
     end
@@ -161,8 +172,8 @@ class TestConfiguration < Test::Unit::TestCase
     end
 
     should "load multiple config files" do
-      mock(YAML).safe_load_file(@paths[:default]) { Hash.new }
-      mock(YAML).safe_load_file(@paths[:other]) { Hash.new }
+      mock(SafeYAML).load_file(@paths[:default]) { Hash.new }
+      mock(SafeYAML).load_file(@paths[:other]) { Hash.new }
       mock(TOML).load_file(@paths[:toml]) { Hash.new }
       mock($stdout).puts("Configuration file: #{@paths[:default]}")
       mock($stdout).puts("Configuration file: #{@paths[:other]}")
@@ -171,8 +182,8 @@ class TestConfiguration < Test::Unit::TestCase
     end
 
     should "load multiple config files and last config should win" do
-      mock(YAML).safe_load_file(@paths[:default]) { {"baseurl" => "http://example.dev"} }
-      mock(YAML).safe_load_file(@paths[:other]) { {"baseurl" => "http://wahoo.dev"} }
+      mock(SafeYAML).load_file(@paths[:default]) { {"baseurl" => "http://example.dev"} }
+      mock(SafeYAML).load_file(@paths[:other]) { {"baseurl" => "http://wahoo.dev"} }
       mock($stdout).puts("Configuration file: #{@paths[:default]}")
       mock($stdout).puts("Configuration file: #{@paths[:other]}")
       assert_equal Jekyll::Configuration::DEFAULTS.deep_merge({ "baseurl" => "http://wahoo.dev" }), Jekyll.configuration({ "config" => [@paths[:default], @paths[:other]] })