jekyll-furigana

Installation

Add this line to your application's Gemfile:

gem 'jekyll-furigana'

And then execute:

$ bundle

Or install it yourself as:

$ gem install jekyll-furigana

Add jekyll-furigana to the gems: section in your site's _config.yml.

plugins:
  - jekyll-furigana

Set furigana: true in posts for which you want the FURIGANA to appear.

---
layout: post
title: "Welcome to Jekyll!"
furigana: true
---

Usage

furigana filters, which can be applied to HTML content. the Liquid variable content available in Jekyll's templates.

Add the furigana filter to your site's {{ content }} (e.g. _layouts/post.html).

{{ content | furigana }}

Markdown format

You can use one of below format or combine them.

[日本語:にほんご]

Or

「日本語:にほんご」

Or

(日本語:にほんご)

Or

{日本語:にほんご}

And this is result.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec 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 tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/Rolbackse/jekyll-furigana. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant 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::Furigana project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.