jekyll-shiki 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a2f07a20e89e2fbbbda3fbf6d70bc9cfa218af8267e77f5f1db84ce33af33dd5
+  data.tar.gz: 5677419d80f1d162ad84b36e56d570b9b000e566c7599bfa082a02ea19a58440
+SHA512:
+  metadata.gz: f3935ddf6bbd692a45991eb8d4d67773df64c45e4adeb552ad251adbe922438edc800ed1d90efd5d795d07460cdbafec85450a806f2dd92dc8aaf81c14a39d02
+  data.tar.gz: c12a5c2f1b15520b6f935efc5e21f9cd327eb208b5e2ac53bb45e7d99d7fe9df5f9547230b93c48a56f8cc3eb5b98cd9378a1cb9328d7c4b83e507f9a4735510

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 phothinmg
+
+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,43 @@
+# Jekyll::Shiki
+
+TODO: Delete this and the text below, and describe your 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/shiki`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## 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.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/jekyll-shiki. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/jekyll-shiki/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Jekyll::Shiki project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/jekyll-shiki/blob/master/CODE_OF_CONDUCT.md).

data/lib/jekyll-shiki.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+# cspell:disable
+require "jekyll"
+require "nokogiri"
+require "json"
+require "open3"
+require "pathname"
+require "digest"
+
+require_relative "version"
+
+module Jekyll
+  # module Jekyll::ShikiCodeBlock
+  module Shiki
+    def self.resolve_shiki_bundle_path(site)
+      shiki_config = site.config["shiki"]
+      raise "Shiki highlight failed: Shiki config not found in jekyll config" unless shiki_config
+
+      bundle_path = shiki_config["bundle_path"]
+      raise "Shiki highlight failed: Required shiki bundle path." unless bundle_path
+
+      File.join(site.source, bundle_path)
+    end
+
+    def self.shiki_highlight(code, lang, site)
+      script_path = resolve_shiki_bundle_path(site)
+
+      cache_key = Digest::SHA256.hexdigest("#{lang}::#{code}")
+      Jekyll::Cache.new("Shiki").getset(cache_key) do
+        input = JSON.generate({ code: code, lang: lang }.compact)
+        stdout, stderr, status = Open3.capture3("node", script_path, stdin_data: input)
+        raise "Shiki highlight failed: #{stderr}" unless status.success?
+
+        stdout
+      end
+    end
+
+    def self.create_wrapper(lan, code, site)
+      lang = lan.capitalize
+      highlighted_code = shiki_highlight(code, lan, site)
+      <<~HTML
+        <div class="shiki_code" data-shiki-highlighter>
+          <div class="code_head">
+            <span>#{lan}</span>
+            <button type="button" aria-label="Highlight-#{lang}" data-copy-btn></button>
+          </div>
+          #{highlighted_code}
+        </div>
+      HTML
+    end
+
+    def self.replace_elements(node, site)
+      code_el = node.at_css('> code[class^="language-"]')
+      return unless code_el
+
+      code = code_el.text
+      lang = code_el["class"]
+             &.split
+             &.find { |class_name| class_name.start_with?("language-") }
+             &.delete_prefix("language-")
+      fragment = Nokogiri::HTML::DocumentFragment.parse(create_wrapper(lang, code, site))
+      node.replace(fragment)
+    end
+
+    def self.full_document?(html_content)
+      html_content.match?(/\A\s*(<!doctype\s+html|<html\b)/i)
+    end
+
+    def self.transform_html(html_content, site) # rubocop:disable Metrics/MethodLength
+      Jekyll.logger.info ""
+      Jekyll.logger.info "[jekyll-shiki] : Highlight with shiki will take time for first build"
+      doc = if full_document?(html_content)
+              Nokogiri::HTML.parse(html_content)
+            else
+              Nokogiri::HTML::DocumentFragment.parse(html_content)
+            end
+      elements = doc.css("pre").select { |pre| pre.at_css('> code[class^="language-"]') }
+      return html_content if elements.empty?
+
+      elements.each { |node| replace_elements(node, site) }
+      doc.to_html
+    end
+  end
+end
+
+Jekyll::Hooks.register :pages, :post_render do |page|
+  next unless page.output_ext == ".html"
+
+  page.output = Jekyll::Shiki.transform_html(page.output, page.site)
+end
+
+Jekyll::Hooks.register :documents, :post_render do |document|
+  next unless document.output_ext == ".html"
+
+  document.output = Jekyll::Shiki.transform_html(document.output, document.site)
+end

data/lib/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Shiki
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-shiki
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- phothinmg
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.19.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.19.4
+email:
+- phothinmg@disroot.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/jekyll-shiki.rb
+- lib/version.rb
+homepage: https://rubygems.org/gems/jekyll-shiki
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/mmdocs/jekyll-shiki
+  changelog_uri: https://github.com/mmdocs/jekyll-shiki/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.15
+specification_version: 4
+summary: Jekyll plugin for Shiki Js, for mmdocs theme
+test_files: []