jekyll_pilcrow_converter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 15b183df1086148e0bbc61df7d2025c63a5815fc
+  data.tar.gz: f0f9c75cb00993fe717d34a146459a119d02d861
+SHA512:
+  metadata.gz: e96830cdddef84d8277e4e6bbb6d64477dfc2c772b97d3dd8155bc1f86dd7dee456f22a4b89ee7f338538c722abd8ff3b60abc43375e9c8418b0a9cb4b2e7dca
+  data.tar.gz: '09054819b65bfb6a4206ae4a12ca7a7891fae8e08323a48040b2919ead7cb2f019abb8dfd9e23f545cd39546a4f14644fda5ffebd6fbf8bda5991394c1e21b57'

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2017 Jonathan Hooper
+
+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,28 @@
+This is a converter for Jekyll sites that adds a pilcrow anchor link to the beginning of the paragraphs.
+
+With this converter, this markdown
+
+```markdown
+
+This is a paragraph!
+
+```
+
+...generates this HTML...
+
+```html
+<p id='123abc'>
+  <a href='#123abc' class='pilcrow'>¶ </a>
+  This is a paragraph!
+</p>
+```
+
+To add this to your Jekyll, just add this to your Gemfile and you're set:
+
+```ruby
+group :jekyll_plugins do
+  gem 'jekyll_pilcrow_converter'
+end
+```
+
+You can build the example site in this repo to see the plugin in action.

data/lib/jekyll_pilcrow_converter.rb

@@ -0,0 +1,87 @@
+require 'base64'
+require 'digest'
+
+module Jekyll
+  class PilcrowConverter < Converter
+    safe true
+    priority :low
+
+    def matches(ext)
+      ext == '.md'
+    end
+
+    def output_ext(_ext)
+      '.html'
+    end
+
+    def convert(content)
+      document = Kramdown::Document.new(content)
+      document.root = add_pilcrows(document.root)
+      document.to_html
+    end
+
+    protected
+
+    def add_pilcrows(element)
+      element.children = element.children.inject([]) do |children, child_element|
+        if paragraph_element?(child_element)
+          paragraph = add_pilcrow_to_paragraph(child_element)
+          children + [paragraph]
+        elsif !child_element.children.empty?
+          children + [add_pilcrows(child_element)]
+        else
+          children + [child_element]
+        end
+      end
+      element
+    end
+
+    def paragraph_element?(element)
+      return false if element.children.empty?
+      return false unless element.type == :html_element && element.value == 'p'
+
+      first_child = element.children.first
+
+      return true if first_child.type == :text
+      return true if first_child.type == :html_element && first_child.value == 'a'
+      false
+    end
+
+    def add_pilcrow_to_paragraph(paragraph)
+      id = generate_paragraph_id(paragraph)
+      pilcrow = build_pilcrow_element(id)
+      paragraph.attr[:id] = id
+      paragraph.children = [pilcrow] + paragraph.children
+      paragraph
+    end
+
+    def build_pilcrow_element(id)
+      link = Kramdown::Element.new(
+        :html_element,
+        'a',
+        href: "##{id}",
+        class: 'pilcrow'
+      )
+      text = Kramdown::Element.new(:text, '¶ ')
+      link.children = [text]
+      link
+    end
+
+    def generate_paragraph_id(paragraph)
+      text = get_element_text(paragraph)
+      Base64.urlsafe_encode64(Digest::MD5.new.digest(text))
+    end
+
+    def get_element_text(element)
+      element.children.map do |child_element|
+        if child_element.type == :text
+          child_element.value
+        elsif !child_element.children.empty?
+          get_element_text(child_element)
+        else
+          ''
+        end
+      end.join('')
+    end
+  end
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: jekyll_pilcrow_converter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jonathan Hooper
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |2
+      This gem is a Jekyll plugin that adds an anchor link to the
+      beginning of paragraphs in a rendered site.
+email: jon@jonathanhooper.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/jekyll_pilcrow_converter.rb
+homepage: https://github.com/jmhooper/jekyll_pilcrow_converter
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/jmhooper/jekyll_pilcrow_converter
+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.6.13
+signing_key: 
+specification_version: 4
+summary: Add pilcrow links to paragraphs
+test_files: []