Jekyll::Shiki

Overview

Jekyll plugin for Shiki JS

[!WARNING] The first build can take some time, depending on the number of code blocks, before the cache is generated. It also requires the path to the shiki code used on the Node.js side. This plugin was created for use with the mmdocs theme. Performance has not been thoroughly tested, and the documentation is not yet complete.

Installation

Install the gem and add to the application's Gemfile by executing:

bundle add jekyll-shiki

If bundler is not being used to manage dependencies, install the gem by executing:

gem install jekyll-shiki

Usage

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/phothinmg/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.

License

The gem is available as open source under the terms of the MIT License.

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.