NexT主题中集成gitalk评论系统

发表于 | 分类于 |

本文记录NexT主题中添加gitalk评论系统的步骤。
gitalk：一个基于 Github Issue 和 Preact 开发的评论插件
详情Demo可见：https://gitalk.github.io/

1. Register Application

在GitHub上注册新应用，链接：https://github.com/settings/applications/new
app
参数说明：
Application name： # 应用名称，随意Introspelliam.github.io
Homepage URL： # 网站URL，如https://Introspelliam.github.io
Application description # 描述，随意
Authorization callback URL：# 网站URL，https://Introspelliam.github.io

点击注册后，页面跳转如下，其中Client ID和Client Secret在后面的配置中需要用到，到时复制粘贴即可：
client

2. gitalk.swig

新建/layout/_third-party/comments/gitalk.swig文件，并添加内容：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{% if page.comments && theme.gitalk.enable %}
  <link rel="stylesheet" href="https://unpkg.com/gitalk/dist/gitalk.css">
  <script src="https://unpkg.com/gitalk/dist/gitalk.min.js"></script>
   <script type="text/javascript">
        var gitalk = new Gitalk({
          clientID: '{{ theme.gitalk.ClientID }}',
          clientSecret: '{{ theme.gitalk.ClientSecret }}',
          repo: '{{ theme.gitalk.repo }}',
          owner: '{{ theme.gitalk.githubID }}',
          admin: ['{{ theme.gitalk.adminUser }}'],
          id: location.pathname,
          distractionFreeMode: '{{ theme.gitalk.distractionFreeMode }}'
        })
        gitalk.render('gitalk-container')           
       </script>
{% endif %}

3. comments.swig

修改/layout/_partials/comments.swig，添加内容如下，与前面的elseif同一级别上：

1
2
{% elseif theme.gitalk.enable %}
 <div id="gitalk-container"></div>

4. index.swig

修改layout/_third-party/comments/index.swig，在最后一行添加内容：

1
{% include 'gitalk.swig' %}

5. gitalk.styl

新建/source/css/_common/components/third-party/gitalk.styl文件，添加内容：

1
2
3
4
.gt-header a, .gt-comments a, .gt-popup a
  border-bottom: none;
.gt-container .gt-popup .gt-action.is--active:before
  top: 0.7em;

6. third-party.styl

修改/source/css/_common/components/third-party/third-party.styl，在最后一行上添加内容，引入样式：

1
@import "gitalk";

7. _config.yml

在主题配置文件next/_config.yml中添加如下内容：

1
2
3
4
5
6
7
8
gitalk:
  enable: true
  githubID: github帐号  # 例：Introspelliam   
  repo: 仓库名称   # 例：Introspelliam.github.io
  ClientID: Client ID
  ClientSecret: Client Secret
  adminUser: github帐号 #指定可初始化评论账户
  distractionFreeMode: true

以上就是NexT中添加gitalk评论的配置，博客上传到GitHub上后，打开页面进入某一博客内容下，就可看到评论处。

8. Error: Validation Failed.

这是因为中文导致的问题。

HTTP 编码为 422，大家应该都已经知道了这个问题的原因：文章的 URL 过长，生成 issue 时超过了 label 的长度限制

网上随便找了找，用的是这个JavaScript-MD5

对gitalk.swig进行了修改

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{% if page.comments && theme.gitalk.enable %}
  <link rel="stylesheet" href="https://unpkg.com/gitalk/dist/gitalk.css">
  <script src="https://unpkg.com/gitalk/dist/gitalk.min.js"></script>
  <script src="{{ site.baseurl }}/js/md5.min.js"></script>
   <script type="text/javascript">
        var gitalk = new Gitalk({
          clientID: '{{ theme.gitalk.ClientID }}',
          clientSecret: '{{ theme.gitalk.ClientSecret }}',
          repo: '{{ theme.gitalk.repo }}',
          owner: '{{ theme.gitalk.githubID }}',
          admin: ['{{ theme.gitalk.adminUser }}'],
          id: md5(location.pathname),
          distractionFreeMode: '{{ theme.gitalk.distractionFreeMode }}'
        })
        gitalk.render('gitalk-container')
       </script>
{% endif %}

其中加了一句话：导入本地的md5.min.js

修改了id: 将location.pathname进行了md5