如何经过Gitalk评论插件,5分钟为你的博客快速集成评论功能

欢迎关注我的微信公众号: 小哈学Java, 文末分享阿里 P8 高级架构师吐血总结的 《Java 核心知识整理&面试.pdf》资源连接!!javascript

我的网站: https://www.exception.site/essay/how-to-install-gitalk-on-your-blogcss

Gitalk评论插件,为你的博客快速集成评论功能

小哈以前有给你们分享如何给本身的个站快速集成聊天室功能,新关注的小伙伴可参考:《黑科技!仅需 3 行代码,就能将 Gitter 集成到我的网站中,实现一个 IM 即时通信聊天室功能?》html

集成完了聊天室,是否是感受还少了什么?今天给你们分享一下,如何经过 Gitalk 快速集成评论功能。java

目录

  • 1、什么是 Gitalkreact

  • 2、Gitalk 特性git

  • 3、为何要使用 Gitalkgithub

  • 4、Gitalk 安装web

  • 5、为你的个站集成 Gitalk面试

  • 6、你可能会碰到的坑npm

  • 7、最终效果

1、什么是 Gitalk

Gitalk 的官方网站地址是: https://gitalk.github.io

Gitalk

小哈截图的时候,Star 数已经达到 2000+ 了,那它究竟是个什么玩意呢?来自官方的解释:

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

2、Gitalk 特性

  • 使用 GitHub 登陆
  • 支持多语言 [en, zh-CN, zh-TW, es-ES, fr, ru]
  • 支持我的或组织
  • 无干扰模式(设置 distractionFreeMode 为 true 开启)
  • 快捷键提交评论 (cmd|ctrl + enter)

3、为何要使用 Gitalk

其实国内也有不少易于集成的评论插件,如多说、友言等。国外呢,用的比较多的就是 Dispus 了。这其中小哈使用过的有多说和 Dispus。

先说说 Dispus, 因为服务器架设在国外,访问速度首先是个问题,第二个就是注册了,界面全英文,对一些小白想要快速集成评论功能的,也是至关不友好的;另外,Dispus 仅支持国外一些社交帐号登陆,如 Fackbook, Google, Twritter 等,我想你的我的博客必定仍是国内用户访问多些,选它的话,须要思量一下了。

固然,追求逼格,当我没说,哈哈!

当我没说

在来讲说国内的多说、友言,集成很方便,因为在国内,访问速度也是棒棒哒。而它们支持国内各类社交帐号登陆,如 QQ,微博等。也正是由于留言的门槛低了,致使了一些素质较低的键盘侠随意登陆评论,你可能花了很长时间写的一篇博文,他们评论两个字:傻X ! 就给你怼的怀疑人生!

因此小哈选择了 Gitalk, 它限制了只有 GitHub 用户才能登陆评论,还世界一片清净,哈哈!

4、Gitalk 安装

Gitalk 安装有两种方式:

  • 直接引入
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/gitalk@1/dist/gitalk.css">
<script src="https://cdn.jsdelivr.net/npm/gitalk@1/dist/gitalk.min.js"></script>

<!-- or -->

<link rel="stylesheet" href="https://unpkg.com/gitalk/dist/gitalk.css">
<script src="https://unpkg.com/gitalk/dist/gitalk.min.js"></script>
  • npm 安装
npm i --save gitalk
import 'gitalk/dist/gitalk.css'
import Gitalk from 'gitalk'

5、为你的个站集成 Gitalk

首先,添加一个 div 容器:

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

添加下面的 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,      // 请确保你的 location 链接小于 50 个字符,不然,插件会生成失败
  distractionFreeMode: false  // 专一模式
})

gitalk.render('gitalk-container')

看完上面这段 javascripte 代码,你确定很疑惑,clientID、clientSecret 是个啥?

别急!你须要先申请 GitHub Application,没有的话,经过这个网址去申请:https://github.com/settings/applications/new, 跳转页面以下:

Github OAuth 应用注册

点击注册:

填写好 clientIDclientSecret, 你还须要单独新建一个仓库,或者一个你已经建立好的仓库名称到 repo 项中。owneradmin 填写你的我的 ID 便可。

Github 我的ID

最终,下哈的填写的参数以下,小伙伴们根据本身我的状况填写本身的:

var gitalk = new Gitalk({
    clientID: '6b60cd90107d766',
    clientSecret: 'aaef1f960ce2a61393b8f173b672b',
    repo: 'weiwosuoai.github.io',
    owner: 'weiwosuoai',
    admin: ['weiwosuoai'],
    id: location.pathname,
    distractionFreeMode: false
})

6、你可能会碰到的坑

6.1 未找到相关的issue评论,请联系xxx初始化建立

出现这总状况是由于博主未给文章评论初始化,博主只须要登陆 GitHub 帐户便可。若是你登陆后,返回了首页,说明你的配置可能有问题,再检查一下 gitalk 个项参数是否正确。

6.2 Error: Not Found.

未能正确找到仓库 repo,检查一下你的仓库是否配置正确。

6.3 Error: Validation Failed.

发生这种状况,是由于 GitHub 对 Issue 的 label 存在限制,不能超过 50 个字符。

PS: label 标签就是文章页面的连接地址,若是地址过长,会致使加载 Gitalk 插件失败。

小哈的解决版本是,对 localtion.pathname 作了一个截取,只取 50 个字符:

// 截取字符串
var title = location.pathname.substr(0, 50);
var gitalk = new Gitalk({
    clientID: '6b60cd9017d766',
    clientSecret: 'aaef1f960ce2a6c0bec583e1e1393b8',
    repo: 'weiwosuoai.github.io',
    owner: 'weiwosuoai',
    admin: ['weiwosuoai'],
    id: title,
    distractionFreeMode: false
})

还有另一些解决方案,如 MD5 等。可参考连接:https://github.com/gitalk/gitalk/issues/102

7、最终效果

好了,到这里,坑基本上都踩完了,让咱们来看看最终的效果咋样!

怎么样,还不错哟,赶快集成到你的我的博客当中去吧。

免费分享 | 面试&学习福利资源

最近在网上发现一个不错的 PDF 资源《Java 核心知识&面试.pdf》分享给你们,不光是面试,学习,你都值得拥有!!!

获取方式: 关注公众号: 小哈学Java, 后台回复资源,既可免费无套路获取资源连接,下面是目录以及部分截图:

关注微信公众号【小哈学Java】,回复【资源】,便可免费无套路领取资源连接哦

关注微信公众号【小哈学Java】,回复【资源】,便可免费无套路领取资源连接哦

关注微信公众号【小哈学Java】,回复【资源】,便可免费无套路领取资源连接哦

关注微信公众号【小哈学Java】,回复【资源】,便可免费无套路领取资源连接哦

关注微信公众号【小哈学Java】,回复【资源】,便可免费无套路领取资源连接哦

关注微信公众号【小哈学Java】,回复【资源】,便可免费无套路领取资源连接哦

重要的事情说两遍,关注公众号: 小哈学Java, 后台回复资源,既可免费无套路获取资源连接 !!!

相关文章
相关标签/搜索