diff --git a/index.html b/index.html index 1ccae078..da5cb541 100644 --- a/index.html +++ b/index.html @@ -151,7 +151,7 @@ speak multiple languages and allow you to easily create localized websites.
Add supports to ruby blocks syntax in Markdown.
+
Version: 0.2.3
+Author: + + 25349023 + +
+ + ++ View all tags. +
+This is a simple Lektor plugin that adds support for +HTML ruby tags to Markdown.
+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:
++ + <ruby>歩<rp>(</rp><rt>ある</rt><rp>)</rp></ruby>く + +
+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:
+ + <ruby>自<rp>(</rp><rt>じ</rt><rp>)</rp></ruby> + <ruby>分<rp>(</rp><rt>ぶん</rt><rp>)</rp></ruby> + +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>
+
+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>
+
+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>
+
+
+
+
+
+
Comments
+ + + + + +