No commit activity in last 3 years
No release in over 3 years
A HTML::Pipeline filter to write ruby markup elements.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Runtime

 Project Readme

HTML::Pipeline::RubyMarkup

HTML::Pipeline::RubyMarkup provides a HTML::Pipeline filter to easily write ruby markups in Markdown documents.

Installation

Add this line to your application‘s Gemfile:

gem "html-pipeline-ruby_markup"

Or install it yourself as:

$ gem install html-pipeline-ruby_markup

Usage

HTML::Pipeline::RubyMarkup processes Text, so it must come before the markdown filter.

require "html/pipeline"
require "html/pipeline/ruby_markup"

pipeline = HTML::Pipeline.new [
  HTML::Pipeline::RubyMarkup::Filter,
  HTML::Pipeline::MarkdownFilter,
]

result = pipeline.call <<-MARKDOWN.strip_heredoc
  [漢字(かんじ)]
MARKDOWN

puts result[:output].to_html

prints:

<ruby>
漢字<rp>(</rp><rt>かんじ</rt><rp>)</rp>
</ruby>

Contributing

Please see the CONTRIBUTING.md file.

License

Please see the LICENSE.md file.