Gitalk评论插件使用教程

1. Gitalk说明

Gitalk 是一个基于 GitHub Issue 和 Preact 开发的评论插件。

Gitalk 的特性：

1、使用 GitHub 登录

2、支持多语言 [en, zh-CN, zh-TW, es-ES, fr, ru]

3、支持个人或组织

4、无干扰模式（设置 distractionFreeMode 为 true 开启）

5、快捷键提交评论 （cmd|ctrl + enter）

2. 安装使用

2.1 安装

两种方式引入：

1、直接在HTML文件中引入

<link rel="stylesheet" href="https://unpkg.com/gitalk/dist/gitalk.css">
<script src="https://unpkg.com/gitalk/dist/gitalk.min.js"></script>

建议直接把文件下载后放在项目目录中，这样就可以不再依赖第三方网络了。

2、通过npm安装

npm i --save gitalk

import 'gitalk/dist/gitalk.css'
import Gitalk from 'gitalk'

2.2 使用

1、首先需要在html文件中添加一个容器，Gitalk组件会在此处显示

<div id="gitalk-container"></div>

2、使用下面的JavaScript代码来生成Gitalk评论：

var gitalk = new Gitalk({
  clientID: 'GitHub Application Client ID',
  clientSecret: 'GitHub Application Client Secret',
  repo: 'GitHub repo',
  owner: 'GitHub repo owner',
  admin: ['GitHub repo owner and collaborators, only these guys can initialize github issues'],
  id: location.pathname,      // 确保唯一，并且长度小于50
  distractionFreeMode: false  // 类似Facebook评论框的全屏遮罩效果.
})

gitalk.render('gitalk-container')

里面参数下面会讲解.

配置好后，页面最终效果( https://gitalk.github.io/) ：

3. new Gitalk 的参数说明