Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/qqhann/hugo-primer.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
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. :)