octopress-codeblock 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4a8d963285d4e2e9e375a83c09323173e9d6b476
-  data.tar.gz: 57a18c04383f01bb377204fba692527812c616e5
+  metadata.gz: 3960abd79a5edaa4949c47119cc67a47fddda358
+  data.tar.gz: ae9af203849773f3e2d49483862e2e531d85cc08
 SHA512:
-  metadata.gz: cb3c9aee6c42914f1c2a9cffcc9d7bf40d8171dad23da1ec64920fa1e096523c54fa940827842e035fa902ec9345750fd37a59b50a57b1c04c06db98406a0e48
-  data.tar.gz: 13317282009f99119e99bc912b780e7a308dcffbc550b979aaff9d90300e7588cc6783ffcfa975b405c22482821568c7306cf930f74b4c242b152651d59b0ba5
+  metadata.gz: e92238b97afd3cfd0da8e5ba8ae1d38eda1d7057fd5c06fdcbef29a3f7605a290e3ac00f364e8500b3acd65131e8605764e3b0cdafdf97a1aa48e02a46c40206
+  data.tar.gz: e18fde3d4b605aebe7520b1349ebefd33b23ff27d8a005dc15f1ac4ed62de4c3b1bccd389a524270aa32aa718f651b6bd1c3485110f974ef8f31958ff0501fac

data/CHANGELOG.md

@@ -1,6 +1,15 @@
 # Changelog
 
-## 1.0.2 - 2014-06-24
+## 1.0.5 - 2015-01-04
+- Documented options and added an example.
+
+## 1.0.4 - 2015-01-03
+- Added support for Octopress docs
+
+## 1.0.4 - 2014-06-29
+- Updated to latest octopress-code-highlighter.
+
+## 1.0.3 - 2014-06-28
 - Relaxed dependency versions.
 
 ## 1.0.2 - 2014-06-24

data/README.md

@@ -6,21 +6,70 @@ Write beautiful code snippets within any template.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+### Using Bundler
 
-    gem 'octopress-codeblock'
+Add this gem to your site's Gemfile in the `:jekyll_plugins` group:
 
-And then execute:
+    group :jekyll_plugins do
+      gem 'octopress-codeblock'
+    end
+
+Then install the gem with Bundler
 
     $ bundle
 
-Or install it yourself as:
+### Manual Installation
 
     $ gem install octopress-codeblock
 
+Then add the gem to your Jekyll configuration.
+
+    gems:
+      - octopress-codeblock
+
 ## Usage
 
-TODO: Write usage instructions here
+    {% codeblock [options] %}
+    [lines of code code]
+    {% endcodeblock %}
+
+### Options
+
+Note that order does not matter.
+
+| Options      | Example                | Description                                                           |
+|:-------------|:-----------------------|:----------------------------------------------------------------------|
+|`lang`        | `lang:ruby`                 | Used by the syntax highlighter. Passing 'plain' disables highlighting.|
+|`title`       | `title:"Figure 1.A"`   | Add a figcaption title to your code block. |
+|`link_text`   | `link_text:"Download"` | Text for the link, default: `"link"`. |
+|`linenos`     | `lineos:false`         | Disable line numbering. |
+|`start`       | `start:5`              | Start the line numbering at the given value. |
+|`mark`        | `mark:1-4,8`           | Highlight lines of code. This example marks lines 1,2,3,4 and 8 |
+|`class`       | `class:"css example"`  | Add CSS class names to the code `<figure>` element |
+
+
+### Example
+
+```
+{% codeblock lang:ruby title:"Check if a number is prime" mark:3 %}
+class Fixnum
+  def prime?
+    ('1' * self) !~ /^1?$|^(11+?)\1+$/
+  end
+end
+{% endcodeblock %}
+```
+
+Demo
+
+<!-- title:"Check if a number is prime" mark:3 -->
+```ruby
+class Fixnum
+  def prime?
+    ('1' * self) !~ /^1?$|^(11+?)\1+$/
+  end
+end
+```
 
 ## Contributing
 

data/lib/octopress-codeblock.rb

@@ -58,3 +58,14 @@ module Octopress
 end
 
 Liquid::Template.register_tag('codeblock', Octopress::Codeblock::Tag)
+
+if defined? Octopress::Docs
+  Octopress::Docs.add({
+    name:        "Octopress Codeblock",
+    gem:         "octopress-codeblock",
+    description: "A Liquid tag for writing beatuiful code snippets",
+    path:        File.expand_path(File.join(File.dirname(__FILE__), "../")),
+    source_url:  "https://github.com/octopress/codeblock",
+    version:     Octopress::Codeblock::VERSION
+  })
+end

data/lib/octopress-codeblock/version.rb

@@ -1,5 +1,5 @@
 module Octopress
   module Codeblock
-    VERSION = "1.0.4"
+    VERSION = "1.0.5"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: octopress-codeblock
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - Brandon Mathis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-29 00:00:00.000000000 Z
+date: 2015-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octopress-code-highlighter
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: clash
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -73,24 +73,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
 - lib/octopress-codeblock.rb
 - lib/octopress-codeblock/version.rb
