mirror of https://github.com/lxndrblz/anatole.git

mousemin
26.11.2021 d0da3fd2f2326dc9e3efcb340ed623b0eb74886d
docs: update README.md
2 files modified
14 ■■■■■ changed files
README.md 12 ●●●●● patch | view | raw | blame | history
layouts/partials/comments/gitalk.html 2 ●●● patch | view | raw | blame | history
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/)
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
  });