hexo-theme-particlex 2.5.6 → 2.5.7

package/README.md

@@ -66,11 +66,14 @@ theme: particlex
 ## 配置
 
 ```yaml
-avatar:
+# Avatar image
+avatar: /images/avatar.jpg
 
+# Home page info block
 headBlockEnable: true
 
-background:
+# Home page background image
+background: /images/background.jpg
 ```
 
 其中 Background 可以是一个列表，打开时会随机加载一个背景
@@ -80,6 +83,10 @@ background:
     为了方便，主题使用的图标是 Font Awesome 6 图标
 
     ```yaml
+    # ParticleX theme icon is adopts the Font Awesome 6
+    # https://fontawesome.com
+
+    # Main menu navigation
     menu:
         Home:
             name: house
@@ -101,21 +108,18 @@ background:
             name: tags
             theme: solid
             link: /tags
-        # <name>:
-        #     name: <icon-name>
-        #     theme: <icon-theme>
-        #     link: <link-url>
     ```
 
 -   主页信息卡片
 
-    和导航栏差不多
-
     `description` 支持 Markdown 格式
 
+    图标链接配置和导航栏配置相同
+
     **如果图标链接或友链为空，请在 `iconLinks:` 或 `friendLinks:` 后添加一个 `{}`**
 
     ```yaml
+    # Side info card
     card:
         enable: true
         description: |
@@ -123,26 +127,8 @@ background:
             ...
         iconLinks:
             {}
-            # <name>:
-            #    name: <icon-name>
-            #    theme: <icon-theme>
-            #    link: <link-url>
         friendLinks:
-            {}
-            # <name>: <link-url>
-    ```
-
--   文档缩略
-
-    一般来说，缩略展示文档只需要在文档中添加 `<!-- more -->` 即可，缩略内容在显示全文中也会出现
-
-    但考虑到不想把缩略内容放在正文里，就添加了此参数，在 [Front-Matter](https://hexo.io/zh-cn/docs/front-matter) 里设置
-
-    支持 Markdown 格式
-
-    ```yaml
-    description: |
-        Normal _Italic_ **Strong**
+            Argvchs: https://argvchs.netlify.app
     ```
 
 -   页脚
@@ -152,8 +138,10 @@ background:
     如没有需要显示备案消息的可以关闭
 
     ```yaml
+    # Footer info
     footer:
         since: 2022
+        # Customize the server domain name ICP
         ICP:
             enable: false
             code:
@@ -162,11 +150,13 @@ background:
 
 -   Polyfill
 
-    使用 [Polyfill.io](https://polyfill.io/v3/url-builder) 自动根据 UA 处理新的 JS API 兼容
+    使用 [Polyfill.io](https://polyfill.io) 自动根据 UA 处理新的 JS API 兼容
 
     可以配合 [Hexo-Babel](https://github.com/argvchs/hexo-babel) 插件处理 JS 语法兼容
 
     ```yaml
+    # Polyfill
+    # https://polyfill.io
     polyfill:
         enable: true
         features:
@@ -180,8 +170,10 @@ background:
     样式可以在[这里](https://highlightjs.org/static/demo)选择，默认为 GitHub
 
     ```yaml
+    # Highlight.js
+    # https://highlightjs.org
     highlight:
-        enable: false
+        enable: true
         style: github
     ```
 
@@ -190,6 +182,7 @@ background:
     使用 KaTeX 渲染数学公式
 
     ```yaml
+    # Rendering math with KaTeX
     math:
         enable: false
     ```
@@ -199,10 +192,24 @@ background:
     简单的点击图片放大缩小的预览
 
     ```yaml
+    # Image Preview
     preview:
         enable: true
     ```
 
+-   文章缩略
+
+    一般来说，缩略展示文档只需要在文档中添加 `<!-- more -->` 即可，缩略内容在显示全文中也会出现
+
+    但考虑到不想把缩略内容放在正文里，就添加了此参数，在 [Front-Matter](https://hexo.io/zh-cn/docs/front-matter) 里设置
+
+    支持 Markdown 格式
+
+    ```yaml
+    description: |
+        Normal _Italic_ **Strong**
+    ```
+
 -   文章置顶
 
     在 [Front-Matter](https://hexo.io/zh-cn/docs/front-matter) 里设置 `pinned` 作为置顶参数，越大越靠前，默认为 0
@@ -212,6 +219,7 @@ background:
     使用 AES 加密算法，在 [Front-Matter](https://hexo.io/zh-cn/docs/front-matter) 里设置 `secret` 作为密码，**使用请安装插件 [Hexo-Helper-Crypto](https://github.com/argvchs/hexo-helper-crypto)**
 
     ```yaml
+    # Article encryption
     crypto:
         enable: false
     ```
@@ -223,37 +231,11 @@ background:
     目前只支持搜索文档标题（我太弱了）
 
     ```yaml
+    # Search
     search:
         enable: false
     ```
 
--   Gitalk
-
-    Gitalk 是一个基于 GitHub Issue 和 Preact 的评论系统
-
-    考虑到博客可能部署到多个网站同步评论，但 OAuth APP 只能有一个回调 URL，所以添加了 `sites` 参数用于其他网站的评论，请注册多个 Oauth APP
-
-    **同样如果没有其他网站，请在 `sites:` 后添加一个 `{}`**
-
-    由于 Gitalk 官方 CORS 代理用的是 Cloudflare，速度过慢，添加了 `proxy` 参数，搭建 CORS 代理可以看[这篇文章](https://argvchs.github.io/2022/07/04/build-cors-anywhere)
-
-    ```yaml
-    gitalk:
-        enable: false
-        clientID: # Default ClientID
-        clientSecret: # Default ClientSecret
-        repo: # The name of repository of store comments
-        owner: # GitHub repo owner
-        admin: # GitHub repo owner and collaborators, only these guys can initialize github issues
-        language: zh-CN # en, zh-CN, zh-TW, es-ES, fr, ru, de, pl and ko are currently available
-        proxy: # CORS proxy
-        sites: # Sites
-            {}
-            # <www.example.com>:
-            #    clientID: <client-id>
-            #    clientSecret: <client-secret>
-    ```
-
 -   Giscus
 
     Giscus 是一个由 GitHub Discussions 支持的评论系统
@@ -261,6 +243,8 @@ background:
     在 [Giscus.app](https://giscus.app) 设置好各项后，会在下面生成一个 `<script>` 标签，在主题内填入即可
 
     ```yaml
+    # Giscus
+    # https://github.com/giscus/giscus
     giscus:
         enable: false
         src: https://giscus.app/client.js
@@ -277,6 +261,35 @@ background:
         lang: zh-CN
     ```
 
+-   Gitalk
+
+    Gitalk 是一个基于 GitHub Issue 和 Preact 的评论系统
+
+    考虑到博客可能部署到多个网站同步评论，但 OAuth APP 只能有一个回调 URL，所以添加了 `sites` 参数用于多个网站的评论
+
+    **同样如果没有其他网站，请在 `sites:` 后添加一个 `{}`**
+
+    由于 Gitalk 官方 CORS 代理用的是 Cloudflare，速度过慢，添加了 `proxy` 参数，搭建 CORS 代理可以看[这篇文章](https://argvchs.github.io/2022/07/04/build-cors-anywhere)
+
+    ```yaml
+    # Gitalk
+    # https://github.com/gitalk/gitalk
+    gitalk:
+        enable: false
+        clientID: # Default ClientID
+        clientSecret: # Default ClientSecret
+        repo: # The name of repository of store comments
+        owner: # GitHub repo owner
+        admin: # GitHub repo owner and collaborators, only these guys can initialize github issues
+        language: zh-CN # en, zh-CN, zh-TW, es-ES, fr, ru, de, pl and ko are currently available
+        proxy: # CORS proxy
+        sites: # Sites
+            {}
+            # www.example.com:
+            #    clientID:
+            #    clientSecret:
+    ```
+
 -   Waline
 
     Waline 是一个简单、安全的评论系统
@@ -286,13 +299,13 @@ background:
     **注意如果不需要 `locale` 参数，请在 `locale:` 后添加一个 `{}`**
 
     ```yaml
+    # Waline
+    # https://github.com/walinejs/waline
     waline:
         enable: false
         serverURL: # Waline server address url, you should set this to your own link
         locale: # Locale: https://waline.js.org/guide/client/i18n.html#locale-option
             {}
-            # e.g.:
-            # placeholder: Leave a comment
         commentCount: true # If false, comment count will only be displayed in post page, not in home page
         pageview: false # Pageviews count, Note: You should not enable both `waline.pageview` and `leancloud_visitors`
         emoji: # Custom emoji
@@ -319,6 +332,8 @@ background:
     Twikoo 是一个一个简洁、安全、免费的静态网站评论系统
 
     ```yaml
+    # Twikoo
+    # https://github.com/imaegoo/twikoo
     twikoo:
         enable: false
         envID:
@@ -329,4 +344,4 @@ background:
 
 ## 写在最后
 
-本项目采用 MIT 开源许可证，欢迎大家贡献，你可以随意打开一个 Issue 来进行提问，有任何改进想法都可以进行 Fork，期待您的 Pull Request
+本项目采用 MIT 开源许可证，欢迎大家贡献，你可以随意打开一个 Issue 来进行提问，有任何改进想法都可以进行 Fork，期待您的 Pull Request！

package/_config.yml

@@ -2,16 +2,16 @@
 # https://github.com/argvchs/hexo-theme-particlex
 
 # Avatar image
-avatar:
+avatar: /images/avatar.jpg
 
 # Home page info block
 headBlockEnable: true
 
 # Home page background image
-background:
+background: /images/background.jpg
 
 # ParticleX theme icon is adopts the Font Awesome 6
-# https://fontawesome.com/search
+# https://fontawesome.com
 
 # Main menu navigation
 menu:
@@ -35,10 +35,6 @@ menu:
         name: tags
         theme: solid
         link: /tags
-    # <name>:
-    #     name: <icon-name>
-    #     theme: <icon-theme>
-    #     link: <link-url>
 
 # Side info card
 card:
@@ -48,13 +44,8 @@ card:
         ...
     iconLinks:
         {}
-        # <name>:
-        #    name: <icon-name>
-        #    theme: <icon-theme>
-        #    link: <link-url>
     friendLinks:
-        {}
-        # <name>: <link-url>
+        Argvchs: https://argvchs.netlify.app
 
 # Footer info
 footer:
@@ -66,7 +57,7 @@ footer:
         link:
 
 # Polyfill
-# https://polyfill.io/v3/url-builder
+# https://polyfill.io
 polyfill:
     enable: true
     features:
@@ -94,23 +85,6 @@ crypto:
 search:
     enable: false
 
-# Gitalk
-# https://github.com/gitalk/gitalk
-gitalk:
-    enable: false
-    clientID: # Default ClientID
-    clientSecret: # Default ClientSecret
-    repo: # The name of repository of store comments
-    owner: # GitHub repo owner
-    admin: # GitHub repo owner and collaborators, only these guys can initialize github issues
-    language: zh-CN # en, zh-CN, zh-TW, es-ES, fr, ru, de, pl and ko are currently available
-    proxy: # CORS proxy
-    sites: # Sites
-        {}
-        # <www.example.com>:
-        #    clientID: <client-id>
-        #    clientSecret: <client-secret>
-
 # Giscus
 # https://github.com/giscus/giscus
 giscus:
@@ -128,6 +102,23 @@ giscus:
     theme: preferred_color_scheme
     lang: zh-CN
 
+# Gitalk
+# https://github.com/gitalk/gitalk
+gitalk:
+    enable: false
+    clientID: # Default ClientID
+    clientSecret: # Default ClientSecret
+    repo: # The name of repository of store comments
+    owner: # GitHub repo owner
+    admin: # GitHub repo owner and collaborators, only these guys can initialize github issues
+    language: zh-CN # en, zh-CN, zh-TW, es-ES, fr, ru, de, pl and ko are currently available
+    proxy: # CORS proxy
+    sites: # Sites
+        {}
+        # www.example.com:
+        #    clientID:
+        #    clientSecret:
+
 # Waline
 # https://github.com/walinejs/waline
 waline:
@@ -135,8 +126,6 @@ waline:
     serverURL: # Waline server address url, you should set this to your own link
     locale: # Locale: https://waline.js.org/guide/client/i18n.html#locale-option
         {}
-        # e.g.:
-        # placeholder: Leave a comment
     commentCount: true # If false, comment count will only be displayed in post page, not in home page
     pageview: false # Pageviews count, Note: You should not enable both `waline.pageview` and `leancloud_visitors`
     emoji: # Custom emoji

package/layout/comment.ejs

@@ -1,29 +1,3 @@
-<% if (theme.gitalk.enable) { %>
-<script>
-    let clientID = "<%- theme.gitalk.clientID %>",
-        clientSecret = "<%- theme.gitalk.clientSecret %>";
-    <% Object.keys(theme.gitalk.sites).forEach(key => { %>
-    if (window.location.host === "<%- key %>") {
-        clientID = "<%- theme.gitalk.sites[key].clientID %>";
-        clientSecret = "<%- theme.gitalk.sites[key].clientSecret %>";
-    }
-    <% }); %>
-    const gitalk = new Gitalk({
-        clientID: clientID,
-        clientSecret: clientSecret,
-        repo: "<%- theme.gitalk.repo %>",
-        owner: "<%- theme.gitalk.owner %>",
-        admin: ["<%- theme.gitalk.admin %>"],
-        language: "<%- theme.gitalk.language %>",
-        id: location.pathname,
-        distractionFreeMode: false,
-        <% if (theme.gitalk.proxy) { %>
-        proxy: "<%- theme.gitalk.proxy %>",
-        <% } %>
-    })
-    gitalk.render("gitalk-container");
-</script>
-<% } %>
 <% if (theme.giscus.enable) { %>
 <script
     src="<%- theme.giscus.src %>"
@@ -42,6 +16,34 @@
     async
 ></script>
 <% } %>
+<% if (theme.gitalk.enable) { %>
+<script>
+    (function () {
+        let clientID = "<%- theme.gitalk.clientID %>",
+            clientSecret = "<%- theme.gitalk.clientSecret %>";
+        <% Object.keys(theme.gitalk.sites).forEach(key => { %>
+        if (window.location.host === "<%- key %>") {
+            clientID = "<%- theme.gitalk.sites[key].clientID %>";
+            clientSecret = "<%- theme.gitalk.sites[key].clientSecret %>";
+        }
+        <% }); %>
+        const gitalk = new Gitalk({
+            clientID: clientID,
+            clientSecret: clientSecret,
+            repo: "<%- theme.gitalk.repo %>",
+            owner: "<%- theme.gitalk.owner %>",
+            admin: ["<%- theme.gitalk.admin %>"],
+            language: "<%- theme.gitalk.language %>",
+            id: location.pathname,
+            distractionFreeMode: false,
+            <% if (theme.gitalk.proxy) { %>
+            proxy: "<%- theme.gitalk.proxy %>",
+            <% } %>
+        })
+        gitalk.render("gitalk-container");
+    })();
+</script>
+<% } %>
 <% if (theme.waline.enable) { %>
 <script>
     Waline.init({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hexo-theme-particlex",
-  "version": "2.5.6",
+  "version": "2.5.7",
   "description": "A concise Hexo theme, based on Particle.",
   "repository": {
     "type": "git",