天天看點

Gitment

Gitment 是作者imsun實作的一款基于 GitHub Issues 的評論系統。支援在前端直接引入,不需要任何後端代碼。可以在頁面進行登入、檢視、評論、點贊等操作,同時有完整的 Markdown / GFM 和代碼高亮支援。尤為适合各種基于 GitHub Pages 的靜态部落格或項目頁面。

本部落格評論系統已遷移至 Gitment,參考作者的介紹部署成功,不過這裡補充詳細點,友善新手入門。

1、注冊 OAuth Application

通過位址傳送門申請配置,注冊一個新的 OAuth Application,其他内容可以随意填寫,但要確定填入正确的 callback URL(一般是評論頁面對應的域名,如 https://anttutu.github.io)。

Gitment

建立成功後,你會得到一個 client ID 和一個 client secret,這個将被用于之後的使用者登入。

Gitment

2、引入 Gitment

将下面的代碼添加到你的頁面:

<div id="container"></div>
<link rel="stylesheet" href="https://imsun.github.io/gitment/style/default.css">
<script src="https://imsun.github.io/gitment/dist/gitment.browser.js"></script>
<script>
var gitment = new Gitment({
  id: '頁面 ID', // 可選。預設為 location.href  比如我本人的就删除了
  owner: '你的 GitHub Name',              //比如我的叫anTtutu
  repo: '存儲評論的 repo',                 //比如我的叫anTtutu.github.io
  oauth: {
    client_id: '你的 client ID',          //比如我的828***********
    client_secret: '你的 client secret',  //比如我的49e************************
  },
})
gitment.render('container')
</script>
           

為了靈活,我在_config.yml中配置好全局參數:

Gitment

3、初始化評論

頁面釋出後,你需要通路頁面并使用你的 GitHub 賬号登入(請確定你的賬号是第二步所填 repo 的 owner),點選初始化按鈕。

之後其他使用者即可在該頁面發表評論

初始化:點選下初始化即可

Gitment

正常:

Gitment
Gitment

異常:通常是repo或者owner配置不對,請細心檢測Error:Not Found 圖1。還有本地調測會出現callback不對提示Error: Comments Not Initialized 圖2

Gitment
Gitment