hugo-hyperskip

commit a74a8f891f3f580a53636c90b0bb6365951630d2
parent 7fd36f39a9fdab8a61d9b91dcb53bf028d2b94e7
Author: Shimmy Xu <shimmy.xu@shimmy1996.com>
Date:   Sun,  5 Jan 2020 10:42:17 -0600

Add usage information

Diffstat:
M
README.org
 | 
23
+++++++++++++++++++++++

1 file changed, 23 insertions(+), 0 deletions(-)
diff --git a/README.org b/README.org
@@ -1,7 +1,30 @@
 * Hyperskip
 Hyperskip adds email-powered comments for Hugo.
 
+** Usage
 Insert comment section with
 #+BEGIN_SRC html
 {{ partial "hyperskip.html" . }}
 #+END_SRC
+
+The theme expects to find =/data/comments.toml= in the blog directory with the following format:
+#+BEGIN_SRC toml
+  [[comments]]
+  name="Anonymous"
+  email_hash="1234abcd8d"
+  time=2020-01-01T01:01:01+00:00
+  uri="/my-first-post/"
+  content="""
+  Hello!
+  """
+  [[comments]]
+  name="Ken"
+  email_hash="abcd1234h8"
+  time=2020-01-01T01:03:01+00:00
+  uri="/my-first-post/"
+  content="""
+  Thanks!
+  """
+#+END_SRC
+
+By default, form data is sent using URL encoding in body of the email. An easy way to convert it back is to use =urllib.parse.unquote= in Python.