jekyll-commonmark-ghpages 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c780cb17633fa27a1f3886464808fd5e86fae540
+  data.tar.gz: 9a1e6f8304237daeb268971d26be53eee813ab8c
+SHA512:
+  metadata.gz: 4929460a719c3245cb06cd51e688e534782f4d2c103e00a10e8c590cb3bfa4eca0c82b9968531869e6d9224434dec75a03468c51a2d32a4e1cd36ba7a01163b4
+  data.tar.gz: b3fdf15208da60ad54a024905fd75b1a2726f624e7126add1cce14fdff499b417dc7b3a9e880a9b5dabcd3af3652bf611e52c02267acf0f51f7b512d23a35a0d

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+Gemfile.lock
+spec/dest
+.bundle

data/.travis.yml

@@ -0,0 +1,24 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.4
+  - 2.3
+  - 2.2
+  - 2.1
+git:
+  depth: 1
+
+sudo: false
+
+addons:
+  apt:
+    sources:
+      - kalakris-cmake
+    packages:
+      - cmake
+
+before_install:
+  - gem install bundler
+
+before_script: bundle update
+script: script/cibuild

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 GitHub
+
+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,35 @@
+# jekyll-commonmark-ghpages
+
+*GitHub Flavored Markdown converter for Jekyll, based on [`jekyll-commonmark`](https://github.com/jekyll/jekyll-commonmark)*
+
+[![Gem Version](https://img.shields.io/gem/v/jekyll-commonmark-ghpages.svg)](https://rubygems.org/gems/jekyll-commonmark-ghpages)
+[![Build Status](https://img.shields.io/travis/github/jekyll-commonmark-ghpages/master.svg)](https://travis-ci.org/github/jekyll-commonmark-ghpages)
+[![Windows Build status](https://img.shields.io/appveyor/ci/github/jekyll-commonmark-ghpages/master.svg?label=Windows%20build)](https://ci.appveyor.com/project/github/jekyll-commonmark-ghpages)
+
+Jekyll Markdown converter that uses [libcmark-gfm](https://github.com/github/cmark), GitHub's fork of [cmark](https://github.com/commonmark/cmark), the reference parser for CommonMark, with some additions to ensure compatibility with existing Kramdown-based sites.
+
+## Installation
+
+Add the following to your `Gemfile`:
+
+```ruby
+group :jekyll_plugins do
+  gem 'jekyll-commonmark-ghpages'
+end
+```
+
+and modify your `_config.yml` to use **CommonMarkGhPages** as your Markdown converter:
+
+```yaml
+markdown: CommonMarkGhPages
+```
+
+This processor is currently in testing for use in GitHub Pages.
+
+To specify extensions and options for use in converting Markdown to HTML, supply options to the Markdown converter:
+
+```yaml
+commonmark:
+  options: ["SMART", "FOOTNOTES"]
+  extensions: ["strikethrough", "autolink", "tables"]
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/appveyor.yml

@@ -0,0 +1,24 @@
+version: "{build}"
+clone_depth: 5
+build: off
+
+install:
+  - SET PATH=C:\Ruby%RUBY_FOLDER_VER%\bin;%PATH%
+  - bundle install --retry 5 --jobs=%NUMBER_OF_PROCESSORS% --clean --path vendor\bundle
+
+environment:
+  matrix:
+    - RUBY_FOLDER_VER: "24"
+    - RUBY_FOLDER_VER: "24-x64"
+    - RUBY_FOLDER_VER: "23"
+    - RUBY_FOLDER_VER: "22"
+    - RUBY_FOLDER_VER: "21"
+
+test_script:
+  - ruby --version
+  - gem --version
+  - bundler --version
+  - bash script/cibuild
+
+cache:
+  - 'vendor\bundle -> appveyor.yml,Gemfile,jekyll-commonmark-ghpages.gemspec'

data/jekyll-commonmark-ghpages.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll-commonmark-ghpages"
+  spec.summary       = "CommonMark generator for Jekyll"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Ashe Connor"]
+  spec.email         = "kivikakk@github.com"
+  spec.homepage      = "https://github.com/github/jekyll-commonmark-ghpages"
+  spec.licenses      = ["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_runtime_dependency "jekyll-commonmark", "~> 1"
+  spec.add_runtime_dependency "commonmarker", "~> 0.17.6"
+
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "bundler", "~> 1.6"
+end

data/lib/jekyll-commonmark-ghpages.rb

@@ -0,0 +1,64 @@
+# frozen-string-literal: true
+# encoding: utf-8
+
+require "commonmarker"
+require "jekyll"
+require "jekyll-commonmark"
+
+# A customized version of CommonMarker::HtmlRenderer which outputs
+# Kramdown-style header IDs.
+class JekyllCommonMarkCustomRenderer < ::CommonMarker::HtmlRenderer
+  def header(node)
+    block do
+      old_stream = @stream
+      @stream = StringIO.new(String.new.force_encoding("utf-8"))
+      out(:children)
+      content = @stream.string
+      @stream = old_stream
+
+      id = generate_id(content)
+      out("<h", node.header_level, "#{sourcepos(node)} id=\"#{id}\">",
+          content, "</h", node.header_level, ">")
+    end
+  end
+
+  private
+
+  def generate_id(str)
+    gen_id = basic_generate_id(str)
+    gen_id = "section" if gen_id.empty?
+    @used_ids ||= {}
+    if @used_ids.key?(gen_id)
+      gen_id += "-" << (@used_ids[gen_id] += 1).to_s
+    else
+      @used_ids[gen_id] = 0
+    end
+    gen_id
+  end
+
+  def basic_generate_id(str)
+    gen_id = str.gsub(/^[^a-zA-Z]+/, "")
+    gen_id.tr!("^a-zA-Z0-9 -", "")
+    gen_id.tr!(" ", "-")
+    gen_id.downcase!
+    gen_id
+  end
+end
+
+class Jekyll::Converters::Markdown
+  # A Markdown renderer which uses JekyllCommonMarkCustomRenderer to output the
+  # final document.
+  class CommonMarkGhPages < CommonMark
+    def convert(content)
+      parse_options = (Set.new(@options) & CommonMarker::Config::Parse.keys).to_a
+      render_options = (Set.new(@options) & CommonMarker::Config::Render.keys).to_a
+      parse_options = :DEFAULT if parse_options.empty?
+      render_options = :DEFAULT if render_options.empty?
+      doc = CommonMarker.render_doc(content, parse_options, @extensions)
+      JekyllCommonMarkCustomRenderer.new(
+        :options => render_options,
+        :extensions => @extensions
+      ).render(doc)
+    end
+  end
+end

data/script/cibuild

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+bundle exec rspec

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require "rspec/expectations"
+require File.expand_path("../lib/jekyll-commonmark-ghpages.rb", File.dirname(__FILE__))
+
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.order = "random"
+end

data/spec/test_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+
+describe JekyllCommonMarkCustomRenderer do
+  let(:renderer) { JekyllCommonMarkCustomRenderer.new }
+  let(:doc) { CommonMarker.render_doc("# Hello\n\n## Hi, world!") }
+  subject { renderer.render(doc) }
+
+  it { is_expected.to match %r{<h1 id="hello">Hello</h1>} }
+  it { is_expected.to match %r{<h2 id="hi-world">Hi, world!</h2>} }
+end
+
+describe Jekyll::Converters::Markdown::CommonMarkGhPages do
+  let(:converter) { Jekyll::Converters::Markdown::CommonMarkGhPages.new(config) }
+  let(:config) {
+    {"commonmark" => {
+      "options" => ["SMART", "FOOTNOTES"],
+      "extensions" => ["tagfilter"],
+    }}
+  }
+  subject { converter.convert("### \"Hi\" <xmp>[^nb]\n\n[^nb]: Yes.\n") }
+
+  it { is_expected.to match %r{<h3 id="[^"]*">“Hi” &lt;xmp><sup[^>]*><a href="#fn1"[^>]*>\[1\]</a></sup></h3>\n<section class="footnotes">\n<ol>\n<li id="fn1">\n<p>Yes. <a href="#fnref1".*</a></p>} }
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-commonmark-ghpages
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ashe Connor
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll-commonmark
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: commonmarker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.6
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: 
+email: kivikakk@github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- appveyor.yml
+- jekyll-commonmark-ghpages.gemspec
+- lib/jekyll-commonmark-ghpages.rb
+- script/cibuild
+- spec/spec_helper.rb
+- spec/test_spec.rb
+homepage: https://github.com/github/jekyll-commonmark-ghpages
+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.5.1
+signing_key: 
+specification_version: 4
+summary: CommonMark generator for Jekyll
+test_files:
+- spec/spec_helper.rb
+- spec/test_spec.rb