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的參數說明