From 1f0c091dd1e9d57da7448781578f5bb7df427280 Mon Sep 17 00:00:00 2001 From: eeriksp Date: Tue, 22 Jun 2021 16:54:23 +0300 Subject: Add instructions regarding sidenotes to README.md --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index abd681d..9bf8033 100644 --- a/README.md +++ b/README.md @@ -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. -- cgit v1.2.3