Skip to main content

Add supports for ruby blocks syntax in Markdown

Project description

lektor-markdown-ruby-blocks

This is a simple Lektor plugin that adds support for HTML ruby tags to Markdown.

Syntax

To create a ruby tag, use the following ruby-block syntax:

^^
(歩)[ある]く
^^

This will generate the following HTML:

<span class="ruby-line">
  <ruby><rp>(</rp><rt>ある</rt><rp>)</rp></ruby></span>

The rendering result:

歩(ある)く

You can combine adjacent ruby text like this:

^^
(自|分)[じ|ぶん]
^^

And this will be rendered like this:

<span class="ruby-line">
  <ruby><rp>(</rp><rt></rt><rp>)</rp></ruby>
  <ruby><rp>(</rp><rt>ぶん</rt><rp>)</rp></ruby>
</span>

Rendered output:

自(じ) 分(ぶん)

Newline

This plugin will automatically add <br /> between each line in a ruby-block:

^^
(歩)[ある]く
(歩)[ある]く
^^

This will output:

<span class="ruby-line">
  <ruby><rp>(</rp><rt>ある</rt><rp>)</rp></ruby></span>
<br />
<span class="ruby-line">
  <ruby><rp>(</rp><rt>ある</rt><rp>)</rp></ruby></span>

You can also use -##- to create an extra newline in a ruby-block.

^^
(歩)[ある]く
-##-
(歩)[ある]く
^^

Output:

<span class="ruby-line">
  <ruby><rp>(</rp><rt>ある</rt><rp>)</rp></ruby></span>
<br />
<br />
<span class="ruby-line">
  <ruby><rp>(</rp><rt>ある</rt><rp>)</rp></ruby></span>

Coloring the text

Additionally, you can add a 6-digit or 8-digit hex RGB code after the beginning ^^, making the rendered content colored with specified color.

^^#44cc00
(歩)[ある]く
^^

This will generate the following HTML pieces:

<span class="ruby-line" style="color: #44cc00">
  <ruby><rp>(</rp><rt>ある</rt><rp>)</rp></ruby></span>

Raw lines

Prepend %  to create a raw line. Raw lines are not converted to ruby tags, not affected by the color settings, and have a different class.

Example:

^^#44cc00
(歩)[ある]く
% (aru)[ku]
^^

Output:

<span class="ruby-line" style="color: #44cc00">
  <ruby><rp>(</rp><rt>ある</rt><rp>)</rp></ruby></span>
<br />
<span class="non-ruby-line">
  (aru)[ku]
</span>

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lektor_markdown_ruby_blocks-0.2.3.tar.gz (3.7 kB view hashes)

Uploaded Source

Built Distribution

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page