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:
authorkeaising <keaising@gmail.com>2019-05-20 15:48:43 +0300
committerkeaising <keaising@gmail.com>2019-05-20 15:56:29 +0300
commit1feba8671395d0a8153f948032252c44f6c8b266 (patch)
tree552ecbbd0503f555b394929585fe6ceb2db6c9cd
parent5998fac2e148d5eb3266189a6e7052b50974a593 (diff)
add README for ruby's usage.
-rw-r--r--README.md14
-rw-r--r--images/ruby.pngbin0 -> 7229 bytes
2 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. :)
diff --git a/images/ruby.png b/images/ruby.png
new file mode 100644
index 0000000..e3b3656
--- /dev/null
+++ b/images/ruby.png
Binary files differ