建站第十二篇 Hugo博客使用giscus作为评论系统

原文传送门

在前面的系列文章中,我们成功的利用Github Pages搭建了基于hugo生成的博客站,并且可以通过Github Action实现CI/CD。
随着博文的不断更新,势必有一天会出现读者希望通过评论直接与作者沟通的需求,我们写博文的目的之一就是希望与更大范围的人建立联结。因此,评论系统成为了刚需。

选型giscus

希望以最小代价上手,我选择评论系统的依据如下:

  1. 越轻越好,尽量不需要自建服务,如果可以和Github Pages整合最好。
  2. 配置越简单越好。
  3. 当前使用的主题很容易支持。

我当前选择的Hugo主题是Clean White Theme for Hugo, 目前支持三种评论系统,分别是GiscusDisqusTwikoo

Giscus

Giscus 是由 GitHub Discussions 驱动的评论系统,与GitHub Pages有非常好的天然联结。根据官网,Giscus的特性有:

  • 开源。
  • 无跟踪,无广告,永久免费。
  • 无需数据库。全部数据均储存在 GitHub Discussions 中。
  • 支持自定义主题!
  • 支持多种语言。
  • 高度可配置。
  • 自动从 GitHub 拉取新评论与编辑。
  • 可自建服务!

Clean White Theme for Hugo 主题配置Giscus只需要在config.toml中加上一段配置:

[params.giscus]
    data_repo="your GitHub repo"
    data_repo_id="your repo id"
    data_category="your category"
    data_category_id="your category id"
    data_mapping="pathname"
    data_reactions_enabled="1"
    data_emit_metadata="0"
    data_theme="light"
    data_lang="en"
    crossorigin="anonymous"

Disqus

Disqus 目前最主流的第三方社会化评论系统,主要为网站主提供评论托管服务。简单易用,功能丰富。但官方对于免费版会自带很多广告推广,不清爽。

Twikoo

Twikoo 是基于腾讯云服务的评论系统,官方自称为一个简洁、安全、免费的静态网站评论系统。
对于国内网站来说,确实可以提供很丰富的功能,包括微信和QQ的即时提醒,以及评论检测和审核功能。额,所以呢,还是弃用吧。

最终,我选择了主题所支持的Giscus 作为自己的评论系统。

原理

Giscus 加载时,会使用 GitHub Discussions 搜索 API 根据选定的映射方式(如 URL、pathname、<title> 等)来查找与当前页面关联的 discussion。如果找不到匹配的 discussiongiscus bot 就会在第一次有人留下评论或回应时自动创建一个 discussion

要评论,访客必须按 GitHub OAuth 流程授权 giscus app 代表他发帖。或者访客也可以直接在 GitHub Discussion 里评论。你可以在 GitHub 上管理评论。

配置过程

Giscus 官网提供了配置参数生成的功能。你可以通过各种选择获得配置参数,并且按提示安装giscus app以及开启Discussions功能。

这里需要注意的地方是,仓库要选择Github Pages项目,这样开启的Discussions功能才能正常使用。

对于Clean White Theme for Hugo 主题,最重要的4个参数,分别是:data-repodata-repo-iddata-categorydata-category-id。我生成的配置参数如下所示:

<script src="https://giscus.app/client.js"
        data-repo="DeeWooo/DeeWooo.github.io"
        data-repo-id="**************************"
        data-category="Announcements"
        data-category-id="*********************"
        data-mapping="pathname"
        data-strict="0"
        data-reactions-enabled="1"
        data-emit-metadata="0"
        data-input-position="bottom"
        data-theme="preferred_color_scheme"
        data-lang="zh-CN"
        crossorigin="anonymous"
        async>
</script>

最终,我在主题示例的配置参数中只修改了data-repodata-repo-iddata-categorydata-category-id4个参数的值,在config.toml文件最后,加上了下面一段配置:

[params.giscus]
    data_repo="DeeWooo/DeeWooo.github.io"
    data-repo-id="**************************"    
    data_category="Announcements"
    data_category_id="*********************"
    data_mapping="pathname"
    data_reactions_enabled="1"
    data_emit_metadata="0"
    data_theme="light"
    data_lang="en"
    crossorigin="anonymous"

这样就完成了Giscus的配置。

效果

在每个博文页面下,都出现了评论框


image.png

参考文章

  1. giscus官网,https://giscus.app/zh-CN
  2. Clean White Theme for Hugo,https://github.com/zhaohuabing/hugo-theme-cleanwhite

>
本作品由 IvyWooo 采用知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议 进行许可,转载请注明出处。 本文链接

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,254评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,875评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,682评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,896评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,015评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,152评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,208评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,962评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,388评论 1 304
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,700评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,867评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,551评论 4 335
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,186评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,901评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,142评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,689评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,757评论 2 351

推荐阅读更多精彩内容