jekyll-markly 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97974bf8db134f319970d7d9014115beaefe1d5814f43ffb8760dc37ef7cc95a
-  data.tar.gz: 3f5961f505fa5e9b8a286fbd1437e14b915d2a4a109e40f8d487c942e9134448
+  metadata.gz: 373c40119a536a69530b3b67433d0672f6d7a72c427f26cc02532a66119dbc22
+  data.tar.gz: a92db070578e1bf8cbb0648e800af57248fa2acac604b715e077fc6fc1cf3a56
 SHA512:
-  metadata.gz: 60949607733291e1c37030349f784090140d5e5444ecc608cdbddc8f7e63ecc5ba3829d8b3a8d344da0ca60646c1edc7513652dddce889eab643a62faa4fd664
-  data.tar.gz: 8c5382cba2509ca2ef95ff22902671a62968b3e6c06aa7c693a7999a9fce24294258fb5e27cd70a30b7e7795817b8e9f7d9c459201e600370012b7fc20f379c7
+  metadata.gz: 35df5c81714314fb6c5292b8e692a53d233e62e8ecc7bcab02705c69cdbf1adb201071f1d22f1f42ad1136aff5d6d49d42ffe73b3d08c6673106f61f1589c686
+  data.tar.gz: b6854973256e3126ac4466be85eeb562eb4fcab29e899b1840fb6ade3af047639029f1bd654172df08aa28aeb0c1e6fd94dea5a3eac519fb966639b7b90f9442

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [Unreleased]
 
+## [0.1.1] - 2026-09-05
+
+- Strip Rouge lexer options from codeblock language attributes
+- Remove the `div.highlight` inside `div.highlighter-rouge` wrapping
+  `pre.highlight`
+
 ## [0.1.0] - 2026-09-04
 
 - Initial release

data/README.md

@@ -1,39 +1,55 @@
 # Jekyll::Markly
 
-TODO: Delete this and the text below, and describe your gem
+Jekyll Markdown converter that uses [`cmark-gfm`], Github's fork of the
+reference parser for CommonMark, through the [`markly`] gem.
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/jekyll/markly`. To experiment with that code, run `bin/console` for an interactive prompt.
+[`cmark-gfm`]: https://github.com/github/cmark-gfm
+[`markly`]: https://github.com/socketry/markly
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+Add `jekyll-markly` to the `jekyll_plugins` group in your `Gemfile`
 
-Install the gem and add to the application's Gemfile by executing:
+```ruby
+group :jekyll_plugins do
+  gem "jekyll-markly"
+end
+```
+
+and update the `markdown` configuration in `_config.yml`
 
-```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```yml
+markdown: Markly
 ```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+## Configuration
 
-```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+`cmark-cfm` extensions and options can be configured with the `commonmark`
+configuration in `_config.yml`
+
+```yml
+commonmark:
+  extensions: [table, strikethrough, autolink]
+  options: [unsafe, footnotes]
 ```
 
-## Usage
+The full list of supported extensions and options can be found in the `Markly`
+[documentation][].
 
-TODO: Write usage instructions here
+[documentation]: https://socketry.github.io/markly/guides/getting-started/index.html#options
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake ` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake test` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/jekyll-markly.
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/skipkayhil/jekyll-markly.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT
+License](https://opensource.org/licenses/MIT).

data/lib/jekyll/markly/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Markly
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data/lib/jekyll/markly.rb

@@ -48,11 +48,11 @@ class Jekyll::Markly::HtmlRenderer < Markly::Renderer::HTML
 
   def code_block(node)
     block do
-      lang = extract_code_lang(node.fence_info)
+      lang, lang_with_options = extract_code_lang(node.fence_info)
 
       out('<div class="')
       out("language-", lang, " ") if lang
-      out('highlighter-rouge"><div class="highlight">')
+      out('highlighter-rouge">')
       out("<pre", source_position(node), ' class="highlight"')
 
       if flag_enabled?(Markly::GITHUB_PRE_LANG)
@@ -63,8 +63,8 @@ class Jekyll::Markly::HtmlRenderer < Markly::Renderer::HTML
         out_data_attr(lang)
         out(">")
       end
-      out(render_with_rouge(node.string_content, lang))
-      out("</code></pre></div></div>")
+      out(render_with_rouge(node.string_content, lang_with_options))
+      out("</code></pre></div>")
     end
   end
 
@@ -74,7 +74,10 @@ class Jekyll::Markly::HtmlRenderer < Markly::Renderer::HTML
     return unless info.is_a?(String)
     return if info.empty?
 
-    info.split(%r{\s+})[0]
+    lang_with_options = info.split(%r{\s+})[0]
+    lang = lang_with_options.split("?")[0]
+
+    [lang, lang_with_options]
   end
 
   def out_data_attr(lang)
@@ -98,11 +101,14 @@ end
 
 class Jekyll::Converters::Markdown::Markly
   def initialize(config)
-    @extensions = config.dig("commonmark", "extensions").map!(&:to_sym)
+    @extensions = config.dig("commonmark", "extensions")&.map!(&:to_sym) || [].freeze
 
-    symbol_options = config.dig("commonmark", "options").map!(&:to_sym)
-    @parse_flags = symbol_options.filter_map { |k| Markly::PARSE_FLAGS[k] }.reduce(&:|)
-    @render_flags = symbol_options.filter_map { |k| Markly::RENDER_FLAGS[k] }.reduce(&:|)
+    if (symbol_options = config.dig("commonmark", "options")&.map!(&:to_sym))
+      @parse_flags = symbol_options.filter_map { |k| Markly::PARSE_FLAGS[k] }.reduce(&:|)
+      @render_flags = symbol_options.filter_map { |k| Markly::RENDER_FLAGS[k] }.reduce(&:|)
+    else
+      @parse_flags = @render_flags = 0
+    end
   end
 
   def convert(content)

data/test/jekyll_markly_test.rb

@@ -1,5 +1,53 @@
+# frozen_string_literal: true
+
 class JekyllMarklyTest < JekyllMarklyTestCase
-  test "nothing" do
-    assert true
+  test "syntax highlighting" do
+    html = md_to_html(<<~MD)
+      ```ruby
+      3.times {}
+      ```
+    MD
+
+    assert_snapshot(<<~SNAP, html)
+      <div class="language-ruby highlighter-rouge"><pre class="highlight"><code data-lang="ruby"><span class="mi">3</span><span class="p">.</span><span class="nf">times</span> <span class="p">{}</span>
+      </code></pre></div>
+    SNAP
+  end
+
+  test "lang attributes include lexer options" do
+    html = md_to_html(<<~MD)
+      ```console?comments=true
+      # frank
+      ```
+    MD
+
+    assert_snapshot(<<~SNAP, html)
+      <div class="language-console highlighter-rouge"><pre class="highlight"><code data-lang="console"><span class="c"># frank
+      </span></code></pre></div>
+    SNAP
+  end
+
+  private
+
+  def assert_snapshot(expected, actual)
+    if expected.empty?
+      flunk <<~OUT
+        Empty snapshot at line #{caller_locations(1, 1).first.lineno}. Replace with
+
+        assert_snapshot(<<~SNAP, html)
+          #{actual.strip}
+        SNAP
+      OUT
+    end
+
+    assert_equal expected.strip, actual.strip
+  end
+
+  def md_to_html(md)
+    converter.convert(md)
+  end
+
+  def converter(config = {})
+    @converter ||= Jekyll::Converters::Markdown::Markly.new(config)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-markly
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Hartley McGuire