jekyll 1.2.1 → 1.3.0.rc

data/site/docs/pagination.md

@@ -182,51 +182,30 @@ page with links to all but the current page.
 
 {% highlight html %}
 {% raw %}
-<div id="post-pagination" class="pagination">
+{% if paginator.total_pages > 1 %}
+<div class="pagination">
   {% if paginator.previous_page %}
-    <p class="previous">
-      {% if paginator.previous_page == 1 %}
-        <a href="/">Previous</a>
-      {% else %}
-        <a href="{{ paginator.previous_page_path }}">Previous</a>
-      {% endif %}
-    </p>
+    <a href="{{ paginator.previous_page_path | prepend: site.baseurl | replace: '//', '/' }}">&laquo; Prev</a>
   {% else %}
-    <p class="previous disabled">
-      <span>Previous</span>
-    </p>
+    <span>&laquo; Prev</span>
   {% endif %}
 
-  <ul class="pages">
-    <li class="page">
-      {% if paginator.page == 1 %}
-        <span class="current-page">1</span>
-      {% else %}
-        <a href="/">1</a>
-      {% endif %}
-    </li>
-
-    {% for count in (2..paginator.total_pages) %}
-      <li class="page">
-        {% if count == paginator.page %}
-          <span class="current-page">{{ count }}</span>
-        {% else %}
-          <a href="/page{{ count }}">{{ count }}</a>
-        {% endif %}
-      </li>
-    {% endfor %}
-  </ul>
+  {% for page in (1..paginator.total_pages) %}
+    {% if page == paginator.page %}
+      <em>{{ page }}</em>
+    {% elsif page == 1 %}
+      <a href="{{ '/index.html' | prepend: site.baseurl | replace: '//', '/' }}">{{ page }}</a>
+    {% else %}
+      <a href="{{ site.paginate_path | prepend: site.baseurl | replace: '//', '/' | replace: ':num', page }}">{{ page }}</a>
+    {% endif %}
+  {% endfor %}
 
   {% if paginator.next_page %}
-    <p class="next">
-      <a href="{{ paginator.next_page_path }}">Next</a>
-    </p>
+    <a href="{{ paginator.next_page_path | prepend: site.baseurl | replace: '//', '/' }}">Next &raquo;</a>
   {% else %}
-    <p class="next disabled">
-      <span>Next</span>
-    </p>
+    <span>Next &raquo;</span>
   {% endif %}
-
 </div>
+{% endif %}
 {% endraw %}
 {% endhighlight %}

data/site/docs/plugins.md

@@ -25,9 +25,27 @@ having to modify the Jekyll source itself.
 
 ## Installing a plugin
 
-In your site source root, make a `_plugins` directory. Place your plugins here.
-Any file ending in `*.rb` inside this directory will be loaded before Jekyll
-generates your site.
+You have 2 options for installing plugins:
+
+1. In your site source root, make a `_plugins` directory. Place your plugins here.
+    Any file ending in `*.rb` inside this directory will be loaded before Jekyll
+    generates your site.
+2. In your `_config.yml` file, add a new array with the key `gems` and the values
+    of the gem names of the plugins you'd like to use. An example:
+
+        gems: [jekyll-test-plugin, jekyll-jsonify, jekyll-assets]
+        # This will require each of these gems automatically.
+
+<div class="note info">
+  <h5>
+    <code>_plugins</code> and <code>gems</code>
+    can be used simultaneously
+  </h5>
+  <p>
+    You may use both of the aforementioned plugin options simultaneously in the
+    same site if you so choose. Use of one does not restrict the use of the other
+  </p>
+</div>
 
 In general, plugins you make will fall into one of three categories:
 
@@ -38,7 +56,45 @@ In general, plugins you make will fall into one of three categories:
 ## Generators
 
 You can create a generator when you need Jekyll to create additional content
