octopress-render-tag 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 539fdbbce7d742530f4527ea56e83d272c6a6a70
-  data.tar.gz: fc1e28edc69bc187034360140cc56cfb6f11befb
+  metadata.gz: 9b7bc14072b5f104f39c3dd26be2e5d59278cd4c
+  data.tar.gz: bfc0cb50384db2d1d1a6fd694fe913ac7ee873f3
 SHA512:
-  metadata.gz: 2b794024673a8277a446b31fbf257569c9661d7ff94974d8e798f6d9441b0478ed010a639be23f9e6c8458746d908ecea3f47435a9b56f8993871afe577bce7b
-  data.tar.gz: 83739823b0d0d02106acc3abd0aeda46ea411a5217b4b542b8f809e8d4fe717e0223bce689d1511a82f8ff243e3fe8ebba9768f0691638dc672ba33f152378ea
+  metadata.gz: a5b72cb799bdfc06984ac7e99d40a7b28d3ac1cc530252cc7d961ca78b22152aa694462b6c23d170f233b94cfacd56a0fcedb4fc9efca2ac68db80fd3ff808c5
+  data.tar.gz: aad1715ddd874322f113948c97f8539a7de1c527bdd2f711000ffeb5cb73286b441b098c4e17ff27dda1033e10593573977b8345095caa6f25897344a83ed381

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+### 1.0.6 - 2015-01-11
+
+- Minor docs updates
+- Module name change
+
 ### 1.0.5 - 2015-01-03
 
 - Removed duplicate docs.

data/README.md

@@ -8,22 +8,24 @@ Use the render tag to embed files directly from the file system. This tag also s
 
 ## Installation
 
-Add this line to your application's Gemfile:
+If you're using bundler add this gem to your site's Gemfile in the `:jekyll_plugins` group:
 
-    gem 'octopress-render-tag'
+    group :jekyll_plugins do
+      gem 'octopress-render-tag'
+    end
 
-And then execute:
+Then install the gem with Bundler
 
     $ bundle
 
-Or install it yourself as:
+To install manually without bundler:
 
     $ gem install octopress-render-tag
 
-Next add it to your gems list in Jekyll's `_config.yml`
+Then add the gem to your Jekyll configuration.
 
     gems:
-      - octopress-render-tag
+      -octopress-render-tag
 
 ## Usage
 
@@ -31,50 +33,64 @@ Next add it to your gems list in Jekyll's `_config.yml`
 
 By default paths passed to the render tag are relative to the site source directory.
 
-    {% render _file.html %}      // relative to site source
+```
+{% render _file.html %}      // relative to site source
+```
 
 Relative paths like these are relative to the current file.
 
-    // some_page/test.html
-    
-    {% render ./_file.html %}              // renders some_page/_file.html
-    {% render ../other_page/_file.html %}  // renders other_page/_file.html
+<!-- title:"A page in the directory 'some_dir'" -->
+```
+{% render ./_file.html %}              // renders some_dir/_file.html
+{% render ../other_dir/_file.html %}   // renders other_dir/_file.html
+```
 
 You can even render files relative to system paths, however, remember that these renders will only work if
 the site is rendered on your system. If these files move, your site will fail to build.
 
-    {% render /_file.html %}     // relative to system root
-    {% render ~/_file.html %}    // relative to system user
+```
+{% render /_file.html %}     // relative to system root
+{% render ~/_file.html %}    // relative to system user
+```
 
 ### Render tag features
 
 Render partials stored as a variable.
 
-    // If a page has the YAML front-matter
-    // theme: _post_themes/blue.css
+```html
+---
+theme: _post_themes/feature.css
+---
 
-    <style>{% render page.theme %}</style>
+<style>{% render page.theme %}</style>
+```
 
 Render partials conditionally, using `if`, `unless` and ternary logic.
 
-    {% render ./post-footer.html if post.footer %}
-    {% render ./page-footer.html unless page.footer == false %}
-    {% render (post ? ./post-footer.html : ./page-footer.html) %}
+```
+{% render ./post-footer.html if post.footer %}
+{% render ./page-footer.html unless page.footer == false %}
+{% render (post ? ./post-footer.html : ./page-footer.html) %}
+```
 
 Filter partials.
 
-    {% render ./foo.html %}            //=> Yo, what's up
-    {% render ./foo.html | upcase %}   //=> YO, WHAT'S UP
+```
+{% render ./foo.html %}            //=> Yo, what's up
+{% render ./foo.html | upcase %}   //=> YO, WHAT'S UP
+```
 
-Automatic template processing.
+Automatic template processing. Markdown and textile files can be embedded in HTML files.
 
-    // in some_page.html
-    {% render _test.md %}      // outputs markdown rendered to HTML
+```
+{% render _test.md %}   // renders as html
+```
 
-Avoid template processing.
+If you want, you can disable template processing.
 
-    // in some_page.html
-    {% render raw _test.md %}  // Markdown is not processed
+```
+{% render raw _test.md %}  // Markdown is not processed
+```
 
 ## Contributing
 

data/lib/octopress-render-tag.rb

@@ -5,7 +5,7 @@ require "jekyll"
 
 module Octopress
   module Tags
-    module RenderTag
+    module Render
       class Tag < Liquid::Tag
         SYNTAX = /(\S+)(.+)?/
 
@@ -95,8 +95,8 @@ module Octopress
   end
 end
 
-Liquid::Template.register_tag('render', Octopress::Tags::RenderTag::Tag)
-Liquid::Template.register_tag('render_partial', Octopress::Tags::RenderTag::Tag)
+Liquid::Template.register_tag('render', Octopress::Tags::Render::Tag)
+Liquid::Template.register_tag('render_partial', Octopress::Tags::Render::Tag)
 
 if defined? Octopress::Docs
   Octopress::Docs.add({
@@ -105,6 +105,6 @@ if defined? Octopress::Docs
     path:        File.expand_path(File.join(File.dirname(__FILE__), "../")),
     type:        "tag",
     source_url:  "https://github.com/octopress/render-tag",
-    version:     Octopress::Tags::RenderTag::VERSION
+    version:     Octopress::Tags::Render::VERSION
   })
 end

data/lib/octopress-render-tag/version.rb

@@ -1,7 +1,7 @@
 module Octopress
   module Tags
-    module RenderTag
-      VERSION = "1.0.5"
+    module Render
+      VERSION = "1.0.6"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: octopress-render-tag
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors:
 - Brandon Mathis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-03 00:00:00.000000000 Z
+date: 2015-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octopress-tag-helpers