jekyll-footnotes 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5fdc7cd1b6a8b6e71b9b518f85c6ebaeb259177a
+  data.tar.gz: d3192fca39810fc83e48b574a6372e79d116e8e0
+SHA512:
+  metadata.gz: e7c06341cca9d2253b06753dc75e2481c3b9213606fb21318be3b5b0b1eccbb3ddf92c7ec4fa6daa66b089887caebf264c37398f8eb49be395da5d839b9aa502
+  data.tar.gz: bf6b51f0f1ce872c5dc5f50777495e4dd3505e3376c64866b03139255f1ff8eee45ad0318eb7b49e65bc7cbcc1c15b386000cb164188a5dece4c856e7caec899

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+Gemfile.lock

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Julian Simioni
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,69 @@
+"Footnotes" is a [Jekyll](http://jekyllrb.com/) plugin that helps inserts
+footnote reference and body HTML, with automatic numbering, if desired.
+
+All footnotes will include a superscript link to the footnotes body. The
+footnote body will include a link back to the footnote (using the ⏎ icon ) for
+easy reading.
+
+## Install
+
+* Include "jekyll-footnotes" in your Gemfile, or install the gem
+* Add "jekyll-footnotes to the plugins section of \_config.yml
+
+## Automatic numbering
+    hello{% fn %} world{% fn %}
+    {% footnotes %}
+       {% fnbody %}
+          <p>salut</p>
+       {% endfnbody %}
+       {% fnbody %}
+          <em>monde</em>
+       {% endfnbody %}
+    {% endfootnotes %}
+
+## Custom numbering:
+    hello{% fn 3 %} world{% fn 5 %}
+    {% footnotes %}
+       {% fnbody 3 %}
+          <p>salut</p>
+       {% endfnbody %}
+       {% fnbody 5 %}
+          <em>monde</em>
+       {% endfnbody %}
+    {% endfootnotes %}
+
+## CSS Styling
+The following CSS selectors allow the footnotes, footnote bodies, and backlinks
+to be customised using CSS
+
+```CSS
+.footnote {
+  /* a single footnote link */
+}
+.footnotelist {
+  /* entire footnote section */
+}
+
+.footnotelist .footnotebody {
+  /* a single footnote body  */
+}
+
+.footnotelist .backlink {
+  /* backlink to the footnote link */
+}
+```
+
+## Notes
+
+Do not mix custom and automatic numbering (although it will work if you only
+use custom numbers above the highest automatic one).
+
+Only numeric IDs are allowed currently.
+
+**We generate valid HTML5**
+
+
+© Ben Eills, 2013
+© Julian Simioni, 2015
+
+Released under the MIT License

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/jekyll-footnotes.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jekyll/footnotes/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll-footnotes"
+  spec.version       = Jekyll::Footnotes::VERSION
+  spec.authors       = ["Julian Simioni"]
+  spec.email         = ["julian@simioni.org"]
+  spec.summary       = %q{A Jekyll plugin for footnotes}
+  spec.description   = %q{A Jekyll plugin that allows you to easily add
+  footnotes to your pages. Includes links to the footnote body, backlinks, and
+  classes for styling.}
+  spec.homepage      = "https://github.com/orangejulius/jekyll-footnotes"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.4"
+end

data/lib/jekyll/footnotes.rb

@@ -0,0 +1,53 @@
+require "jekyll/footnotes/version"
+
+module Jekyll
+  class FootnoteTag < Liquid::Tag
+    def initialize(tag_name, id, tokens)
+      raise(SyntaxError.new("invalid footnote ID")) if ['"', '<', '>'].any? { |c| id.include?(c) }
+      @id = id.strip unless id.strip.empty?
+      super
+    end
+
+    def render(context)
+      if @id.nil?
+        context.registers[:fn] ||= 0
+        context.registers[:fn] = context.registers[:fn].next
+        @id = context.registers[:fn]
+      end
+      "<sup><a href=\"#fn:#{@id}\" class=\"footnote\" rel=\"footnote\" id=\"fn-back:#{@id}\">#{@id}</a></sup>"
+    end
+  end
+
+  class FootnoteBody < Liquid::Block
+    def initialize(tag_name, id, tokens)
+      raise(SyntaxError.new("invalid footnote ID")) if ['"', '<', '>'].any? { |c| id.include?(c) }
+      @id = id.strip unless id.strip.empty?
+      super
+    end
+
+    def render(context)
+      if @id.nil?
+        context.registers[:fnbody] ||= 0
+        context.registers[:fnbody] = context.registers[:fnbody].next
+        @id = context.registers[:fnbody]
+      end
+      context.stack do
+        body = super
+        "<li id=\"fn:#{@id}\" class=\"footnotebody\"value=\"#{@id}\">#{body}<a href=\"#fn-back:#{@id}\" class=\"backlink\">⏎</a></li>"
+      end
+    end
+  end
+
+  class FootnoteList < Liquid::Block
+    def render(context)
+      context.stack do
+        body = super
+        "<ol class=\"footnotelist\">#{body}</ol>"
+      end
+    end
+  end
+
+  Liquid::Template.register_tag('fn', Jekyll::FootnoteTag)
+  Liquid::Template.register_tag('footnotes', FootnoteList)
+  Liquid::Template.register_tag('fnbody', FootnoteBody)
+end

data/lib/jekyll/footnotes/version.rb

@@ -0,0 +1,5 @@
+module Jekyll
+  module Footnotes
+    VERSION = "0.5.0"
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-footnotes
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- Julian Simioni
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+description: |-
+  A Jekyll plugin that allows you to easily add
+    footnotes to your pages. Includes links to the footnote body, backlinks, and
+    classes for styling.
+email:
+- julian@simioni.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- jekyll-footnotes.gemspec
+- lib/jekyll/footnotes.rb
+- lib/jekyll/footnotes/version.rb
+homepage: https://github.com/orangejulius/jekyll-footnotes
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: A Jekyll plugin for footnotes
+test_files: []