-based on your own rules. For example, a generator might look like this:
+based on your own rules.
+
+A generator is a subclass of `Jekyll::Generator` that defines a `generate`
+method, which receives an instance of
+[`Jekyll::Site`]({{ site.repository }}/blob/master/lib/jekyll/site.rb).
+
+Generation is triggered for its side-effects, the return value of `generate` is
+ignored. Jekyll does not assume any particular side-effect to happen, it just
+runs the method.
+
+Generators run after Jekyll has made an inventory of the existing content, and
+before the site is generated. Pages with YAML front-matters are stored as
+instances of
+[`Jekyll::Page`]({{ site.repository }}/blob/master/lib/jekyll/page.rb)
+and are available via `site.pages`. Static files become instances of
+[`Jekyll::StaticFile`]({{ site.repository }}/blob/master/lib/jekyll/static_file.rb)
+and are available via `site.static_files`. See
+[`Jekyll::Site`]({{ site.repository }}/blob/master/lib/jekyll/site.rb)
+for more details.
+
+For instance, a generator can inject values computed at build time for template
+variables. In the following example the template `reading.html` has two
+variables `ongoing` and `done` that we fill in the generator:
+
+{% highlight ruby %}
+module Reading
+  class Generator < Jekyll::Generator
+    def generate(site)
+      ongoing, done = Book.all.partition(&:ongoing?)
+
+      reading = site.pages.detect {|page| page.name == 'reading.html'}
+      reading.data['ongoing'] = ongoing
+      reading.data['done'] = done
+    end
+  end
+end
+{% endhighlight %}
+
+This is a more complex generator that generates new pages:
 
 {% highlight ruby %}
 module Jekyll
@@ -95,7 +151,7 @@ Generators are only required to implement one method:
         <p><code>generate</code></p>
       </td>
       <td>
-        <p>String output of the content being generated.</p>
+        <p>Generates content as a side-effect.</p>
       </td>
     </tr>
   </tbody>
