From d0da3fd2f2326dc9e3efcb340ed623b0eb74886d Mon Sep 17 00:00:00 2001
From: mousemin <2395360675@qq.com>
Date: Sat, 26 Jun 2021 11:11:21 +0000
Subject: [PATCH] docs: update README.md
---
README.md | 12 ++++++++++++
layouts/partials/comments/gitalk.html | 2 +-
2 files changed, 13 insertions(+), 1 deletions(-)
diff --git a/README.md b/README.md
index 93425f4..acd8168 100644
--- a/README.md
+++ b/README.md
@@ -314,6 +314,18 @@
CommentoURL = "https://commento.example.com/js/commento.js"
```
+### Comments powered by Gitalk
+No comment section is shown on the `single.html` unless a `repo` is specified in the `config.toml` file. If uncertain how parameter to configure, check out the official [documentation](https://github.com/gitalk/gitalk).
+
+```toml
+[params.gitalk]
+clientID = "GitHub Application Client ID"
+clientSecret = "GitHub Application Client Secret"
+repo = "Repository name to store issues"
+owner = "GitHub repo owner"
+admin = "GitHub repo owner and collaborators, only these guys can initialize gitHub issues"
+```
+
### Disabling Comments Per Page
Comments can be disabled per page by setting `disableComments: true` on the pages [Front Matter](https://gohugo.io/content-management/front-matter/)
diff --git a/layouts/partials/comments/gitalk.html b/layouts/partials/comments/gitalk.html
index 71b8cd6..835197d 100644
--- a/layouts/partials/comments/gitalk.html
+++ b/layouts/partials/comments/gitalk.html
@@ -7,7 +7,7 @@
clientSecret: '{{ .Site.Params.Gitalk.clientSecret }}',
repo: '{{ .Site.Params.Gitalk.repo }}',
owner: '{{ .Site.Params.Gitalk.owner }}',
- admin: ['{{ .Site.Params.Gitalk.owner }}'],
+ admin: ['{{ .Site.Params.Gitalk.admin }}'],
id: location.pathname, // Ensure uniqueness and length less than 50
distractionFreeMode: false // Facebook-like distraction free mode
});
--
Gitblit v1.10.0