From 1feba8671395d0a8153f948032252c44f6c8b266 Mon Sep 17 00:00:00 2001 From: keaising Date: Mon, 20 May 2019 20:48:43 +0800 Subject: add README for ruby's usage. --- README.md | 14 ++++++++++++++ images/ruby.png | Bin 0 -> 7229 bytes 2 files changed, 14 insertions(+) create mode 100644 images/ruby.png diff --git a/README.md b/README.md index e5314e6..4455fbc 100644 --- a/README.md +++ b/README.md @@ -109,6 +109,20 @@ tags: ``` Set keywords for seo. +#### ruby annotation + +[ruby annotation](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/ruby) allows you to show pronunciation of characters. Ruby in hugo-primer is like this: + +![ruby](/images/ruby.png) + +You just need one line shortcodes code: + +``` +{{< ruby rb="深表遗憾" rt="Xi Wen Le Jian" >}} + +{{< ruby rb="My heart is broken." rt="I'm happy for that." >}} +``` + ## Contributing Issues and PRs are welcome. :) diff --git a/images/ruby.png b/images/ruby.png new file mode 100644 index 0000000..e3b3656 Binary files /dev/null and b/images/ruby.png differ -- cgit v1.2.3