diff options
Diffstat (limited to 'Comment-Area.md')
-rw-r--r-- | Comment-Area.md | 86 |
1 files changed, 86 insertions, 0 deletions
diff --git a/Comment-Area.md b/Comment-Area.md new file mode 100644 index 0000000..136ce80 --- /dev/null +++ b/Comment-Area.md @@ -0,0 +1,86 @@ +## Enable or disable comment area + +Now, this theme support these comment service: +- LiveRe +- Gitalk +- Disqus +- Valine + +### Enabling +#### Gitalk +Edit your `config.toml` in the hugo website's root directory. + +Add the following line to the section `[params]` +```toml +enableGitalk = true +``` +Then add following lines behind: +```toml +[params.gitalk] + owner = "user" + repo = "repo name" + client_id = "your client id" + client_secret = "your client secret" +``` +(Modify to suit your condition.) + +Notice: Gitalk will not shown in offline preview server.(Launched by `hugo server`) +#### Disqus +Hugo originally supports Disqus, and I added the disqus to the theme. + +But due to my network environment, I haven't had it tested. + +To add a disqus comment service, please add a line to `config.toml` in the root directory: + +```toml +disqusShortname = "Your disqus short name." +``` + +#### LiveRe! + +Edit your `config.toml` in the hugo website's root directory. + +Add the following line to the section `[params]` +```toml +livereId = "xxxx" +``` + +"xxxx" stands for the value of `data-uid` in your LiveRe HTML code. + +#### Valine +Edit your `config.toml` in the hugo website's root directory. + +Add the following line to the section `[params]` +```toml +enableValine = true +``` +Then add following lines behind: +```toml +[params.valine] + appId = "Your app ID of leancloud" + appKey = "Your app key of leancloud" + avator = "avator type" +``` + +`avator` is optional. For details, [click here](https://valine.js.org/avatar.html). + +#### Other comment service + +Welcome to open an issue or Pull Request for adding a new comment service. + +If I'm free then, I will add it. :P + +--- + +### Disabling +#### Disable the comment area in one post +If you wanna to disable the comment area in a specific post, please add a line in the metadata area of the post: +``` +comment : false +``` +A more detailed description of the posts' meta data is [here](https://github.com/AmazingRise/hugo-theme-diary/wiki/Post's-meta-data). + +#### Disable it globally +Please remove the settings item referred in "Add comment area". + +The comment area will not be shown.
\ No newline at end of file |