jekyll-commonmark-ghpages 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 635aef17f3e4a950f8f41670fbbb1712e39c4b3e1ffdddfd48fbf70f1b233820
-  data.tar.gz: a2a42104b0688eedf9612db4afd76928fe156c8b8c8b3659a5697b5d2a2dba08
+  metadata.gz: 8b6560d6d39742b63f7976d4b6df8dcc4f0cbf96cbfd72d786b2884f9623144a
+  data.tar.gz: d5f9045e89575c3b4a32690976e90a4c2783f970a78a068a79a5409aa8e99753
 SHA512:
-  metadata.gz: 7741f0a8cae7c61a82f69658f1fe3c315e441ec42474c16f1552032ac0afa6f6d55c967b5bca1c218cca218f0609ae00ea9fd7a358e1b555593c0e9bbf98f694
-  data.tar.gz: f7ac6c990a91894c1259c19c865b1bed1d3337f6139b8427bc33f5ff01b3014256d7a64b6060e3677b9f3f7edb2be3b0328f4af30547458556a5813c06cf6f18
+  metadata.gz: 3746a5a1699a22924cd92e8175dcd38f51a07208ac90e8730724964a48a1b56ecec41c0d7a0a619aac089dd6f9f3d586018746761e7240f7b28f3092d82e089d
+  data.tar.gz: 034d544a15c89930b5691ef68324f8a37857aacd0d21ee802c31f19703d61eae1c6fe4c71860a1dd547482d638512b95d52c1cca50363815e2e9e773c7535ee2

data/.github/CODEOWNERS

@@ -0,0 +1,2 @@
+# Automatically add our team to each pull request in this repo
+* @github/pages-reviewers

data/.github/workflows/cibuild.yaml

@@ -0,0 +1,17 @@
+on: push
+name: cibuild
+jobs:
+  build:
+    name: Test
+    strategy:
+      matrix:
+        ruby: [2.6, 2.7]
+        os: [ubuntu-latest, macos-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: script/cibuild
+        run: script/cibuild

data/.gitignore

@@ -2,3 +2,4 @@
 Gemfile.lock
 spec/dest
 .bundle
+vendor/

data/README.md

@@ -3,8 +3,7 @@
 *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)
