diff options
author | eeriksp <eerik.sven@gmail.com> | 2021-06-22 16:54:23 +0300 |
---|---|---|
committer | eeriksp <eerik.sven@gmail.com> | 2021-06-22 16:54:23 +0300 |
commit | 1f0c091dd1e9d57da7448781578f5bb7df427280 (patch) | |
tree | 40d0d7ec7a56652b4e7271497ff11448624e7590 | |
parent | 9d4e56d030e37c8127c0d1395ae3fbb84bc59f53 (diff) |
Add instructions regarding sidenotes to README.md
-rw-r--r-- | README.md | 12 |
1 files changed, 12 insertions, 0 deletions
@@ -42,6 +42,18 @@ tag = "tags" series = "series" ``` +## Shortcodes + +### Sidenotes + +[LaTeX.css](https://latex.vercel.app/), which HugoTeX is using, defines syntax for sidenotes. However, as it is a little verbose to write, we provide a Hugo shortcode for that: + +``` +A sentence deserving a sidenote.{{%/* sidenote */%}}The note itself.{{%/* /sidenote */%}}. +``` + +The note will be displaied on the right margin on larger screens. On smaller screns the note will be hidden by default and will open when clicking on the superscript number marking the existence of the note. + ## For contributors Any issues or pull requests are welcome. |