Merge pull request #894 from pai233/dev

Feat: 添加Remark42评论系统支持

README.md

@@ -79,7 +79,7 @@ npm i hexo-theme-butterfly
 - [x] Related articles
 - [x] Displays outdated notice for a post
 - [x] Share (AddThis/Sharejs/Addtoany)
-- [X] Comment (Disqus/Disqusjs/Livere/Gitalk/Valine/Waline/Utterances/Facebook Comments/Twikoo/Giscus)
+- [X] Comment (Disqus/Disqusjs/Livere/Gitalk/Valine/Waline/Utterances/Facebook Comments/Twikoo/Giscus/Remark42)
 - [x] Multiple Comment System Support
 - [x] Online Chats (Chatra/Tidio/Daovoice/Gitter/Crisp)
 - [x] Web analytics

README_CN.md

@@ -79,7 +79,7 @@ theme: butterfly
 - [x] 顯示相關文章
 - [x] 過期文章提醒
 - [x] 多種分享系統（AddThis/Sharejs/Addtoany）
-- [X] 多種評論系統（Disqus/Disqusjs/Livere/Gitalk/Valine/Waline/Utterances/Facebook Comments/Twikoo/Giscus）
+- [X] 多種評論系統（Disqus/Disqusjs/Livere/Gitalk/Valine/Waline/Utterances/Facebook Comments/Twikoo/Giscus/Remark42）
 - [x] 支持雙評論部署
 - [x] 多種在線聊天（Chatra/Tidio/Daovoice/Gitter/Crisp）
 - [x] 多種分析系統

_config.yml

@@ -259,7 +259,7 @@ addtoany:
 
 comments:
   # Up to two comments system, the first will be shown as default
-  # Choose: Disqus/Disqusjs/Livere/Gitalk/Valine/Waline/Utterances/Facebook Comments/Twikoo/Giscus
+  # Choose: Disqus/Disqusjs/Livere/Gitalk/Valine/Waline/Utterances/Facebook Comments/Twikoo/Giscus/Remark42
   use: # Valine,Disqus
   text: true # Display the comment name next to the button
   # lazyload: The comment system will be load when comment element enters the browser's viewport.
@@ -354,6 +354,13 @@ giscus:
     dark: dark
   option:
 
+# Remark42
+# https://remark42.com/docs/configuration/frontend/
+remark42:
+  host: # Your Host URL
+  siteId: # Your Site ID
+  option:
+
 # Chat Services
 # --------------------------------------
 

layout/includes/header/post-info.pug

@@ -123,4 +123,8 @@
           when 'Facebook Comments'
             +countBlock
               a(href=url_for(page.path) + '#post-comment')
-                span.fb-comments-count(data-href=urlNoIndex())
+                span.fb-comments-count(data-href=urlNoIndex())
+          when 'Remark42'
+            +countBlock
+              a(href=url_for(page.path) + '#post-comment')
+                span.remark42__counter(data-url=urlNoIndex())

layout/includes/mixins/post-ui.pug

@@ -91,6 +91,10 @@ mixin postUI(posts)
                 +countBlockInIndex
                   a(href=url_for(link) + '#post-comment')
                     span.fb-comments-count(data-href=urlNoIndex(article.permalink))
+              when 'Remark42'
+                +countBlockInIndex
+                  a(href=url_for(link) + '#post-comment')
+                    span.remark42__counter(data-url=urlNoIndex(article.permalink))
 
         //- Display the article introduction on homepage
         case theme.index_post_content.method

layout/includes/third-party/card-post-count/index.pug

@@ -9,4 +9,6 @@ case theme.comments.use[0]
   when 'Waline'
     include ./waline.pug
   when 'Facebook Comments'
-    include ./fb.pug
+    include ./fb.pug
+  when 'Remark42'
+    include ./remark42.pug

layout/includes/third-party/card-post-count/remark42.pug

@@ -0,0 +1,18 @@
+- const { host, siteId, option } = theme.remark42
+
+script.
+  (()=>{
+    window.remark_config = Object.assign({
+      host: '!{host}',
+      site_id: '!{siteId}',
+    },!{JSON.stringify(option)})
+
+    function getCount () {
+      const s = document.createElement('script')
+      s.src = remark_config.host + '/web/counter.js'
+      s.defer = true
+      document.head.appendChild(s)
+    }
+
+    window.pjax ? getCount() : window.addEventListener('load', getCount)
+  })()

layout/includes/third-party/comments/index.pug

@@ -40,3 +40,5 @@ hr
                         data-numposts= theme.facebook_comments.pageSize || 10
                         data-order-by= theme.facebook_comments.order_by || 'social'
                         data-width="100%")
+          when 'Remark42'
+            #remark42

layout/includes/third-party/comments/js.pug

@@ -20,3 +20,5 @@ each name in theme.comments.use
       !=partial('includes/third-party/comments/giscus', {}, {cache: true})
     when 'Facebook Comments'
       !=partial('includes/third-party/comments/facebook_comments', {}, {cache: true})
+    when 'Remark42'
+      !=partial('includes/third-party/comments/remark42', {}, {cache: true})

layout/includes/third-party/comments/remark42.pug

