收藏官网首页
查看: 2686|回复: 1

[分享] Gitment:使用 GitHub Issues 搭建评论系统

56

主题

144

帖子

1053

积分

金牌会员

Rank: 6Rank: 6

积分
1053
QQ
发表于 2017-6-22 23:15:48 | 显示全部楼层 |阅读模式
汉枫LPB120模块
Gitment:使用 GitHub Issues 搭建评论系统
发表于 2017-04-04 |  分类于 Web Dev

本以为自己都二十好几了,早就过了折腾博客系统的年龄,然而万万没想到多说倒闭了。
综合考虑了多家评论系统以后,我最终打算自己写一个。
Gitment 是作者实现的一款基于 GitHub Issues 的评论系统。支持在前端直接引入,不需要任何后端代码。可以在页面进行登录、查看、评论、点赞等操作,同时有完整的 Markdown / GFM 和代码高亮支持。尤为适合各种基于 GitHub Pages 的静态博客或项目页面。
本博客评论系统已迁移至 Gitment。虽然 Gitment 只能使用 GitHub 账号进行评论,但考虑到博客受众,这是可以接受的。
  • 项目地址
  • 示例页面
基础使用1. 注册 OAuth Application
点击此处 来注册一个新的 OAuth Application。其他内容可以随意填写,但要确保填入正确的 callback URL(一般是评论页面对应的域名,如 https://imsun.net)。
你会得到一个 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" >
<script src="https://imsun.github.io/gitment/dist/gitment.browser.js"></script>
<script>
var gitment = new Gitment({
  id: '页面 ID', // 可选。默认为 location.href
  owner: '你的 GitHub ID',
  repo: '存储评论的 repo',
  oauth: {
    client_id: '你的 client ID',
    client_secret: '你的 client secret',
  },
})
gitment.render('container')
</script>
注意,上述代码引用的 Gitment 将会随着开发变动。如果你希望始终使用最新的界面与特性即可引入上述代码。
如果你希望引用确定版本的 Gitment,则应该使用 npm 进行安装。
1
$ npm install --save gitment
关于构造函数中的更多可用参数请查看 Gitment Options
3. 初始化评论
页面发布后,你需要访问页面并使用你的 GitHub 账号登录(请确保你的账号是第二步所填 repo 的 owner),点击初始化按钮。
之后其他用户即可在该页面发表评论。
自定义
Gitment 很容易进行自定义,你可以写一份自定义的 CSS 或者使用一个新的主题。(主题可以改变 DOM 结构而自定义 CSS 不能)
比如你可以通过自定义主题将评论框放在评论列表前面:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
const myTheme = {
  render(state, instance) {
    const container = document.createElement('div')
    container.lang = "en-US"
    container.className = 'gitment-container gitment-root-container'
    container.appendChild(instance.renderHeader(state, instance))
    container.appendChild(instance.renderEditor(state, instance))
    container.appendChild(instance.renderComments(state, instance))
    container.appendChild(instance.renderFooter(state, instance))
    return container
  },
}

const gitment = new Gitment({
  // ...
  theme: myTheme,
})

gitment.render('container')
更多自定义内容请查看文档
其他问题语言问题
考虑到 GitHub 本身使用英文,而本项目面向用户均为 GitHub 用户,所以作者没有提供中文支持的打算。实在有需求的可以通过自定义主题支持中文。
请勿滥用
在开发这个项目时我就一直有一个疑虑:我这样做有没有滥用 GitHub?为此我仔细读了 GitHub Terms of Service中 API Terms 的部分,认为自己并没有违反协议。之后我向 GitHub 发邮件询问了这一问题。GitHub 给出的回复是:
We’re pleased to see you making use of the tools and resources available on GitHub.
因此本项目的确没有违反 GitHub 使用协议。但我还是想提醒使用本项目的用户,请保持克制,切勿滥用。
样式版权
在项目开源前作者曾实现了一个像素级抄袭 GitHub Issues 样式的界面,但在阅读 ToS 时发现违反了 Section F,并在和 GitHub 邮件沟通的过程中确认了这一行为是侵权的。因此便改成了现在的样式。请其他想要自定义样式的用户也留意版权问题。
原文:https://imsun.net/posts/gitment-introduction/




您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

加入Q群 返回顶部

© 2006-2022 Gizwits IoT Technology Co., Ltd. ( 粤ICP备11090211号 )

快速回复 返回顶部 返回列表