comment

comment 用于开启和配置 Keep 主题内置的评论系统。

enable

enable 设置是否开启评论系统，可选值：true 或 false。

use

use 配置使用哪一款评论系统，可选值：valine | gitalk | twikoo | waline | giscus | artalk | disqus。

use: valine  # values: valine | gitalk | twikoo | waline | giscus | artalk | disqus

valine

Valine 是一款基于 LeanCloud 的快速、简洁且高效的无后端评论系统。

详情查看：

• https://github.com/xCss/Valine
• https://valine.js.org

appid

appid 设置 LeanCloud 应用的 App ID。

参考 Valine 官方配置教程，获取 App ID，并填入主题配置项 appid 中。

appid: **********

appkey

appkey 设置 LeanCloud 应用的 App Key。

参考 Valine 官方配置教程，获取 App Key，并填入主题配置项 appkey 中。

appkey: **********

server_urls

server_urls 设置 LeanCloud 应用的 serverURLs。

该配置适用于国内自定义域名用户，海外版本会自动检测，无需手动填写。

placeholder

placeholder 评论框的的占位字符，选填。

Valine 效果图

gitalk

Gitalk，一个基于 Github Issue 和 Preact 开发的评论插件。

详情查看：

• https://github.com/gitalk/gitalk
• https://gitalk.github.io

如何使用

在 Keep 主题中如何使用：

1. 新建 GitHub OAuth App
   注册或登录 GitHub，创建新的 OAuth App，其中 Homepage URL 和 Authorization callback URL 均填写自己的域名即可。

   OAuth App 创建成功后，把 Client ID 和 Client Secret 保存起来。

   

2. 新建 GitHub 仓库
   注册或登录 GitHub，创建一个新的仓库（repository），并打开 Issues（自己手动增加一个 Issue，内容可随便填写），用于存储评论内容。

3. 把自己的 GitHub 用户名、仓库名 、OAuth App 的 Client ID 、Client Secret 分别填写在主题配置文件里，如下示例。

   gitalk:
     github_id: XPoet
     repository: hexo-site-comments
     client_id: **********
     client_secret: **********

Gitalk 效果图

twikoo

Twikoo，一个简洁、安全、免费的静态网站评论系统。

详情查看：

• https://github.com/imaegoo/twikoo
• https://twikoo.js.org

env_id

env_id 是 Twikoo 评论系统云函数部署成功之后获取的环境 ID。

参考 Twikoo 云函数部署官方教程，获取 env_id 环境 ID，并填入主题配置项中。

twikoo:
  env_id: **********

version

version 设置 Twikoo 评论系统版本，Keep 主题默认使用 Twikoo v1.6.21，你可以自由修改版本。

twikoo:
  version: 1.6.21

注意

Twikoo 评论系统的版本需跟 Twikoo 云函数版本保持一致

Twikoo 效果图

waline

Waline 一款简洁、安全的评论系统。

详情查看：

• https://github.com/walinejs/waline
• https://waline.js.org

server_url

server_url 是成功部署 Waline 评论系统的服务端地址。

参考 Waline 官方配置教程，获取 server_url 服务端地址，并填入主题配置项中。

waline:
  server_url: https://waline-xxxxxx.xpoet.cn  # 示例

reaction

reaction 设置开启文章反应，可选值：true 或 false。

version

version 设置 Waline 评论系统版本，Keep 主题内置使用 Waline v2，你可以自行更改。

waline:
  version: 2

options v3.8.5

如果你需要更多的 Waline 评论插件配置项，只需增加 options 用于扩展除 Keep 主题内置之外的 Waline 客户端组件属性配置项。

• Waline 客户端组件属性：

  https://waline.js.org/reference/client/props.html

• options 扩展项使用示例：

  waline:
    server_url: https://xxx.xxx.com
    reaction: true
    version: 2
    options:
      pageSize: xx
      commentSorting: xx
      emoji: xx
      meta: xx
      login: xx
      ...
      ...
      ...

Waline 效果图

giscus v3.7.0

Giscus 是一款利用 GitHub Discussions 实现的评论系统。

详情查看：

• https://github.com/giscus/giscus
• https://giscus.app

如何使用

Keep 主题暴露了 Giscus 评论插件五个配置项：repo、repo_id、category、category_id、reactions_enabled，请在 https://giscus.app 生成你的配置项。

Giscus 效果图

artalk v4.0.0

Artalk 是一款简洁的自托管评论系统。

详情查看：

• https://github.com/ArtalkJS/Artalk
• https://artalk.js.org

server

server 是成功部署 Artalk 评论系统的服务器域名。

参考 Artalk 官方部署教程，获取 server 服务器域名，并填入主题配置项中。

artalk:
  server: http://your_domain.com  # 示例

options

如果你需要更多的 Artalk 评论插件配置项，只需增加 options 用于扩展除 Keep 主题内置之外的 Artalk 前端配置项。

• Artalk 前端配置项：

  https://artalk.js.org/guide/frontend/config.html

• options 扩展项使用示例：

  artalk:
    server: https://xxx.xxx.com
    options:
      reqTimeout: 30000
      emoticons: xx
      placeholder: xx
      sendBtn: xx
      ...
      ...
      ...

Artalk 效果图

disqus v4.0.0

Disqus 是一种广泛用于网站和博客上的第三方评论系统，允许用户方便地发表评论和互动。

注意：Disqus 评论系统在中国大陆地区无法直接使用！

详情查看：

https://disqus.com/

shortname

shortname 是成功注册 Disqus 账户之后获得的 Shortname，填入主题配置项中。

disqus:
  shortname: ***   # 示例

Disqus 效果图

温馨提示

Keep 主题中内置的所有评论插件均为第三方评论插件，你在使用过程中，但凡遇到属于评论插件自身的问题，请直接反馈给评论插件的作者或提供商。