+[![Build Status](https://github.com/github/jekyll-commonmark-ghpages/actions/workflows/cibuild.yaml/badge.svg)](https://github.com/github/jekyll-commonmark-ghpages/actions/workflows/cibuild.yaml)
 
 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.
 
@@ -30,6 +29,8 @@ To specify extensions and options for use in converting Markdown to HTML, supply
 
 ```yaml
 commonmark:
-  options: ["SMART", "FOOTNOTES"]
-  extensions: ["strikethrough", "autolink", "tables"]
+  options: ["UNSAFE", "SMART", "FOOTNOTES"]
+  extensions: ["strikethrough", "autolink", "table", "tagfilter"]
 ```
+
+⚠ The `UNSAFE` option is required for HTML rendering.

data/jekyll-commonmark-ghpages.gemspec

@@ -3,9 +3,9 @@
 Gem::Specification.new do |spec|
   spec.name          = "jekyll-commonmark-ghpages"
   spec.summary       = "CommonMark generator for Jekyll"
-  spec.version       = "0.1.4"
-  spec.authors       = ["Ashe Connor"]
-  spec.email         = "kivikakk@github.com"
+  spec.version       = "0.2.0"
+  spec.authors       = ["GitHub, Inc."]
+  spec.email         = "support@github.com"
   spec.homepage      = "https://github.com/github/jekyll-commonmark-ghpages"
   spec.licenses      = ["MIT"]
 
@@ -14,11 +14,11 @@ Gem::Specification.new do |spec|
   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_runtime_dependency "rouge", "~> 2"
+  spec.add_runtime_dependency "jekyll", "~> 3.9.0"
+  spec.add_runtime_dependency "jekyll-commonmark", "~> 1.4.0"
+  spec.add_runtime_dependency "commonmarker", "~> 0.23.4"
+  spec.add_runtime_dependency "rouge", ">= 2.0", "< 4.0"
 
   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

@@ -81,13 +81,9 @@ class Jekyll::Converters::Markdown
   # 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)
+      doc = CommonMarker.render_doc(content, @parse_options, @extensions)
       html = JekyllCommonMarkCustomRenderer.new(
-        :options => render_options,
+        :options => @render_options,
         :extensions => @extensions
       ).render(doc)
       html.gsub(/<br data-jekyll-commonmark-ghpages>/, "\n")
@@ -97,9 +93,25 @@ end
 
 class Jekyll::Tags::HighlightBlock
   alias render_rouge_without_ghpages_hack render_rouge
+  alias render_without_ghpages_hack render
+
+  def render(context)
+    @render_ghpages_hack_context = context
+    render_without_ghpages_hack(context)
+  end
 
   def render_rouge(context)
-    render_rouge_without_ghpages_hack(context)
-      .gsub(/\r?\n/, "<br data-jekyll-commonmark-ghpages>")
+    rendered = render_rouge_without_ghpages_hack(context)
+
+    processor = @render_ghpages_hack_context
+      .registers[:site]
+      .find_converter_instance(Jekyll::Converters::Markdown)
+      .get_processor
+
+    if processor.is_a?(Jekyll::Converters::Markdown::CommonMarkGhPages)
+      rendered.gsub!(/\r?\n/, "<br data-jekyll-commonmark-ghpages>")
+    end
+
+    rendered
   end
 end

data/script/cibuild

@@ -1,3 +1,13 @@
 #!/bin/bash
 
+# Update gems
+gem update --system 3.2.3
+
+# Install bundler
+gem install bundler
+
+# Install dependencies
+bundle install
+
+# Run tests
 bundle exec rspec

data/spec/test_spec.rb

@@ -21,18 +21,18 @@ describe Jekyll::Converters::Markdown::CommonMarkGhPages do
   let(:converter) { Jekyll::Converters::Markdown::CommonMarkGhPages.new(config) }
   let(:config) {
     {"commonmark" => {
-      "options" => ["SMART", "FOOTNOTES"],
+      "options" => ["UNSAFE", "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>} }
+  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
 
 describe Jekyll::Renderer do
   it "should not re-process markdown in a liquid tag" do
-    site = Jekyll::Site.new(Jekyll.configuration("markdown" => "CommonMarkGhPages"))
+    site = Jekyll::Site.new(Jekyll.configuration("markdown" => "CommonMarkGhPages", "commonmark" => { "options" => ["UNSAFE"] }))
     collection = Jekyll::Collection.new(site, "pages")
     document = Jekyll::Document.new("hello.md", site: site, collection: collection)
     document.content = "**Hi**\n" \

metadata

@@ -1,57 +1,77 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-commonmark-ghpages
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
-- Ashe Connor
-autorequire: 
+- GitHub, Inc.
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-02-09 00:00:00.000000000 Z
+date: 2022-03-03 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
 - !ruby/object:Gem::Dependency
   name: jekyll-commonmark
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: 1.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: 1.4.0
 - !ruby/object:Gem::Dependency
   name: commonmarker
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.6
+        version: 0.23.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.6
+        version: 0.23.4
 - !ruby/object:Gem::Dependency
   name: rouge
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -80,33 +100,19 @@ dependencies:
     - - ">="
       - !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
+description:
+email: support@github.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/CODEOWNERS"
+- ".github/workflows/cibuild.yaml"
 - ".gitignore"
-- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
-- appveyor.yml
 - jekyll-commonmark-ghpages.gemspec
 - lib/jekyll-commonmark-ghpages.rb
 - script/cibuild
@@ -116,7 +122,7 @@ homepage: https://github.com/github/jekyll-commonmark-ghpages
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -131,9 +137,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: CommonMark generator for Jekyll
 test_files:

data/.travis.yml

@@ -1,24 +0,0 @@
-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/appveyor.yml

@@ -1,24 +0,0 @@
-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'