octopress-gist 1.3.4 → 1.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b45fbdfed06e7ec8bf438de70b7589534199b691
-  data.tar.gz: 9a2f52f357df7d53644cd9ba4fa3b1a9c0e6ef88
+  metadata.gz: 54829e7439f27aefd54486650424a91cc45ff853
+  data.tar.gz: 07229a17b65b4dad7d1d64ec14334efecb90ca0b
 SHA512:
-  metadata.gz: 4822cf79b915750624c1b7014e58eed99643bb68154f8f0a20f7c13ec1986ed57387e0a1b157e90953297f90371fc6ca295894554b31cddeae046d232e9809b9
-  data.tar.gz: 33698c26b03014bad87cf979929ceea3fd33195e765b0f405491d23b1d69ce3291143d57d1bf1fb74054c75b05ec5c96c0178e22721f33b820c9b04a57aa0e4a
+  metadata.gz: f41aacc1afeba7492df6522736bd34c743285ebfc59dd58bcd1e67b282e103caf786d07eca7a5510d9683ab631c473bbf8dda778fcccecbd7c98705b79c40ff7
+  data.tar.gz: 2e1a6c97e816009c107bc46817974fc78e55ff5df651cb8ea6263700d22a862e72a69c8a5d614bab4ae0e6dadfaadd967dcff7312dfc3938e7b1dd74b04149f8

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.3.5 - 2015-01-05
+
+- Updated tests; now using Clash.
+- Improved example documentation.
+- Added support for Octopress docs.
+
 ## 1.3.4 - 2014-06-29
 - Loosened dependency versions.
 

data/README.md

@@ -3,25 +3,30 @@
 Embed GitHub Gists in your Jekyll or Octopress blog.
 
 [![Build Status](https://travis-ci.org/octopress/gist.png?branch=master)](https://travis-ci.org/octopress/gist)
+[![Gem Version](https://badge.fury.io/rb/octopress-gist.png)](https://badge.fury.io/rb/octopress-gist)
 
 ## Installation
 
-Add this line to your application's Gemfile
+### Using Bundler
 
-```ruby
-gem 'octopress-gist'
-```
+Add this gem to your site's Gemfile in the `:jekyll_plugins` group:
+
+    group :jekyll_plugins do
+      gem 'octopress-gist'
+    end
 
-And then execute:
+Then install the gem with Bundler
 
     $ bundle
 
-Next add the gem to your Jekyll's `gems` configuration.
+### Manual Installation
 
-```yaml
-gems:
-  - octopress-gist
-```
+    $ gem install octopress-gist
+
+Then add the gem to your Jekyll configuration.
+
+    gems:
+      -octopress-gist
 
 ## Usage
 
@@ -31,27 +36,45 @@ The gist syntax looks like this.
 {% gist [gist_id] [file_name] [options] %}
 ```
 
+### Options
+
+Note that order does not matter.
+
+| Options      | Example                | Description                                                           |
+|:-------------|:-----------------------|:----------------------------------------------------------------------|
+|`title`       | `title:"Figure 1.A"`   | Add a figcaption title. Defaults to Gist title (usually the filename). |
+|`link_text`   | `link_text:"Download"` | Text for the link to the gist, default: `"link"`. |
+|`linenos`     | `lineos:false`         | Disable line numbering. |
+|`start`       | `start:5`              | Start embedding the gist from the 5th line number. |
+|`end`         | `end:15`               | Stop embedding the gist after 15th line number. |
+|`range`       | `range:5-15`           | Embed lines 5-15 of the gist. |
+|`mark`        | `mark:5-7,10`          | Highlight lines of code. This example marks lines 5,6,7 and 10. |
+|`class`       | `class:"solution"`     | Add CSS class name(s) to the code `<figure>` element. |
+
 A simple gist embed:
 
 ```
 {% gist 5672127 %}
 ```
 
-This will download the gist and render it with Octopress Pygments, caching both the raw gist, and the highlighted code. 
+This will download the gist and render it with Octopress Pygments, caching both the raw gist, and the highlighted code. If your Gist has multiple files, this will embed each file in its own code figure.
 
-If your Gist has multile files, this will embed each file in it's own code figure.
+Here's a more complex example:
 
+```
+{% gist 5672127 title:"Some cool thing" range:5-10 %}
+```
 
 #### Embed single files in a gist
 
-If your Gist has multile files but you wish to embed files individually, you can like this.
+If your Gist has multiple files but you wish to embed files individually, you can like this.
 
 ```
 {% gist 13411532 some_gist_file_name.rb %}
 
 Comments about this file
 
-{% gist 13411532 some_gist_file_name2.rb %}
+{% gist 13411532 some_other_gist_file_name.rb %}
 
 and so on...
 ```

data/lib/octopress-gist.rb

@@ -2,9 +2,7 @@ require 'liquid'
 require 'octopress-code-highlighter'
 require 'open-uri'
 require 'json'
-
-$:.unshift File.dirname(__FILE__)
-$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'octopress-gist/version'
 
 module Octopress
   module Gist
@@ -17,3 +15,14 @@ end
 Liquid::Template.register_tag('gist', Octopress::Gist::Tag)
 Liquid::Template.register_tag('gistnocache', Octopress::Gist::NoCacheTag)
 
+if defined? Octopress::Docs
+  Octopress::Docs.add({
+    name:        "Octopress Gist",
+    gem:         "octopress-gist",
+    description: "Embed GitHub Gists in your Jekyll or Octopress blog.",
+    path:        File.expand_path(File.join(File.dirname(__FILE__), "../")),
+    source_url:  "https://github.com/octopress/gist",
+    version:     Octopress::Gist::VERSION
+  })
+end
+

data/lib/octopress-gist/version.rb

@@ -1,5 +1,5 @@
 module Octopress
   module Gist
-    VERSION = "1.3.4"
+    VERSION = "1.3.5"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: octopress-gist
 version: !ruby/object:Gem::Version
-  version: 1.3.4
+  version: 1.3.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
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: RedCloth
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: RedCloth
+  name: clash
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -87,20 +87,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
 - lib/octopress-gist.rb
 - lib/octopress-gist/cache.rb
 - lib/octopress-gist/gist-no-cache.rb
 - lib/octopress-gist/gist.rb
 - lib/octopress-gist/version.rb
-- octopress-gist.gemspec
 homepage: https://github.com/octopress/gist
 licenses:
 - MIT

data/.gitignore

@@ -1,24 +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
-.gist-cache
-.code-highlighter-cache
-.sass-cache
-site

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,5 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in jekyll-minify-html.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-gist.gemspec

@@ -1,25 +0,0 @@
-# -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'octopress-gist/version'
-
-Gem::Specification.new do |gem|
-  gem.name          = "octopress-gist"
-  gem.version       = Octopress::Gist::VERSION
-  gem.authors       = ["Brandon Mathis"]
-  gem.email         = ["brandon@imathis.com"]
-  gem.description   = %q{Embed GitHub gists, support caching, and multiple files per gist.}
-  gem.summary       = %q{Embed GitHub gists, support caching, and multiple files per gist.}
-  gem.homepage      = "https://github.com/octopress/gist"
-  gem.license       = "MIT"
-
-  gem.add_runtime_dependency 'octopress-code-highlighter', '~> 4.2'
-
-  gem.add_development_dependency 'jekyll'
-  gem.add_development_dependency 'rake'
-  gem.add_development_dependency 'rspec'
-  gem.add_development_dependency 'RedCloth'
-
-  gem.files         = `git ls-files`.split($/).reject {|f| f =~ /^test\// }
-  gem.require_paths = ["lib"]
-end