summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorDave Kerr <dwmkerr@gmail.com>2020-01-14 00:46:19 +0800
committerAlex Shpak <alex-shpak@users.noreply.github.com>2020-01-13 17:46:19 +0100
commit36a8cf516994df44073cac263a2f786b08a026d4 (patch)
treea1bf707680f9e7838ebb0fed1dcd8987e1f3da23 /README.md
parente037b7c70f3800a2cd38715ca31cd4cdca71c96e (diff)
feat: added support for Disqus (#120)
* feat: added support for Disqus * feat: allow disqus to be disabled through frontmatter Set: bookDisableComments: true On a page to disable disqus for the content.
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/README.md b/README.md
index 2fb91ea..bfdba3b 100644
--- a/README.md
+++ b/README.md
@@ -24,6 +24,7 @@
- Customisable
- Zero initial configuration
- Handy shortcodes
+- Optional support for Disqus
## Requirements
@@ -117,6 +118,10 @@ You can also see `yaml` example [here](https://github.com/alex-shpak/hugo-book/b
# Always put it on the top of the configuration file, otherwise it won't work
googleAnalytics = "UA-XXXXXXXXX-X"
+# (Optional) If you provide a Disqus shortname, comments will be enabled on
+# all pages.
+disqusShortname = "my-site"
+
# (Optional) Set this to true if you use capital letters in file names
disablePathToLower = true
@@ -190,6 +195,9 @@ bookHidden = true
# (Optional) Set how many levels of ToC to show. use 'false' to hide ToC completely
bookToC = 3
+
+# If you have enabled Disqus for the site, you can disable it for specific pages.
+bookDisableComments = true
```
### Partials