commit d4b8be1ea26eccce91388c97e3697599ba24e815
parent c33d16f54d439fb3c5fb2574a91e685cf454672a
Author: Shimmy Xu <shimmy.xu@shimmy1996.com>
Date: Tue, 7 Jan 2020 20:56:08 -0600
Update README
Diffstat:
1 file changed, 6 insertions(+), 1 deletion(-)
diff --git a/README.org b/README.org
@@ -1,5 +1,5 @@
* Hyperskip
-Hyperskip adds email-powered comments for Hugo.
+Hyperskip adds email-powered static comments for Hugo.
** Usage
Insert comment section with
@@ -7,6 +7,11 @@ Insert comment section with
{{ partial "hyperskip.html" . }}
#+END_SRC
+For best compatibility with web feeds like RSS or ATOM, use the following =<nav>=-less version to avoid use of =onlick= and anchors
+#+BEGIN_SRC html
+{{ partial "hyperskip_feed.html" . }}
+#+END_SRC
+
The theme expects to find =/data/comments.toml= in the blog directory with the following format:
#+BEGIN_SRC toml
[[comments]]