Skip to content
On this page

comment

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

yaml
comment:
  enable: false   # Option values: true | false
  use: valine     # Option values: valine | gitalk | twikoo | waline

  valine:
    appid:           # Your leancloud application appid
    appkey:          # Your leancloud application appkey
    placeholder:     # Input box placeholder

  gitalk:
    github_id:        # GitHub repo owner
    github_admins:    # GitHub Admins (in Array type), optional.
    repository:       # Repository name to store issues
    client_id:        # GitHub Application Client ID
    client_secret:    # GitHub Application Client Secret

  twikoo:
    env_id:         # Tencent Cloud environment id
    region:         # Environment region. If select Guangzhou, fill in "ap-guangzhou".
    version: 1.6.7  # Twikoo version, default use v1.6.7

  waline:
    server_url:     # Server URL
    reaction: false # Article reactions, Option values: true | false
    version: 2      # Waline version, default use v2
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

enable

enable 设置是否开启评论系统,可选值:truefalse

use

use 配置使用哪一款评论系统,可选值:valine | gitalk | twikoo | waline

yaml
use: valine  # values: valine | gitalk | twikoo | waline
1

valine

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

详情查看:

appid

appid 设置 LeanCloud 应用的 App ID

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

yaml
valine:
  appid: ih2nzxxxxxxxxxxxxxxxxxxxxxx
1
2

appkey

appkey 设置 LeanCloud 应用的 App Key

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

yaml
valine:
  appkey: gdf6xxxxxxxxxxxxxxxxxxxxx
1
2

placeholder

placeholder 可填,评论框的在还没输入内容时的显示的文本信息。

效果图

Valine 评论插件效果图。

image

gitalk

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

详情查看:

在 Keep 中如何使用:

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

    OAuth App 创建成功后,把 Client IDClient Secret 保存起来,下面要用到。

    image

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

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

    yaml
    gitalk:
      github_id: XPoet
      repository: hexo-site-comments
      client_id: cdfffffffffffffffffffff
      client_secret: f4b55555555555555555555555555555
    
    1
    2
    3
    4
    5
  4. Gitalk 评论插件效果图。 image

twikoo

Twikoo,一个简洁、安全、免费的静态网站评论系统,基于腾讯云开发。

详情查看:

env_id

env_id 是成功部署 Twikoo 评论系统的环境 ID。

参考 Twikoo 官方配置教程,获取 env_id 环境 ID,并填入主题配置项中。

yaml
twikoo:
  env_id: xxxxxxxxxxxxxxxxxx
1
2

region

参考 Twikoo 官方配置教程,获取 region,并填入主题配置项中。

yaml
twikoo:
  region: xxxxxxxxxxxxxxxxxx
1
2

version

version 设置 Twikoo 评论系统版本,Keep 主题内置使用 Twikoo v1.6.7,你可以自行更改。

yaml
twikoo:
  version: 1.6.7
1
2

注意

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

效果图

Twikoo 评论插件效果图。

image

waline

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

详情查看:

server_url

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

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

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

reaction

reaction 设置开启文章反应,可选值:truefalse

image

version

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

yaml
waline:
  version: 2
1
2

效果图

Waline 评论插件效果图

image

Released under the GPL-3.0 License