建站第十二篇 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閱讀 229,237評論 6 537
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,957評論 3 423
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 177,248評論 0 382
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,356評論 1 316
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,081評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,485評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,534評論 3 444
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,720評論 0 289
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,263評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,025評論 3 356
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,204評論 1 371
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,787評論 5 362
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,461評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,874評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,105評論 1 289
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,945評論 3 395
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,205評論 2 375

推薦閱讀更多精彩內容