octopress-codefence 1.4.5 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 84ab098c4bfba9bc82e0bdc02c408d2350ae9711
-  data.tar.gz: e2fc79f3d55123928bd62a7ee16f71e2bce429be
+  metadata.gz: a0ba8ecc86de09e4e10e8d4a9c6a64afb0fe57d2
+  data.tar.gz: e43a0b12467ba1110b74556b52f0ce00cb7a524a
 SHA512:
-  metadata.gz: cb66c4cab358b692179b2363652a1f1c5548a35c47946ea8b3b0b1ae7fba9910e8ee16bc029d0edef8ee3a7c9e8d363bd94c9c381a124f707ac2ea70e044bc9f
-  data.tar.gz: 23f80f28938129b9d0ce07752b0378b75777fc5e597e301418ddab395f32e8e094bff10dc5db4f13e4e18016c19b313c46c9147521c73c5bd7ce9cfc6e735538
+  metadata.gz: 3bc3ed627cdac2ae68259777c04adb3cdca7694098c4682a148e38158381e4f195b68c2a96a374e0f401ba676884021053070cfa7557bfcb8ac0ca3c1ff7264b
+  data.tar.gz: cb5d5ab9ebd36b1d78aa71c8a8d9c2c74d4ec1fac5b41e17b65770f11bfe9a1842ce66e3af48cd3535a366bce40027518cdd4fa6ac54a5f7fa106014a7fc5eb8

data/.travis.yml

@@ -2,4 +2,4 @@ language: ruby
 rvm:
   - 2.0.0
   - 1.9.3
-script: cd test && bundle exec clash
+script: bundle exec clash test

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.5.0 - 2015-01-03
+- Now html comments can be used for setting code options.
+- Added usage documentation.
+
 ## 1.4.5 - 2014-12-19
 - Fix to readme
 - Integrated octopress-docs support

data/README.md

@@ -7,33 +7,56 @@ Write beautiful fenced code snippets within any template.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+### Using Bundler
 
-    gem 'octopress-codefence'
+Add this line to your application's Gemfile (optionally in the `:jekyll_plugins` group:
 
-And then execute:
+```ruby
+group :jekyll_plugins do
+  gem 'octopress-codefence'
+end
+```
+
+Then install the gem with Bundler
 
     $ bundle
 
-Or install it yourself as:
+### Manual Installation
 
     $ gem install octopress-codefence
 
-## Usage
-
-First, add the gem to your Jekyll configuration.
+Then add the gem to your Jekyll configuration.
 
 ```yaml
 gems:
   - octopress-codefence
 ```
 
-Next, add the Octopress stlyesheets tag to your site layout this will inject stylesheet tags for all Octopress Ink plugins.
+## Usage
 
-```html
-<!--Somewhere in your site's head-->
-{% css_asset_tag %}
-```
+The Octopress codefence has some
+
+### Syntax
+
+   ```lang [options]
+   [code]
+   ```
+
+### Options
+
+Note that order does not matter.
+
+| Options      | Example                | Description                                                           |
+|:-------------|:-----------------------|:----------------------------------------------------------------------|
+|`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 |
+
+### Examples
 
 Finally, give it a try. Here's an code snippet sample.
 
@@ -63,7 +86,35 @@ Finally, give it a try. Here's an code snippet sample.
     end
     ```
 
-Here's a sample:
+Which renders like this:
+
+<!-- mark:2-4 title:"Testing codefence" url:"https://github.com/octopress/codefence" link_text:"plugin link" -->
+```ruby
+class Float
+  def number_decimal_places
+    self.to_s.length-2
+  end
+  
+  def to_fraction
+    higher = 10**self.number_decimal_places
+    lower = self*higher
+
+    gcden = greatest_common_divisor(higher, lower)
+
+    return (lower/gcden).round, (higher/gcden).round
+  end
+  
+private
+
+  def greatest_common_divisor(a, b)
+     while a%b != 0
+       a,b = b.round,(a%b).round
+     end 
+     return b
+  end
+end
+```
+Here's a themed sample:
 
 <img src="http://cl.ly/TFCm/content.png" alt='sample screenshot of the code snippet above renderd with the light theme' width="816px">
 

data/lib/octopress-codefence.rb

@@ -28,6 +28,7 @@ module Octopress
       
       def render
         @input.encode!("UTF-8")
+        @input = sub_option_comment(@input)
         @input.gsub /^`{3}(.+?)`{3}/m do
           str = $1.to_s
           str.gsub /([^\n]+)?\n(.+?)\Z/m do
@@ -43,6 +44,25 @@ module Octopress
         end
       end
 
+      # Allow html comments to set rendering options
+      #
+      #  Example:
+      #   <!-- title:"Example 1" -->
+      #   ```ruby
+      #
+      #  This becomes:
+      #
+      #   ```ruby title:"Example 1"
+      #
+      # This allows Readme files to be rendered by GitHub and other markdown codefences
+      # But when processed by Octopress Codefence, the code examples are rendered with options
+      #
+      def sub_option_comment(input)
+        input.gsub /<!--(.+?)-->\n`{3}([^\n]+)/ do
+          "```#{$2} #{$1}"
+        end
+      end
+
       def get_options(markup)
         defaults = { escape: true }
         clean_markup = CodeHighlighter.clean_markup(markup)

data/lib/octopress-codefence/version.rb

@@ -1,5 +1,5 @@
 module Octopress
   module Codefence
-    VERSION = "1.4.5"
+    VERSION = "1.5.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: octopress-codefence
 version: !ruby/object:Gem::Version
-  version: 1.4.5
+  version: 1.5.0
 platform: ruby
 authors:
 - Brandon Mathis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-19 00:00:00.000000000 Z
+date: 2015-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octopress-code-highlighter