-- octopress-codeblock.gemspec
-- test/.gitignore
-- test/Gemfile
-- test/_config.yml
-- test/_plugins/codeblock.rb
-- test/expected.html
-- test/index.html
-- test/test.rb
 homepage: https://github.com/octopress/codeblock
 licenses:
 - MIT

data/.gitignore

@@ -1,21 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-.DS_Store
-.pygments-cache
-_site
-.code-highlighter-cache

data/.rspec

@@ -1,2 +0,0 @@
---color
---format progress

data/.travis.yml

@@ -1,5 +0,0 @@
-language: ruby
-rvm:
-  - 2.0.0
-  - 1.9.3
-script: cd test && bundle exec ruby test.rb

data/Gemfile

@@ -1,4 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in octopress-codefence.gemspec
-gemspec

data/Rakefile

@@ -1,7 +0,0 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec
-task :test => :spec

data/octopress-codeblock.gemspec

@@ -1,24 +0,0 @@
-# -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'octopress-codeblock/version'
-
-Gem::Specification.new do |gem|
-  gem.name          = "octopress-codeblock"
-  gem.version       = Octopress::Codeblock::VERSION
-  gem.authors       = ["Brandon Mathis"]
-  gem.email         = ["brandon@imathis.com"]
-  gem.description   = %q{Write beautiful code snippets within any template.}
-  gem.summary       = %q{Write beautiful code snippets within any template.}
-  gem.homepage      = "https://github.com/octopress/codeblock"
-  gem.license       = "MIT"
-
-  gem.add_runtime_dependency 'octopress-code-highlighter', '~> 4.0'
-
-  gem.add_development_dependency 'jekyll'
-  gem.add_development_dependency 'rake'
-  gem.add_development_dependency 'rspec'
-
-  gem.files         = `git ls-files`.split($/)
-  gem.require_paths = ["lib"]
-end

data/test/.gitignore

@@ -1 +0,0 @@
-_site

data/test/Gemfile

@@ -1,5 +0,0 @@
-source 'https://rubygems.org'
-
-gem 'jekyll'
-gem 'jekyll-page-hooks'
-gem 'octopress-codeblock', :path => '../'

data/test/_config.yml

@@ -1,5 +0,0 @@
-name: Your New Jekyll Site
-markdown: redcarpet
-highlighter: pygments
-pygments_aliases:
-  abc: ruby

data/test/_plugins/codeblock.rb

@@ -1 +0,0 @@
-require 'octopress-codeblock'

data/test/expected.html

@@ -1,6 +0,0 @@
-<figure class='code-highlight-figure'><figcaption class='code-highlight-caption'><span class='code-highlight-caption-title'>some script.rb</span></figcaption><div class='code-highlight'><pre class='code-highlight-pre'><div data-line='1' class='code-highlight-row numbered'><div class='code-highlight-line'>puts</span> <span class="vi">@awesome</span> <span class="k">if</span> <span class="kp">true</span></div></div></pre></div></figure>
-
-<figure class='code-highlight-figure'><figcaption class='code-highlight-caption'><span class='code-highlight-caption-title'>Coffeescript Tricks</span></figcaption><div class='code-highlight'><pre class='code-highlight-pre'><div data-line='51' class='code-highlight-row numbered marked-line start-marked-line end-marked-line'><div class='code-highlight-line'># Given an alphabet:</span>
-</div></div><div data-line='52' class='code-highlight-row numbered'><div class='code-highlight-line'><span class="nv">alphabet = </span><span class="s">&#39;abcdefghijklmnopqrstuvwxyz&#39;</span>
-</div></div><div data-line='53' class='code-highlight-row numbered'><div class='code-highlight-line'> </div></div><div data-line='54' class='code-highlight-row numbered marked-line start-marked-line'><div class='code-highlight-line'><span class="c1"># Iterate over part of the alphabet:</span>
-</div></div><div data-line='55' class='code-highlight-row numbered marked-line end-marked-line'><div class='code-highlight-line'><span class="nx">console</span><span class="p">.</span><span class="nx">log</span> <span class="nx">letter</span> <span class="k">for</span> <span class="nx">letter</span> <span class="k">in</span> <span class="nx">alphabet</span><span class="p">[</span><span class="mi">4</span><span class="p">..</span><span class="mi">8</span><span class="p">]</span></div></div></pre></div></figure>

data/test/index.html

@@ -1,14 +0,0 @@
----
----
-
-{% codeblock some script.rb %}
-puts @awesome if true
-{% endcodeblock %}
-
-{% codeblock Coffeescript Tricks lang:coffeescript start:51 mark:51,54-55 %}
-# Given an alphabet:
-alphabet = 'abcdefghijklmnopqrstuvwxyz'
-
-# Iterate over part of the alphabet:
-console.log letter for letter in alphabet[4..8]
-{% endcodeblock %}

data/test/test.rb

@@ -1,3 +0,0 @@
-system('jekyll build')
-diff = `diff _site/index.html expected.html`
-abort "Filed with diff: #{diff}" if diff.size > 0