@@ -356,7 +412,7 @@ You can find a few useful plugins at the following locations:
 
 - [ArchiveGenerator by Ilkka Laukkanen](https://gist.github.com/707909): Uses [this archive page](https://gist.github.com/707020) to generate archives.
 - [LESS.js Generator by Andy Fowler](https://gist.github.com/642739): Renders LESS.js files during generation.
-- [Version Reporter by Blake Smith](https://gist.github.com/449491): Creates a version.html file containing the Jekyll version. 
+- [Version Reporter by Blake Smith](https://gist.github.com/449491): Creates a version.html file containing the Jekyll version.
 - [Sitemap.xml Generator by Michael Levin](https://github.com/kinnetica/jekyll-plugins): Generates a sitemap.xml file by traversing all of the available posts and pages.
 - [Full-text search by Pascal Widdershoven](https://github.com/PascalW/jekyll_indextank): Adds full-text search to your Jekyll site with a plugin and a bit of JavaScript.
 - [AliasGenerator by Thomas Mango](https://github.com/tsmango/jekyll_alias_generator): Generates redirect pages for posts when an alias is specified in the YAML Front Matter.
@@ -430,6 +486,10 @@ You can find a few useful plugins at the following locations:
 - [Jekyll Image Tag](https://github.com/robwierzbowski/jekyll-image-tag): Better images for Jekyll. Save image presets, generate resized images, and add classes, alt text, and other attributes.
 - [Ditaa Tag](https://github.com/matze/jekyll-ditaa) by [matze](https://github.com/matze): Renders ASCII diagram art into PNG images and inserts a figure tag.
 - [Good Include](https://github.com/penibelst/jekyll-good-include) by [Anatol Broder](http://penibelst.de/): Strips newlines and whitespaces from the end of include files before processing.
+- [Jekyll Suggested Tweet](https://github.com/davidensinger/jekyll-suggested-tweet) by [David Ensinger](https://github.com/davidensinger/): A Liquid tag for Jekyll that allows for the embedding of suggested tweets via Twitter’s Web Intents API.
+- [Jekyll Date Chart](https://github.com/GSI/jekyll_date_chart) by [GSI](https://github.com/GSI): Block that renders date line charts based on textile-formatted tables.
+- [Jekyll Image Encode](https://github.com/GSI/jekyll_image_encode) by [GSI](https://github.com/GSI): Tag that renders base64 codes of images fetched from the web.
+- [Jekyll Quick Man](https://github.com/GSI/jekyll_quick_man) by [GSI](https://github.com/GSI): Tag that renders pretty links to man page sources on the internet.
 
 #### Collections
 

data/site/docs/structure.md

@@ -31,6 +31,8 @@ A basic Jekyll site usually looks something like this:
 ├── _posts
 |   ├── 2007-10-29-why-every-programmer-should-play-nethack.textile
 |   └── 2009-04-26-barcamp-boston-4-roundup.textile
+├── _data
+|   └── members.yml
 ├── _site
 └── index.html
 {% endhighlight %}
@@ -121,6 +123,21 @@ An overview of what each of these does:
         </p>
       </td>
     </tr>
+    <tr>
+      <td>
+        <p><code>_data</code></p>
+      </td>
+      <td>
+        <p>
+
+          Well-formatted site data should be placed here. The jekyll engine will 
+          autoload all yaml files (ends with <code>.yml</code> or <code>.yaml</code>) 
+          in this directory. If there's a file <code>members.yml</code> under the directory, 
+          then you can access contents of the file through <code>site.data.members</code>.
+
+        </p>
+      </td>
+    </tr>
     <tr>
       <td>
         <p><code>_site</code></p>

data/site/docs/templates.md

@@ -7,9 +7,9 @@ permalink: /docs/templates/
 ---
 
 Jekyll uses the [Liquid](http://wiki.shopify.com/Liquid) templating language to
-process templates. All of the [standard Liquid tags and
-filters](http://wiki.github.com/shopify/liquid/liquid-for-designers) are
-supported, Jekyll even adds a few handy filters and tags of its own to make
+process templates. All of the standard Liquid [tags](http://wiki.shopify.com/Logic) and
+[filters](http://wiki.shopify.com/Filters) are
+supported. Jekyll even adds a few handy filters and tags of its own to make
 common tasks easier.
 
 ## Filters
@@ -33,7 +33,7 @@ common tasks easier.
          <code class='filter'>{% raw %}{{ site.time | date_to_xmlschema }}{% endraw %}</code>
         </p>
         <p>
-          <code class='output'>2008-11-17T13:07:54-08:00</code>
+          <code class='output'>2008-11-07T13:07:54-08:00</code>
         </p>
       </td>
     </tr>
@@ -47,7 +47,7 @@ common tasks easier.
          <code class='filter'>{% raw %}{{ site.time | date_to_rfc822 }}{% endraw %}</code>
         </p>
         <p>
-          <code class='output'>Mon, 17 Nov 2008 13:07:54 -0800</code>
+          <code class='output'>Mon, 07 Nov 2008 13:07:54 -0800</code>
         </p>
       </td>
     </tr>
@@ -61,7 +61,7 @@ common tasks easier.
          <code class='filter'>{% raw %}{{ site.time | date_to_string }}{% endraw %}</code>
         </p>
         <p>
-          <code class='output'>17 Nov 2008</code>
+          <code class='output'>07 Nov 2008</code>
         </p>
       </td>
     </tr>
@@ -75,7 +75,7 @@ common tasks easier.
          <code class='filter'>{% raw %}{{ site.time | date_to_long_string }}{% endraw %}</code>
         </p>
         <p>
-          <code class='output'>17 November 2008</code>
+          <code class='output'>07 November 2008</code>
         </p>
       </td>
     </tr>
@@ -173,6 +173,17 @@ common tasks easier.
         </p>
       </td>
     </tr>
+    <tr>
+      <td>
+        <p class='name'><strong>Data To JSON</strong></p>
+        <p>Convert Hash or Array to JSON.</p>
+      </td>
+      <td class='align-center'>
+        <p>
+         <code class='filter'>{% raw %}{{ site.data.projects | jsonify }}{% endraw %}</code>
+        </p>
+      </td>
+    </tr>
   </tbody>
 </table>
 </div>
@@ -192,6 +203,19 @@ Jekyll expects all include files to be placed in an `_includes` directory at the
 root of your source directory. This will embed the contents of
 `<source>/_includes/footer.html` into the calling file.
 
+<div class="note">
+  <h5>ProTip™: Use variables as file name</h5>
+  <p>
+
+    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.
+
+  </p>
+</div>
+
 You can also pass parameters to an include:
 
 {% highlight ruby %}

data/site/docs/upgrading.md

@@ -42,7 +42,7 @@ rebuild each time a file changes, just add the `--watch` flag at the end.
 ### Absolute Permalinks
 
 In Jekyll v1.0, we introduced absolute permalinks for pages in subdirectories.
-Until v1.1, it is **opt-in**. Starting with v1.1, however, absolute permalinks
+Until v2.0, it is **opt-in**. Starting with v2.0, however, absolute permalinks
 will become **opt-out**, meaning Jekyll will default to using absolute permalinks
 instead of relative permalinks.
 
@@ -50,9 +50,9 @@ instead of relative permalinks.
 * To continue using relative permalinks, set `relative_permalinks: true` in your configuration file.
 
 <div class="note warning" id="absolute-permalinks-warning">
-  <h5 markdown="1">Absolute permalinks will be default in v1.1 and on</h5>
+  <h5 markdown="1">Absolute permalinks will be default in v2.0 and on</h5>
   <p markdown="1">
-    Starting with Jekyll v1.1.0, `relative_permalinks` will default to `false`,
+    Starting with Jekyll v2.0, `relative_permalinks` will default to `false`,
     meaning all pages will be built using the absolute permalink behaviour.
     The switch will still exist until v2.0.
   </p>

data/site/docs/usage.md

@@ -40,7 +40,7 @@ $ jekyll serve --watch
 # => Same as `jekyll serve`, but watch for changes and regenerate automatically.
 {% endhighlight %}
 
-This is just a few of the available [configuration options](../configuration/).
+These are just a few of the available [configuration options](../configuration/).
 Many configuration options can either be specified as flags on the command line,
 or alternatively (and more commonly) they can be specified in a `_config.yml`
 file at the root of the source directory. Jekyll will automatically use the

data/site/docs/variables.md

@@ -2,14 +2,14 @@
 layout: docs
 title: Variables
 prev_section: pages
-next_section: migrations
+next_section: datafiles
 permalink: /docs/variables/
 ---
 
 Jekyll traverses your site looking for files to process. Any files with [YAML
 Front Matter](../frontmatter/) are subject to processing. For each of these
 files, Jekyll makes a variety of data available via the [Liquid templating
-system](http://wiki.github.com/shopify/liquid/liquid-for-designers). The
+system](http://wiki.shopify.com/Liquid). The
 following is a reference of the available data.
 
 ## Global Variables

data/test/helper.rb

@@ -1,7 +1,10 @@
-if RUBY_VERSION > '1.9' && ENV["COVERAGE"] == "true"
+if RUBY_VERSION > '1.9'
   require 'simplecov'
   require 'simplecov-gem-adapter'
   SimpleCov.start('gem')
+
+  require 'coveralls'
+  Coveralls.wear_merged!
 end
 
 require 'rubygems'

data/test/source/_data/languages.yml

@@ -0,0 +1,2 @@
+- java
+- ruby

data/test/source/_data/members.yaml

@@ -0,0 +1,7 @@
+- name: Jack
+  age: 27
+  blog: http://example.com/jack
+
+- name: John
+  age: 32
+  blog: http://example.com/john

data/test/source/_data/products.yml

@@ -0,0 +1,4 @@
+- name: sugar
+  price: 5.3
+- name: salt
+  price: 2.5

data/test/source/_layouts/post/simple.html

@@ -0,0 +1 @@
+<<< {{ content }} >>>

data/test/source/products.yml

@@ -0,0 +1,4 @@
+- name: sugar
+  price: 5.3
+- name: salt
+  price: 2.5

data/test/test_convertible.rb

@@ -40,7 +40,7 @@ class TestConvertible < Test::Unit::TestCase
       should "not parse if there is encoding error in file" do
         name = 'broken_front_matter3.erb'
         out = capture_stdout do
-          ret = @convertible.read_yaml(@base, name)
+          ret = @convertible.read_yaml(@base, name, :encoding => 'utf-8')
           assert_equal({}, ret)
         end
         assert_match(/invalid byte sequence in UTF-8/, out)

data/test/test_filters.rb

@@ -98,5 +98,16 @@ class TestFilters < Test::Unit::TestCase
     should "escape space as %20" do
       assert_equal "my%20things", @filter.uri_escape("my things")
     end
+
+    context "jsonify filter" do
+      should "convert hash to json" do
+        assert_equal "{\"age\":18}", @filter.jsonify({:age => 18})
+      end
+
+      should "convert array to json" do
+        assert_equal "[1,2]", @filter.jsonify([1, 2])
+        assert_equal "[{\"name\":\"Jack\"},{\"name\":\"Smith\"}]", @filter.jsonify([{:name => 'Jack'}, {:name => 'Smith'}])
+      end
+    end
   end
 end

data/test/test_kramdown.rb

@@ -12,24 +12,51 @@ class TestKramdown < Test::Unit::TestCase
           'footnote_nr'   => 1,
           'entity_output' => 'as_char',
           'toc_levels'    => '1..6',
-          'smart_quotes'  => 'lsquo,rsquo,ldquo,rdquo'
+          'smart_quotes'  => 'lsquo,rsquo,ldquo,rdquo',
+
+          'use_coderay'   => true,
+          'coderay_bold_every'=> 12,
+          'coderay' => {
+            'coderay_css'        => :style,
+            'coderay_bold_every' => 8
+          }
         }
       }
+      @config = Jekyll.configuration(@config)
+      @markdown = Converters::Markdown.new(@config)
     end
 
     # http://kramdown.rubyforge.org/converter/html.html#options
     should "pass kramdown options" do
-      markdown = Converters::Markdown.new(@config)
-      assert_equal "<h1>Some Header</h1>", markdown.convert('# Some Header #').strip
+      assert_equal "<h1>Some Header</h1>", @markdown.convert('# Some Header #').strip
     end
 
     should "convert quotes to smart quotes" do
-      markdown = Converters::Markdown.new(@config)
-      assert_match /<p>(&#8220;|“)Pit(&#8217;|’)hy(&#8221;|”)<\/p>/, markdown.convert(%{"Pit'hy"}).strip
+      assert_match /<p>(&#8220;|“)Pit(&#8217;|’)hy(&#8221;|”)<\/p>/, @markdown.convert(%{"Pit'hy"}).strip
 
       override = { 'kramdown' => { 'smart_quotes' => 'lsaquo,rsaquo,laquo,raquo' } }
       markdown = Converters::Markdown.new(@config.deep_merge(override))
       assert_match /<p>(&#171;|«)Pit(&#8250;|›)hy(&#187;|»)<\/p>/, markdown.convert(%{"Pit'hy"}).strip
     end
+
+    context "moving up nested coderay options" do
+      setup do
+        @markdown.convert('some markup')
+        @converter_config = @markdown.instance_variable_get(:@config)['kramdown']
+      end
+
+      should "work correctly" do
+        assert_equal :style, @converter_config['coderay_css']
+      end
+
+      should "also work for defaults" do
+        default = Jekyll::Configuration::DEFAULTS['kramdown']['coderay']['coderay_tab_width']
+        assert_equal default, @converter_config['coderay_tab_width']
+      end
+
+      should "not overwrite" do
+        assert_equal 12, @converter_config['coderay_bold_every']
+      end
+    end
   end
 end