octopress-render-code 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4a2cce1d5ad9923f037c06ecef99302289ec00c6
-  data.tar.gz: 4613024760176101dbecce7b667506b01079bdca
+  metadata.gz: c6de4c8e2a679a77fd83ef479d359ee22acb0d0e
+  data.tar.gz: ed98d7a3f464cab57646c4dc48e62bc7e02549f8
 SHA512:
-  metadata.gz: c9563775cfe8a3d3755529186387b0ecb2261d61cf5ea673c7eff3a142bf47f3091abbdcea4078abfeb7b47ee4663041a684473dae61477d2470888b0ccd0768
-  data.tar.gz: 61067cf15889b6e0c07b753c7c453c8587545c712081bfa573b158e31abe887c8fc199a54d23e32713bebf54c410ed1e67f1c21777f1e005fe78a77b8d4b4b43
+  metadata.gz: 11cc8edaa2f56562b9d87cbd689a29b24f02251606a8d60d5fe7221df4d610dc133697087d3dfaf841d07b1ea8ebaf2760fa4ff778239a074554275cfb80bafe
+  data.tar.gz: 4c2337ce38d41c0850aec7e2d4a4b55ab69df6f6bd653ae8b84be294db6ca1fbc55077b1733d2ceb3fcae6b2b45a019f6a48fe10d5d6756d1ce42d9aeb0d1884

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 # Changelog
 
-## 1.0.2 - 2014-06-25
+## 1.0.4 - 2015-01-05
+
+- Added usage documentation to the Readme.
+- Now supporting Octopress docs.
+
+## 1.0.3 - 2014-06-25
 - Updated to the latest octopress-code-highlighter.
 
 ## 1.0.2 - 2014-06-25

data/README.md

@@ -1,26 +1,77 @@
 # Octopress Render Code
 
