hexo-theme-shokax - npm Package Compare versions

Comparing version 0.2.4 to 0.2.5-beta1

package.json

 {
     "name": "hexo-theme-shokax",
-    "version": "0.2.4",
+    "version": "0.2.5-beta1",
     "description": "a hexo theme based on shoka",
@@ -42,3 +42,3 @@ "main": "index.js",
         "vuepress": "2.0.0-beta.61",
-        "vuepress-plugin-sitemap2": "2.0.0-beta.205"
+        "vuepress-plugin-sitemap2": "2.0.0-beta.206"
     },
@@ -45,0 +45,0 @@ "dependencies": {

README_en.MD

@@ -0,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, 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.
+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.
 
-## How to install?
-[ShokaX-CLI](https://github.com/zkz098/shokaX-CLI) is recommended:
+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       |           ✅           |
+
+Remarks:
+- *: Requires implementation using Injection API.
+
+## 🔧 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)

README.md

@@ -28,3 +28,3 @@ 如果你访问的仓库地址是**zkz098/hexo-theme-shokaX**，请转为访问最新地址: [theme-shoka-x/hexo-theme-shokaX](https://github.com/theme-shoka-x/hexo-theme-shokaX)
 |  自定义字体   |  ✅*  |    自定义样式     |  ✅*  |
-| 多种评论系统支持 |  ✅   |   用户行为分析支持   |  ✅   |
+| 多种评论系统支持 |  ✅   |   AI生成文章概括   |  🔬  |
 |  底部备案号   |  ✅   |    自定义页尾     |  ✅*  |
@@ -35,5 +35,7 @@ | CSS渐变封面  |  ✅   | typescript支持 |  ✅   |
 - *: 需要使用注入API实现
+- 🔬: 实验中，可能存在问题
 
 
 ## 🔧 如何安装?
+注意: 本项目需要 node.js 18.x 或更高版本才能运行 \
 建议使用[ShokaX-CLI](https://github.com/zkz098/shokaX-CLI) ,执行下列命令即可:
@@ -63,3 +65,3 @@ ```bash
 # 许可证
-许可证: 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)
@@ -83,1 +85,4 @@
 [<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)

source/js/_app/library.js

@@ -64,3 +64,3 @@ const getDocHeight = () => $dom('main > .inner').offsetHeight;
     },
-    top: function () {
+    getTop: function () {
         return this.getBoundingClientRect().top;
@@ -300,3 +300,3 @@ },
         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 () {
@@ -303,0 +303,0 @@ complete && complete();

source/js/_app/page.js

@@ -75,3 +75,3 @@ const cardActive = function () {
                 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, '');
@@ -409,3 +409,3 @@ element.parentNode.insertBefore(box, element);
         box.appendChild(element);
-        element.attr('data-ready', true);
+        element.attr('data-ready', String(true));
     });
@@ -412,0 +412,0 @@ };

source/js/_app/player.js

@@ -428,3 +428,3 @@ let NOWPLAYING = null;
         group: true,
-        load: function (newList) {
+        load: (newList) => {
             let d = '';
@@ -487,3 +487,3 @@ if (newList && newList.length > 0) {
         },
-        mode: function () {
+        mode: () => {
             const total = playlist.data.length;
@@ -501,3 +501,3 @@ if (!total || playlist.errnum === total) {
             };
-            const random = function () {
+            const random = () => {
                 const p = utils.random(total);
@@ -529,3 +529,3 @@ if (playlist.index !== p) {
         },
-        switch: function (index) {
+        switch: (index) => {
             if (typeof index === 'number' &&
@@ -562,3 +562,3 @@ index !== playlist.index &&
         },
-        play: function () {
+        play: () => {
             NOWPLAYING && NOWPLAYING.player.pause();
@@ -565,0 +565,0 @@ if (playlist.current().error) {

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

562673

increased by1.25%

Number of package files

169

increased by0.6%

Lines of code

5403

increased by1.81%

Number of lines in readme file

84

increased by5%

Worsened metrics

Number of medium supply chain risk alerts

6

increased by20%

No dependency changes