Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
hexo-theme-shokax
Advanced tools
hexo-theme-shokax - npm Package Compare versions
Comparing version 0.3.4 to 0.3.5
| { | ||
| "name": "hexo-theme-shokax", | ||
| "version": "0.3.4", | ||
| "version": "0.3.5", | ||
| "description": "a hexo theme based on shoka", | ||
@@ -5,0 +5,0 @@ "main": "index.js", |
@@ -1,6 +0,6 @@ | ||
| If the repository address you are visiting is **zkz098/hexo-theme-shokaX**, please switch to the latest address: [theme-shoka-x/hexo-theme-shokaX](https://github.com/theme-shoka-x/hexo-theme-shokaX) | ||
| # 📣 Announcement | ||
| * [ShokaX is looking for community maintainers](https://github.com/theme-shoka-x/hexo-theme-shokaX/discussions/137) | ||
| # hexo-theme-shokaX | ||
| [](https://app.fossa.com/projects/git%2Bgithub.com%2Fzkz098%2Fhexo-theme-shokaX?ref=badge_shield) | ||
|  | ||
|  | ||
|  | ||
@@ -11,47 +11,78 @@  | ||
| 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. | ||
| This project is a fork (spiritual successor) of Shoka, aimed at improving performance and optimizing the modified experience. \ | ||
| The reason for its creation is that Shoka has not been updated for two years, accumulating a large number of bugs and feature requests. | ||
| The community resource navigation and plugin repository for shokaX is [awesome-shokaX](https://github.com/theme-shoka-x/awesome-shokaX) | ||
| The community resource guide and plugin repository for shokaX are available at [awesome-shokaX](https://github.com/theme-shoka-x/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. | ||
| ## 💬 Differences from Shoka | ||
| The original Shoka used a combination of JavaScript + Native + Nunjucks technologies. \ | ||
| ShokaX, on the other hand, uses TypeScript + Vue 3 + Pug technologies and has changed many 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. | ||
| | Feature | Status | Feature | Status | | ||
| |:-------------------------------:|:------:|:------------------------------:|:------:| | ||
| | PWA Support | ✅ | JSD Split | ✅ | | ||
| | Injection API | ✅ | Community Plugin System | ✅ | | ||
| | Custom Fonts | ✅* | Custom Styles | ✅* | | ||
| | Multiple Comment System Support | ✅ | AI-generated Article Summaries | 🔬 | | ||
| | Bottom Record Number | ✅ | Custom Footer | ✅* | | ||
| | CSS Gradient Cover | ✅ | TypeScript Support | ✅ | | ||
| ## 🔧 How to Install? | ||
| It is recommended to use [ShokaX-CLI](https://github.com/theme-shoka-x/shokaX-CLI) and execute the following command: | ||
| ```bash | ||
| npm i shokax-cli --location=global | ||
| # hexo init initializes the environment | ||
| SXC install shokaX | ||
| ``` | ||
| Notes: | ||
| - *: Requires implementation using Injection API | ||
| - 🔬: In experimentation, may have issues | ||
| ## 🔧 How to Install | ||
| Note: This project requires node.js 18.x or higher to run. \ | ||
| It is recommended to use [ShokaX-CLI](https://github.com/zkz098/shokaX-CLI) \ | ||
| [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: | ||
| For the GitHub repository, it is recommended to download from the releases on the right side, with the following steps: | ||
| - Click on the Latest version in Releases | ||
| - Download the Source code(zip) in Assets | ||
| - Unzip to use as the theme | ||
| - Download `Source code(zip)` from Assets | ||
| - Unzip to use as a theme | ||
| ## 📚 Sub-projects | ||
| - [ShokaX docs](https://github.com/theme-shoka-x/shokaX-docs) ShokaX Theme Documentation (work in progress, contributions welcome!) | ||
| - [HRMNMI](https://github.com/theme-shoka-x/hexo-renderer-multi-next-markdown-it) The markdown renderer used by ShokaX (awaiting refactoring) | ||
| - [ShokaX CLI](https://github.com/theme-shoka-x/shokaX-CLI) ShokaX Command Line Installer | ||
| - [ShokaX Pjax](https://github.com/theme-shoka-x/theme-shokax-pjax) Efficient Pjax implementation by ShokaX | ||
| - [ShokaX Anime](https://github.com/theme-shoka-x/theme-shokax-anime) Minimalistic Anime.js implementation by ShokaX | ||
| ## 🛠️ Development | ||
| [ShokaX Official Development Documentation](https://docs.kaitaku.xyz/develop/basic/) | ||
| Recommended reading for contributing: | ||
| - [Hexo Official Documentation](https://hexo.io/zh-cn/docs/templates) | ||
| - [Stylus Chinese Documentation](http://stylus.bootcss.com/) | ||
| - [Pug Template Engine Chinese Documentation](https://www.pugjs.cn/api/getting-started.html) | ||
| - [TypeScript Chinese Documentation](https://www.tslang.cn/docs/home.html) | ||
| - [Easy Hexo](https://easyhexo.com/) | ||
| # License | ||
| license: GPL 3 or later | ||
| [](https://app.fossa.com/projects/git%2Bgithub.com%2Fzkz098%2Fhexo-theme-shokaX?ref=badge_large) | ||
| License: AGPL 3 or later | ||
| ## Contributors | ||
| ## Special Note | ||
| The primary purpose of the AGPL license is to restrict distribution after modification, preventing unauthorized secondary modification for commercial purposes. \ | ||
| Modifications to the source code **must** be open-sourced, as per the AGPL license. Building a website requires open-sourcing modified parts. | ||
| ## Usage Special Note | ||
| In accordance with AGPLv3 Section 7, we have added some additional terms. \ | ||
| Please see [Usage Restrictions](./UsageRestrictions.md). Using ShokaX implies that you are aware of the contents of this file. | ||
| # Acknowledgments | ||
| ## Open Source Projects | ||
| | Name | Author | Description | | ||
| |:----------------:|:-----------------:|:--------------------------------------------:| | ||
| | Hexo | Hexo contributors | Provided a solid foundation for this project | | ||
| | hexo-theme-shoka | amehime | Parent theme of this project | | ||
| ## Developers | ||
| [](https://github.com/theme-shoka-x/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) | ||
| ## Special Thanks | ||
| [<img src="https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.png" width="25%">](https://jb.gg/OpenSourceSupport) | ||
| ## Other Information | ||
|  |
@@ -5,3 +5,2 @@ # 📣 公告 | ||
| # hexo-theme-shokaX | ||
| [](https://app.fossa.com/projects/git%2Bgithub.com%2Fzkz098%2Fhexo-theme-shokaX?ref=badge_shield) | ||
|  | ||
@@ -8,0 +7,0 @@  |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
New alerts
License Policy Violation
LicenseThis 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
LicenseThis 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
- increased by0.26%
576354
Worsened metrics
- Number of lines in readme file
- decreased by-1.05%
94
No dependency changes