前言

Gitment 是作者imsun实现的一款基于 GitHub Issues 的评论系统。支持在前端直接引入,不需要任何后端代码。可以在页面进行登录、查看、评论、点赞等操作,同时有完整的 Markdown / GFM 和代码高亮支持。尤为适合各种基于 GitHub Pages 的静态博客或项目页面。

本博客评论系统已迁移至 Gitment,参考作者的介绍部署成功,不过这里补充详细点,方便新手入门。

Gitment是 jekyll 博客用的
最新的 hugo 已经改用 utteranc,不过仍然是用 issue 方式记录,跟 Gitment 原理一样

1、注册 OAuth Application

通过地址传送门申请配置,注册一个新的 OAuth Application,其他内容可以随意填写,但要确保填入正确的 callback URL(一般是评论页面对应的域名,如 https://anttutu.github.io)。 创建成功后,你会得到一个 client ID 和一个 client secret,这个将被用于之后的用户登录。

2、引入 Gitment

将下面的代码添加到你的页面:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
<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中配置好全局参数:

3、初始化评论

页面发布后,你需要访问页面并使用你的 GitHub 账号登录(请确保你的账号是第二步所填 repo 的 owner),点击初始化按钮。
之后其他用户即可在该页面发表评论

3.1 初始化

点击下初始化即可

3.2 正常

3.2 异常

图1 通常是repo或者owner配置不对,请细心检测Error:Not Found
图2 还有本地调测会出现callback不对,提示Error: Comments Not Initialized