hexo-theme-shokax 0.2.4 → 0.2.5-beta1

package/README.md

@@ -25,15 +25,17 @@ shokaX的社区资源导航和插件仓库为[awesome-shokaX](https://github.com
 |  PWA支持   |  ✅   |    JSD拆分     |  ✅   |
 |  注入API   |  ✅   |    社区插件系统    |  ✅   |
 |  自定义字体   |  ✅*  |    自定义样式     |  ✅*  |
-| 多种评论系统支持 |  ✅   |   用户行为分析支持   |  ✅   |
+| 多种评论系统支持 |  ✅   |   AI生成文章概括   |  🔬  |
 |  底部备案号   |  ✅   |    自定义页尾     |  ✅*  |
 | CSS渐变封面  |  ✅   | typescript支持 |  ✅   |
 
 备注:
 - *: 需要使用注入API实现
+- 🔬: 实验中，可能存在问题
 
 
 ## 🔧 如何安装?
+注意: 本项目需要 node.js 18.x 或更高版本才能运行 \
 建议使用[ShokaX-CLI](https://github.com/zkz098/shokaX-CLI) ,执行下列命令即可:
 ```bash
 npm i shokax-cli --location=global
@@ -58,7 +60,7 @@ github仓库建议通过右边的 releases 下载,步骤为:
 - [Easy hexo](https://easyhexo.com/)
 
 # 许可证
-许可证: GPL 3 \
+许可证: GPL 3 or later \
 [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fzkz098%2Fhexo-theme-shokaX.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fzkz098%2Fhexo-theme-shokaX?ref=badge_large)
 
 ## 特别说明
@@ -77,3 +79,6 @@ GPL许可证主要目的是限制修改后的分发行为，避免未经许可
 
 ## 特别鸣谢
 [<img src="https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.png" width="25%">](https://jb.gg/OpenSourceSupport)
+
+## 其他信息
+![Star history chart](https://api.star-history.com/svg?repos=theme-shoka-x/hexo-theme-shokaX&type=Date)

package/README_en.MD

@@ -1,25 +1,56 @@
+If the repository address you are visiting is zkz098/hexo-theme-shokaX, please switch to the latest address: theme-shoka-x/hexo-theme-shokaX.
+
 # hexo-theme-shokaX
 [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fzkz098%2Fhexo-theme-shokaX.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fzkz098%2Fhexo-theme-shokaX?ref=badge_shield)
-![LICENSE](	https://img.shields.io/github/license/zkz098/hexo-theme-shokaX)
-![stars](https://img.shields.io/github/stars/zkz098/hexo-theme-shokaX)
+![LICENSE](	https://img.shields.io/github/license/theme-shoka-x/hexo-theme-shokaX)
+![stars](https://img.shields.io/github/stars/theme-shoka-x/hexo-theme-shokaX)
 ![version](https://shields.io/npm/v/hexo-theme-shokax)
+![build](https://img.shields.io/github/actions/workflow/status/theme-shoka-x/hexo-theme-shokaX/build-theme.yml)
+
+Language: [简体中文](./README.md) | English \
+This project is a secondary development version of shoka (spiritual sequel), dedicated to improving performance and optimizing modding experience.
+The reason for its birth is that shoka has not been updated for two years, with a large backlog of bugs and feature requests.
+
+The community resource navigation and plugin repository for shokaX is awesome-shokaX.
+
+## 💬 Differences with shoka
+The original shoka used javascript+Native+nunjucks technology, while shokaX uses typescript+Vue 3+Pug technology and has changed a lot of hard-to-access CDN links.
+
+## ✨ Feature List
+|          Feature Name           | Implementation Status |          Feature Name          | Implementation Status |
+|:-------------------------------:|:---------------------:|:------------------------------:|:---------------------:|
+|           PWA Support           |           ✅           |         JSD Splitting          |           ✅           |
+|          Injection API          |           ✅           |    Community Plugin System     |           ✅           |
+|          Custom Fonts           |          ✅*           |         Custom Styles          |          ✅*           |
+| Multiple Comment System Support |           ✅           | User Behavior Analysis Support |           ✅           |
+|   Record Number at the Bottom   |           ✅           |         Custom Footer          |          ✅*           |
+|       CSS Gradient Cover        |           ✅           |       Typescript Support       |           ✅           |
 
-语言(language): [简体中文](./README.md) | English \
-This project is a secondary development version of Shoka, dedicated to improving performance and optimizing the development experience. \
-This project is in a period of intensive development, but the github repository version is basically available. \
-Please refer to the wiki for secondary development and common problems.
-Starting with `0.0.2-alpha2`, `lantern` and `qweather` have been migrated as plugins.
-The plugin system is complete, see [awesome-shokaX](https://github.com/zkz098/awesome-shokaX) for how to use it.
+Remarks:
+- *: Requires implementation using Injection API.
 
-## How to install?
-[ShokaX-CLI](https://github.com/zkz098/shokaX-CLI) is recommended:
+## 🔧 How to Install?
+It is recommended to use [ShokaX-CLI](https://github.com/zkz098/shokaX-CLI) and execute the following command:
 ```bash
 npm i shokax-cli --location=global
-# hexo init
-SXC install -r=github shokaX
+# hexo init initializes the environment
+SXC install shokaX
 ```
+[Click here](https://docs.kaitaku.xyz/guide/#%E9%85%8D%E7%BD%AE%E4%B8%BB%E9%A2%98) for the next configuration steps.
+
+It is recommended to download the GitHub repository from the Releases on the right-hand side, as follows:
+
+- Click on the Latest version in Releases
+- Download the Source code(zip) in Assets
+- Unzip to use as the theme
 
 # License
-License: BSD-3-Clause \
+license: GPL 3 or later
 [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fzkz098%2Fhexo-theme-shokaX.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fzkz098%2Fhexo-theme-shokaX?ref=badge_large)
 
+## Contributors
+
+[![](https://contributors-img.web.app/image?repo=zkz098/hexo-theme-shokaX)](https://github.com/zkz098/hexo-theme-shokaX/graphs/contributors)
+
+## Special thanks
+[<img src="https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.png" width="25%">](https://jb.gg/OpenSourceSupport)

package/_config.yml

@@ -198,6 +198,17 @@ giscus:
   commentTheme:
   lang:
 
+summary:
+  enable: false
+  introduce: "我是基于ChatGPT-turbo-3.5实现的AI助手，在此网站上负责整理和概括文章" # AI自我介绍
+  mode: openai # openai/custom
+  openai:
+    remote: "https://api.openai.com"
+    apikey: "key"
+  custom:
+    remote: "http://localhost:8000"
+
+
 # Social Links
 # Usage: `Key: permalink || icon || color`
 # Key is the link label showing to end users.

package/layout/_mixin/postmeta.pug

@@ -1,6 +1,5 @@
 mixin PMRender(item, full)
     - full ||= false
-    //- 下方的_content为暴力修复法,在未来需要重写
     div(class="meta")
         - var create_title = __('post.created') + __('symbol.colon') + full_date(item.date)
         span(class="item" title=create_title)

package/layout/_partials/post/post.pug

@@ -12,6 +12,19 @@ article(itemscope itemtype="http://schema.org/Article" class="post block" lang=t
             div(class="gallery" itemscope itemtype="http://schema.org/ImageGallery")
                 each photo in post.photos
                     img(data-src=_image_url(photo, post.path) itemprop="contentUrl")
+        if theme.summary.enable && page.layout === 'post'
+            div(class='tabs' id='summary')
+                div(class="show-btn")
+                div(class="nav")
+                    ul(class="special")
+                div(class="tab" data-id="summary" data-title="自我介绍")
+                    p
+                        != get_introduce()
+                div(class="tab active" data-id="summary" data-title="文章概括")
+                    p
+                        != get_summary(page)
+
+
         != post.content
         if post.tags && post.tags.length
             div(class="tags")

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "hexo-theme-shokax",
-    "version": "0.2.4",
+    "version": "0.2.5-beta1",
     "description": "a hexo theme based on shoka",
     "main": "index.js",
     "repository": "https://github.com/zkz098/hexo-theme-shokaX",
@@ -39,7 +39,7 @@
         "typescript": "^5.0.4",
         "vue": "^3.2.47",
         "vuepress": "2.0.0-beta.61",
-        "vuepress-plugin-sitemap2": "2.0.0-beta.205"
+        "vuepress-plugin-sitemap2": "2.0.0-beta.206"
     },
     "dependencies": {
         "js-yaml": "^4.1.0",

package/scripts/helpers/summary_ai.js

@@ -0,0 +1,96 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_fs_1 = __importDefault(require("node:fs"));
+function getContent(post) {
+    return post?.raw ?? post?._content ?? post.content;
+}
+let db;
+function postMessage(path, content, dbPath, startMessage) {
+    if (node_fs_1.default.existsSync('summary.json')) {
+        db = JSON.parse(node_fs_1.default.readFileSync('summary.json'));
+    }
+    else {
+        db = {};
+    }
+    const config = hexo.theme.config.summary;
+    if (config.enable) {
+        if (typeof db?.[path] !== 'undefined' && typeof db?.[path]?.[dbPath] !== 'undefined') {
+            return db[path][dbPath];
+        }
+        else {
+            if (typeof db?.[path] === 'undefined') {
+                db[path] = {};
+            }
+            else {
+                db[path][dbPath] = '';
+            }
+        }
+        if (config.mode === 'openai') {
+            const request = () => {
+                fetch(`${config.openai.remote}/v1/chat/completions`, {
+                    method: 'POST',
+                    headers: requestHeaders,
+                    body: JSON.stringify(requestBody)
+                }).then((response) => {
+                    if (!response.ok) {
+                        throw Error('ERROR: Failed to get summary from Openai API');
+                    }
+                    response.json().then((data) => {
+                        const summary = data.choices[0].message.content;
+                        try {
+                            db[path][dbPath] = summary;
+                        }
+                        catch (e) {
+                            db ??= {};
+                            db[path] ??= {};
+                            db[path][dbPath] ??= '';
+                            console.log(db[path]);
+                            db[path][dbPath] = summary;
+                        }
+                        node_fs_1.default.writeFileSync('summary.json', JSON.stringify(db));
+                        if (node_fs_1.default.existsSync('requested.lock')) {
+                            node_fs_1.default.unlinkSync('requested.lock');
+                        }
+                        return summary;
+                    });
+                });
+            };
+            const checkTime = () => {
+                if (node_fs_1.default.existsSync('request.lock')) {
+                    if (node_fs_1.default.existsSync('requested.lock')) {
+                        setTimeout(checkTime, 1000 * 10);
+                        return;
+                    }
+                    node_fs_1.default.writeFileSync('requested.lock', '');
+                    setTimeout(request, 1000 * 20);
+                    node_fs_1.default.unlinkSync('request.lock');
+                }
+                else {
+                    node_fs_1.default.writeFileSync('request.lock', '');
+                    request();
+                }
+            };
+            const requestHeaders = {
+                'Content-Type': 'application/json',
+                Authorization: `Bearer ${config.openai.apikey}`
+            };
+            const requestBody = {
+                model: 'gpt-3.5-turbo',
+                messages: [{ role: 'user', content: `${startMessage} ${content}` }],
+                temperature: 0.7
+            };
+            checkTime();
+        }
+        else {
+        }
+    }
+}
+hexo.extend.helper.register('get_summary', (post) => {
+    return postMessage(post.path, getContent(post), 'summary', '请为下述文章提供一份200字以内的概括，使用中文回答且尽可能简洁: ');
+});
+hexo.extend.helper.register('get_introduce', () => {
+    return hexo.theme.config.summary.introduce;
+});

package/source/css/_common/components/tags/tabs.styl

@@ -14,6 +14,13 @@
       overflow-x: auto;
     }
 
+    ul.special::before {
+      font-family: ic;
+      content: "\e652";
+      font-size: x-large;
+      padding-left: 1em;
+    }
+
     li {
       position: relative;
       cursor: pointer;
@@ -27,20 +34,20 @@
         position: absolute;
         left: 50%;
         right: 50%;
-        top: auto;
+        top: 2em;
         bottom: 0;
         transition: all .2s ease-in-out;
         width: auto;
         height: auto;
         background: none;
-        border-radius: 0;
+        border-radius: 10px;
         border-bottom: .125rem solid transparent;
       }
 
       &.active::before {
         left: 0;
         right: 0;
-        border-bottom-color: var(--note-hover, var(--primary-color));
+        border-bottom-color: var(--primary-color);
       }
     }
   }

package/source/js/_app/library.js

@@ -61,7 +61,7 @@ Object.assign(HTMLElement.prototype, {
         }
         return this.getBoundingClientRect().width;
     },
-    top: function () {
+    getTop: function () {
         return this.getBoundingClientRect().top;
     },
     left: function () {
@@ -296,7 +296,7 @@ const pageScroll = function (target, offset, complete) {
         targets: typeof offset === 'number' ? target.parentNode : document.scrollingElement,
         duration: 500,
         easing: 'easeInOutQuad',
-        scrollTop: offset || (typeof target === 'number' ? target : (target ? target.top() + document.documentElement.scrollTop - siteNavHeight : 0)),
+        scrollTop: offset || (typeof target === 'number' ? target : (target ? target.getTop() + document.documentElement.scrollTop - siteNavHeight : 0)),
         complete: function () {
             complete && complete();
         }

package/source/js/_app/page.js

@@ -72,7 +72,7 @@ const postFancybox = function (p) {
             $dom.each(p + ' p.gallery', function (element) {
                 const box = document.createElement('div');
                 box.className = 'gallery';
-                box.attr('data-height', element.attr('data-height') || 220);
+                box.attr('data-height', String(element.attr('data-height') || 220));
                 box.innerHTML = element.innerHTML.replace(/<br>/g, '');
                 element.parentNode.insertBefore(box, element);
                 element.remove();
@@ -405,7 +405,7 @@ const tabFormat = function () {
             target.addClass('active');
         });
         box.appendChild(element);
-        element.attr('data-ready', true);
+        element.attr('data-ready', String(true));
     });
 };
 const loadComments = function () {

package/source/js/_app/player.js

@@ -425,7 +425,7 @@ const mediaPlayer = function (t, config) {
     t.player = {
         _id: utils.random(999999),
         group: true,
-        load: function (newList) {
+        load: (newList) => {
             let d = '';
             if (newList && newList.length > 0) {
                 if (this.options.rawList !== newList) {
@@ -483,7 +483,7 @@ const mediaPlayer = function (t, config) {
                 }
             });
         },
-        mode: function () {
+        mode: () => {
             const total = playlist.data.length;
             if (!total || playlist.errnum === total) {
                 return;
@@ -496,7 +496,7 @@ const mediaPlayer = function (t, config) {
                 }
                 playlist.index = index;
             };
-            const random = function () {
+            const random = () => {
                 const p = utils.random(total);
                 if (playlist.index !== p) {
                     playlist.index = p;
@@ -523,7 +523,7 @@ const mediaPlayer = function (t, config) {
             }
             this.init();
         },
-        switch: function (index) {
+        switch: (index) => {
             if (typeof index === 'number' &&
                 index !== playlist.index &&
                 playlist.current() &&
@@ -555,7 +555,7 @@ const mediaPlayer = function (t, config) {
                 this.play();
             }
         },
-        play: function () {
+        play: () => {
             NOWPLAYING && NOWPLAYING.player.pause();
             if (playlist.current().error) {
                 this.mode();