feat: 支持 utterances 为评论系统

Author: anig1scur

README.en.md

@@ -6,14 +6,14 @@
 
 ## Table of Contents
 
-- [How to use](#How to use)
-  - [Install](#Install)
-  - [Configuration Item](#Configuration Item)
-- [Effect Preview](#Effect Preview)
-- [update](#update)
-- [Portable Version](#Portable Version)
+- [How to use](#how-to-use)
+    - [Installation](#installation)
+    - [Configuration items](#configuration-items)
+- [Effect preview](#effect-preview)
+- [Update](#update)
+- [Porting version](#porting-version)
 - [Todo](#todo)
-- [Participation](#Participation)
+- [Participate](#participate)
 - [LICENCE](#licence)
 
 Created by [gh-md-toc](https://github.com/ekalinin/github-markdown-toc)
@@ -140,15 +140,23 @@ social:
 - Comment module configuration
 
 ```bash
-# Commend module
+# comment module
 comment:
   enable: false # true to enable
+  type: valine # value: valine | utterances
+
+  # valine params
   appId: your-app-id
   appKey: your-app-key
   placeholder: say something
   notify: false
   verify: false
   avatar: mp
+
+  # utterances (https://utteranc.es/) params
+  repo: your github repo path which supports comment
+  issue_term: your issue term
+  theme: comment theme
 ```
 
 - Open math formula

README.md

@@ -11,8 +11,8 @@
 ## 目录
 
 - [如何使用](#如何使用)
-  - [安装](#安装)
-  - [配置项](#配置项)
+    - [安装](#安装)
+    - [配置项](#配置项)
 - [效果预览](#效果预览)
 - [update](#update)
 - [移植版](#移植版)
@@ -144,15 +144,23 @@ social:
 - 评论模块配置
 
 ```bash
-# commend module
+# comment module
 comment:
-  enable: false # true to enable
+  enable: false
+  type: valine # valine | utterances
+
+  # valine 需要的参数
   appId: your-app-id
   appKey: your-app-key
   placeholder: say something
   notify: false
   verify: false
   avatar: mp
+
+  # utterances (https://utteranc.es/) 需要的参数
+  repo: your-repo-name
+  issue_term: your-issue-term
+  theme: your-comment-theme
 ```
 
 - 开启数学公式

_config.yml

@@ -43,12 +43,20 @@ main_color: default # forest | grass | sky | sun | sea
 # google Analytics
 google_analytics_id: xx-xxxxxxx-xx
 
-# commend module
+# comment module
 comment:
   enable: false
+  type: valine # valine | utterances
+
+  # valine 需要的参数
   appId: your-app-id
   appKey: your-app-key
   placeholder: say something
   notify: false
   verify: false
   avatar: mp
+
+  # utterances (https://utteranc.es/) 需要的参数
+  repo: your-repo-name
+  issue_term: your-issue-term
+  theme: your-comment-theme

layout/includes/comments.pug

@@ -0,0 +1,5 @@
+case theme.comment.type
+    when 'valine'
+        include ./scripts/valine-comment
+    when 'utterances'
+        include ./scripts/utterances-comment

layout/includes/layout.pug

@@ -6,7 +6,8 @@
 -     if (is_category()) pageTitle = 'Category: ' + page.category
 -     if (is_month()) pageTitle += ': ' + page.month + '/' + page.year
 -     if (is_year()) pageTitle += ': ' + page.year
--     pageTitle += ' [ ' + config.title + ' ] '
+-     if (pageTitle == '') return config.title
+-      pageTitle += ' - ' + config.title
 -     return pageTitle
 - }
 
@@ -57,7 +58,6 @@ html(lang=config.language)
         script(src=url defer)
 
     include ./scripts/google-analytics-script
-    include ./scripts/comments-script
     include ./scripts/toc-script
     include ./scripts/math-script
 

layout/includes/scripts/comments-script.pug

@@ -0,0 +1,5 @@
+script(src="https://utteranc.es/client.js"
+      repo=`${theme.comment.repo}`
+      issue-term=`${theme.comment.issue_term}`
+      theme=`${theme.comment.theme}`
+      crossorigin="anonymous" async)

layout/includes/scripts/utterances-comment.pug

@@ -0,0 +1,14 @@
+#comments
+script(src="https://www.unpkg.com/valine/dist/Valine.min.js" defer)
+script.
+  window.addEventListener('DOMContentLoaded', () => {
+    new Valine({
+      el: '#comments',
+      appId: '#{theme.comment.appId}',
+      appKey: '#{theme.comment.appKey}',
+      notify: #{theme.comment.notify},
+      verify: #{theme.comment.notify},
+      avatar: '#{theme.comment.avatar}',
+      placeholder: '#{theme.comment.placeholder}',
+    })
+  })

layout/includes/scripts/valine-comment.pug

@@ -19,6 +19,6 @@ block content
     .main__bottom
       include includes/pre-next.pug
       if page.content && theme.comment && theme.comment.enable
-        #comments
+        include includes/comments