-Write beautiful code snippets within any template.
+Embed code snippets from the file system in your Jekyll site.
 
 [![Build Status](https://travis-ci.org/octopress/render-code.png?branch=master)](https://travis-ci.org/octopress/render-code)
+[![Gem Version](https://badge.fury.io/rb/octopress-render-code.png)](http://badge.fury.io/rb/octopress-render-code)
 
 ## Installation
 
-Add this line to your application's Gemfile:
+### Using Bundler
 
-    gem 'octopress-render-code'
+Add this gem to your site's Gemfile in the `:jekyll_plugins` group:
 
-And then execute:
+    group :jekyll_plugins do
+      gem 'octopress-render-code'
+    end
+
+Then install the gem with Bundler
 
     $ bundle
 
-Or install it yourself as:
+### Manual Installation
 
     $ gem install octopress-render-code
 
+Then add the gem to your Jekyll configuration.
+
+    gems:
+      -octopress-render-code
+
 ## Usage
 
-TODO: Write usage instructions here
+    {% render_code <FILE> [options] %}
+
+### Configuration
+
+In your site's configuration, you can set the directory for embedded code samples.
+
+<!-- title:"In _config.yml" -->
+```
+code_dir: code-examples
+```
+
+The default directory is 'downloads/code'
+
+### Options
+
+Note that order does not matter.
+
+| Options      | Example                | Description                                                           |
+|:-------------|:-----------------------|:----------------------------------------------------------------------|
+|`lang`        | `lang:ruby`            | Defaults to guessing from file name extension. |
+|`title`       | `title:"Figure 1.A"`   | Add a figcaption title to your code block. |
+|`link_text`   | `link_text:"Download"` | Text for the link, default: `"Raw code"`. |
+|`linenos`     | `lineos:false`         | Disable line numbering. |
+|`start`       | `start:5`              | Start embedding the script from the 5th line number. |
+|`end`         | `end:15`               | Stop embedding the script after 15th line number. |
+|`range`       | `range:5-15`           | Embed lines 5-15 of the script. |
+|`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. |
+
+### Example
+
+Given the existence of a file 
+
+```
+{% render figure-1-a.js title:"Figure A: A Simple AJAX Request." mark:5-8
+```
+
+This will
+
+- Embed and highlight a file at `[site_source]/downloads/code/figure-1-a.js`
+- Give it a figcaption "Figure A: A Simple AJAX Request
+- Visually mark lines 5,6,7, and 8.
 
 ## Contributing
 

data/lib/octopress-render-code.rb

@@ -95,3 +95,17 @@ end
 
 Liquid::Template.register_tag('render_code', Octopress::RenderCode::Tag)
 Liquid::Template.register_tag('include_code', Octopress::RenderCode::Tag)
+
+
+if defined? Octopress::Docs
+  Octopress::Docs.add({
+    name:        "Octopress Render Code",
+    gem:         "octopress-render-code",
+    description: "Embed code snippets from the file system.",
+    path:        File.expand_path(File.join(File.dirname(__FILE__), "../")),
+    type:        "tag",
+    source_url:  "https://github.com/octopress/render-code",
+    version:     Octopress::RenderCode::VERSION
+  })
+end
+

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

@@ -1,5 +1,5 @@
 module Octopress
   module RenderCode
-    VERSION = "1.0.3"
+    VERSION = "1.0.4"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: octopress-render-code
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 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: clash
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -73,25 +73,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
 - lib/octopress-render-code.rb
 - lib/octopress-render-code/version.rb
-- octopress-render-code.gemspec
-- test/.gitignore
-- test/Gemfile
-- test/_config.yml
-- test/_plugins/render-code.rb
-- test/downloads/code/tricks.coffee
-- test/expected.html
-- test/index.md
-- test/test.rb
 homepage: https://github.com/octopress/render-code
 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-render-code.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-render-code/version'
-
-Gem::Specification.new do |gem|
-  gem.name          = "octopress-render-code"
-  gem.version       = Octopress::RenderCode::VERSION
-  gem.authors       = ["Brandon Mathis"]
-  gem.email         = ["brandon@imathis.com"]
-  gem.description   = %q{Embed highlighted code snippets from a file.}
-  gem.summary       = %q{Embed highlighted code snippets from a file.}
-  gem.homepage      = "https://github.com/octopress/render-code"
-  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.files         = `git ls-files`.split($/)
-  gem.require_paths = ["lib"]
-end

data/test/.gitignore

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

data/test/Gemfile

@@ -1,7 +0,0 @@
-source 'https://rubygems.org'
-
-gem 'pry-debugger'
-gem 'jekyll'
-gem 'jekyll-page-hooks'
-gem 'octopress-code-highlighter', :path => '../../code-highlighter'
-gem 'octopress-render-code', :path => '../'

data/test/_config.yml

@@ -1,9 +0,0 @@
-name: Your New Jekyll Site
-markdown: redcarpet
-highlighter: pygments
-exclude:
-  - Gemfile*
-  - expected.html
-  - test.rb
-pygments_aliases:
-  abc: ruby

data/test/_plugins/render-code.rb

@@ -1 +0,0 @@
-require 'octopress-render-code'

data/test/downloads/code/tricks.coffee

@@ -1,5 +0,0 @@
-# Given an alphabet:
-alphabet = 'abcdefghijklmnopqrstuvwxyz'
-
-# Iterate over part of the alphabet:
-console.log letter for letter in alphabet[4..8]

data/test/expected.html

@@ -1,12 +0,0 @@
-<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='1' class='code-highlight-row numbered marked-line start-marked-line'><div class='code-highlight-line'># Given an alphabet:</span>
-</div></div><div data-line='2' class='code-highlight-row numbered marked-line end-marked-line'><div class='code-highlight-line'><span class="nv">alphabet = </span><span class="s">&#39;abcdefghijklmnopqrstuvwxyz&#39;</span>
-</div></div><div data-line='3' class='code-highlight-row numbered'><div class='code-highlight-line'> </div></div><div data-line='4' class='code-highlight-row numbered'><div class='code-highlight-line'><span class="c1"># Iterate over part of the alphabet:</span>
-</div></div><div data-line='5' class='code-highlight-row numbered'><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>
-
-<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='1' class='code-highlight-row numbered'><div class='code-highlight-line'># Given an alphabet:</span>
-</div></div><div data-line='2' 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='3' class='code-highlight-row numbered'><div class='code-highlight-line'> </div></div><div data-line='4' class='code-highlight-row numbered'><div class='code-highlight-line'><span class="c1"># Iterate over part of the alphabet:</span>
-</div></div><div data-line='5' class='code-highlight-row numbered'><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>
-
-<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='2' class='code-highlight-row numbered'><div class='code-highlight-line'>alphabet = </span><span class="s">&#39;abcdefghijklmnopqrstuvwxyz&#39;</span>
-</div></div><div data-line='3' class='code-highlight-row numbered'><div class='code-highlight-line'> </div></div><div data-line='4' class='code-highlight-row numbered'><div class='code-highlight-line'><span class="c1"># Iterate over part of the alphabet:</span></div></div></pre></div></figure>

data/test/index.md

@@ -1,6 +0,0 @@
----
----
-
-{% render_code Coffeescript Tricks tricks.coffee mark:1,2 %}
-{% render_code tricks.coffee Coffeescript Tricks link_text:"Download"%}
-{% render_code tricks.coffee Coffeescript Tricks range:2-4 %}

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