jekyll-template 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2829d7ec307e92b374fe19c457799f14b4452584
-  data.tar.gz: 6977dfb523c12d594d59c904f8c73aafdf189107
+  metadata.gz: cbaf9542ef68675be688856585381ee273716af0
+  data.tar.gz: 3cb196191b5eef544a7e2d714736ba4d8455f6b2
 SHA512:
-  metadata.gz: a43a38f471ec4b989d954703eae5c538e38862e4060605084608890f1e51d3c6935e27b217d0aa188a38f517a03f2545a489cf079b9e271e946899c6433a6aae
-  data.tar.gz: fd130fa5c6b3e938702f7756ae88e3aac9d6c18818ecf517d7eacd5c5bca1d3addc04c803e99d790df6fad737abf995d95440ca4d040e1f90cad97cb0c501d7a
+  metadata.gz: 6361f538145c5f0d03fd4778b861042355e95b63a737943e44ccba4a43dc1c0e83a0de7695a85afa05316b669526fb8dc9eddb5dec728a99e76359db816e76e5
+  data.tar.gz: 0c82dc7b6d99d39aa22ba787a8f90c5364bda759917cdbd6e9c50c59e36c08a0751c2ae1f10582f44df2747dafc9036363ac72077c1e93df6aaf08f600861197

data/.travis.yml

@@ -3,3 +3,9 @@ language: ruby
 rvm:
   - 2.3.3
 before_install: gem install bundler -v 1.13.7
+
+install:
+  - bundle install
+
+script:
+  - bundle exec rake test

data/Gemfile

@@ -1,6 +1,2 @@
 source 'https://rubygems.org'
 gemspec
-
-gem "jekyll", "3.1.2"
-gem "htmlcompressor", "~> 0.3.1"
-gem "unindent", "~> 1.0"

data/README.md

@@ -1,4 +1,7 @@
-# Jekyll::Template
+# jekyll-template [![Build Status](https://travis-ci.org/helpscout/jekyll-template.svg?branch=master)](https://travis-ci.org/helpscout/jekyll-template)
+
+Custom template block with YAML front matter support for Jekyll
+
 
 ## Installation
 
@@ -17,3 +20,148 @@ Or install it yourself as:
 ```
 gem install jekyll-template
 ```
+
+
+
+---
+
+
+
+## Documentation
+
+Templates (`{% template %}`) work similarly to Jekyll's `{% include %}` tag. It references an existing `.html` file for markup. However, the biggest difference (and most awesome feature) between `{% template %}` vs. `{% include %}` is that templates allow for content to be used inside the block.
+
+### Setting up the template directory
+
+The first thing you have to do to allow for template blocks to work is to create a new directory called `_templates` within your Jekyll site's source directory:
+
+```
+my-jekyll-site/
+├── _data/
+├── _includes/
+├── _plugins/
+├── _posts/
+├── _templates/ <-- Right here!
+└── index.md
+```
+
+Once you have your directory created, add template files as regular `.html` files (just like you would `_includes/` files).
+
+
+### Creating a template file
+
+Let's create a template file called `awesome.html`, which will be added to `_templates`.
+(Full path is `_templates/awesome.html`)
+
+```markdown
+<div class="awesome">
+  {{ template.content }}
+</div>
+```
+
+You can write whatever markup you would like inside a template file. The most important thing is to include a `{{ template.content }}` tag. This destinates where your content will be rendered.
+
+
+### Using a template block
+
+After creating our `awesome.html` template, we can use it in any of our Jekyll pages (or posts… heck even in `_include` files).
+
+For this example, let's add it to our `index.md` file:
+
+```markdown
+# Hello
+{% template awesome.html %}
+I am content!
+{% endtemplate %}
+```
+
+Your template content needs to begin with `{% template %}` and end with `{% endtemplate %}`. Be sure to include the path/name of the template file you wish to use.
+
+The final rendered `.html` will look like this:
+
+```html
+<h1 id="hello">Hello</h1>
+<div class="awesome"> <p>I am content!</p> </div>
+```
+
+
+## Rendering template content as HTML
+
+By default, templates parse and render content as **markdown**. To force templates to render content as HTML, all the `parse: "html"` attribute to your `{% template %}` tag.
+
+```markdown
+{% template awesome.html parse: "html" %}
+# Title
+I am content! As HTML!
+{% endtemplate %}
+```
+
+The final rendered `.html` will look like this:
+
+```html
+<div class="awesome"> # Title I am content! As HTML! </div>
+```
+
+
+
+## Using YAML front matter
+
+You can add YAML front matter to both your template files, just like Jekyll pages and posts.
+
+```
+---
+title: Awesome title
+---
+<div class="awesome">
+  <h1>{{ template.title</h1>
+
+  {{ template.content }}
+</div>
+```
+
+Front matter can also be defined in your `{% template %}` block. Any front matter data defined here will override the data defined in your original template.
+
+```
+{% template awesome.html %}
+---
+title: Best title
+---
+I am content!
+{% endtemplate %}
+```
+
+```html
+<div class="awesome">
+  <h1>Best title</h1>
+  <p>I am content!</p>
+</div>
+```
+
+
+## Using templates within templates
+
+Yo dawg. I heard you liked templates! The template block supports nesting 👏
+
+```markdown
+{% template outer.html %}
+  {% template inner.html %}
+    Hi!
+  {% endtemplate %}
+{% endtemplate %}
+```
+
+
+---
+
+
+More documentation coming soon!
+
+
+---
+
+
+## Note
+
+I am **not** a Ruby developer. (My background is mostly with Javascript). I wrote this plugin based on experimentation and combing through [Jekyll's](https://github.com/jekyll/jekyll) and [Liquid's](https://github.com/Shopify/liquid) source code + documentation. I'm sure there's probably code in there somewhere that's offensive to Ruby devs.
+
+We've been using `{% template %}` for many months now on the [Help Scout website](https://www.helpscout.net/), and it's been working great! We haven't noticed any slowdowns in build times (and we use **a lot** of templates).

data/Rakefile

@@ -1,6 +1,16 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rubygems'
+require 'rake'
+require 'rdoc'
+require 'date'
+require 'yaml'
+require 'rake/testtask'
 
-RSpec::Core::RakeTask.new(:spec)
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), *%w[lib]))
+require 'jekyll/version'
 
-task :default => :spec
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end

data/jekyll-template.gemspec

@@ -26,5 +26,10 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.13"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "minitest-reporters"
+  spec.add_development_dependency "minitest-profile"
+  spec.add_development_dependency "minitest", "~> 5.8"
+  spec.add_development_dependency "rspec-mocks"
+  spec.add_development_dependency "shoulda"
+  spec.add_development_dependency "kramdown"
 end

data/lib/jekyll/template/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Template
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-template
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - ItsJonQ
@@ -81,19 +81,89 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-profile
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.8'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - itsjonq@gmail.com