commit b4a757976ac8cc50bb54e1345503872e1524a553
parent 069b809bd6d776c84bc08ab4f6866af128d662ae
Author: Shimmy Xu <shimmy.xu@shimmy1996.com>
Date: Sun, 5 Apr 2020 19:16:49 -0500
Wrap lines in README
Diffstat:
1 file changed, 15 insertions(+), 5 deletions(-)
diff --git a/README.org b/README.org
@@ -7,12 +7,14 @@ Insert comment section with
{{ partial "hyperskip.html" . }}
#+END_SRC
-For best compatibility with web feeds like RSS or ATOM, use the following to avoid including =<script>= and =<form>=
+For best compatibility with web feeds like RSS or ATOM, use the following to
+avoid including =<script>= and =<form>=
#+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:
+The theme expects to find =/data/comments.toml= in the blog directory with the
+following format:
#+BEGIN_SRC toml
[[comments]]
name="Anonymous"
@@ -32,12 +34,20 @@ The theme expects to find =/data/comments.toml= in the blog directory with the f
"""
#+END_SRC
-For the email form to work properly, please specify in blog's =config.toml= author's email, which will be used for submission and matching blog author's comments. You can specify author information like so:
+For the email form to work properly, please specify in blog's =config.toml=
+author's email, which will be used for submission and matching blog author's
+comments. You can specify author information like so:
#+BEGIN_SRC toml
[author]
email = "author@example.com"
#+END_SRC
-The last 4 characters of =email_hash= will be displayed on the page for anyone aside from the blog author (SHA256 is used to match author email to given email hash). It is preferable to also only store the last few characters of email hash in the =comments.toml= file. This is used as an alternative to services like Gravatar or Libravatar for identification purposes, which would have required storing the entire hash value, an inherent security risk.
+The last 4 characters of =email_hash= will be displayed on the page for anyone
+aside from the blog author (SHA256 is used to match author email to given email
+hash). It is preferable to also only store the last few characters of email hash
+in the =comments.toml= file. This is used as an alternative to services like
+Gravatar or Libravatar for identification purposes, which would have required
+storing the entire hash value, an inherent security risk.
-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.
+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.