@@ -0,0 +1,67 @@
+- const { host, siteId, option } = theme.remark42
+script.
+  var remark_config = Object.assign({
+    host: '!{host}',
+    site_id: '!{siteId}',
+    components: ['embed'],
+    theme: document.documentElement.getAttribute('data-theme') === 'dark' ? 'dark' : 'light'
+  },!{JSON.stringify(option)})
+
+  function addRemark42(){
+    for (let i = 0; i < remark_config.components.length; i++) {
+      const s = document.createElement('script')
+      s.src = remark_config.host + '/web/' + remark_config.components[i] + '.js'
+      s.defer = true
+      document.head.appendChild(s)
+    }
+  }
+
+  function initRemark42() {
+    if (window.REMARK42) {
+      if (this.remark42Instance) {
+        this.remark42Instance.destroy()
+      }
+
+      this.remark42Instance = window.REMARK42.createInstance({
+        ...remark_config
+      })
+    }
+  }
+
+  function getCount () {
+    const ele = document.querySelector('.remark42__counter')
+    if (ele) {
+      const s = document.createElement('script')
+      s.src = remark_config.host + '/web/counter.js'
+      s.defer = true
+      document.head.appendChild(s)
+    }
+  }
+
+  function loadRemark42 () {
+    if (window.REMARK42) {
+      this.initRemark42()
+      getCount()
+    } else {
+      addRemark42()
+      window.addEventListener('REMARK42::ready', () => {
+        this.initRemark42()
+        getCount()
+      })
+    }
+  }
+
+  document.getElementById('darkmode').addEventListener('click',()=>{
+    if (!window.REMARK42) return
+    let theme = document.documentElement.getAttribute('data-theme') === 'dark' ? 'light' : 'dark'
+    window.REMARK42.changeTheme(theme)
+  })
+
+  if ('!{theme.comments.use[0]}' === 'Remark42' || !!{theme.comments.lazyload}) {
+    if (!{theme.comments.lazyload}) btf.loadComment(document.getElementById('remark42'), loadRemark42)
+    else loadRemark42()
+  } else {
+    function loadOtherComment () {
+      loadRemark42()
+    }
+  }

layout/includes/third-party/newest-comments/index.pug

@@ -23,4 +23,6 @@ if use
       include ./github-issues.pug
     when 'Utterances'
       - userRepo = theme.utterances.repo
-      include ./github-issues.pug
+      include ./github-issues.pug
+    when 'Remark42'
+      include ./remark42.pug  

layout/includes/third-party/newest-comments/remark42.pug

@@ -0,0 +1,80 @@
+- const { host, siteId } = theme.remark42
+
+script.
+  window.addEventListener('load', () => {
+    const changeContent = (content) => {
+      if (content === '') return content
+
+      content = content.replace(/<img.*?src="(.*?)"?[^\>]+>/ig, '[!{_p("aside.card_newest_comments.image")}]') // replace image link
+      content = content.replace(/<a[^>]+?href=["']?([^"']+)["']?[^>]*>([^<]+)<\/a>/gi, '[!{_p("aside.card_newest_comments.link")}]') // replace url
+      content = content.replace(/<pre><code>.*?<\/pre>/gi, '[!{_p("aside.card_newest_comments.code")}]') // replace code
+      content = content.replace(/<[^>]+>/g,"") // remove html tag
+
+      if (content.length > 150) {
+        content = content.substring(0,150) + '...'
+      }
+      return content
+    }
+
+    const generateHtml = array => {
+      let result = ''
+
+      if (array.length) {
+        for (let i = 0; i < array.length; i++) {
+          result += '<div class=\'aside-list-item\'>'
+
+          if (!{theme.newest_comments.avatar}) {
+            const name = '!{theme.lazyload.enable ? "data-lazy-src" : "src"}'
+            result += `<a href='${array[i].url}' class='thumbnail'><img ${name}='${array[i].avatar}' alt='${array[i].nick}'></a>`
+          }
+
+          result += `<div class='content'>
+          <a class='comment' href='${array[i].url}' title='${array[i].content}'>${array[i].content}</a>
+          <div class='name'><span>${array[i].nick} / </span><time datetime="${array[i].date}">${btf.diffDate(array[i].date, true)}</time></div>
+          </div></div>`
+        }
+      } else {
+        result += '!{_p("aside.card_newest_comments.zero")}'
+      }
+
+      let $dom = document.querySelector('#card-newest-comments .aside-list')
+      $dom.innerHTML= result
+      window.lazyLoadInstance && window.lazyLoadInstance.update()
+      window.pjax && window.pjax.refresh($dom)
+    }
+
+    const getComment = () => {
+      fetch('!{host}/api/v1/last/!{theme.newest_comments.limit}?site=!{siteId}')
+        .then(response => response.json())
+        .then(data => {
+          const remark42 = data.map(function (e) {
+            return {
+              'avatar': e.user.picture,
+              'content': changeContent(e.text),
+              'nick': e.user.name,
+              'url': e.locator.url,
+              'date': e.time,
+            }
+          })
+          saveToLocal.set('remark42-newest-comments', JSON.stringify(remark42), !{theme.newest_comments.storage}/(60*24))
+          generateHtml(remark42)
+        }).catch(e => {
+          const $dom = document.querySelector('#card-newest-comments .aside-list')
+          $dom.innerHTML= "!{_p('aside.card_newest_comments.error')}"
+        })
+    }
+
+    const newestCommentInit = () => {
+      if (document.querySelector('#card-newest-comments .aside-list')) {
+        const data = saveToLocal.get('valine-newest-comments')
+        if (data) {
+          generateHtml(JSON.parse(data))
+        } else {
+          getComment()
+        }
+      }
+    }
+
+    newestCommentInit()
+    document.addEventListener('pjax:complete', newestCommentInit)
+  })