markdown-it-ruby

Ruby annotation plugin for markdown-it parser.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
markdown-it-ruby
2110.1.15 years ago5 years agoMinified + gzip package size for markdown-it-ruby in KB

Readme

markdown-it-ruby
NPM version
Ruby annotations (<ruby>) tag plugin for markdown-it markdown parser.

{ruby base|ruby text} => <ruby>ruby base<rt>ruby text</rt></ruby>
Markup is based on DenDenMarkdown definition.

Install

node.js:
npm install markdown-it-ruby --save

Use

var md = require('markdown-it')()
            .use(require('markdown-it-ruby'));

md.render('{ruby base|rubytext}') // => '<p><ruby>ruby base<rt>ruby text</rt></ruby></p>'

License

MIT