hexo-theme-shokax 0.4.5 → 0.4.6-beta2

package/LICENSE-shoka

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2020 霜月琉璃
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2020 霜月琉璃
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,98 +1,99 @@
-# 📣 公告
-[关于 ShokaX 部署平台和 Astro 迁移的调查](https://github.com/theme-shoka-x/hexo-theme-shokaX/discussions/229)
-
-# 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): 简体中文 | [English](./README_en.MD) \
-此项目是shoka的一个二次开发版(算精神续作),致力于提高性能和优化魔改体验 \
-诞生原因是目前shoka已经两年没有更新了,积压了大量BUG和功能请求。
-
-shokaX的社区资源导航和插件仓库为[awesome-shokaX](https://github.com/theme-shoka-x/awesome-shokaX)
-
-## 技术栈
-![TypeScript](https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white)
-![Vue.js](https://img.shields.io/badge/vuejs-%2335495e.svg?style=for-the-badge&logo=vuedotjs&logoColor=%234FC08D)
-![Pug](https://img.shields.io/badge/Pug-FFF?style=for-the-badge&logo=pug&logoColor=A86454)
-![Stylus](https://img.shields.io/badge/stylus-%23ff6347.svg?style=for-the-badge&logo=stylus&logoColor=white)
-
-## 💬 和shoka的区别
-原先shoka使用了javascript+Native+nunjucks的技术 \
-而shokaX则使用了typescript+Vue 3+Pug的技术搭配 \
-更改了大量难以访问的CDN链接
-
-## ✨ 功能清单 
-
-|   功能名称   | 实现状态 |     功能名称     | 实现状态 |
-|:--------:|:----:|:------------:|:----:|
-|  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
-# hexo init 初始化环境
-SXC install shokaX
-```
-[点此](https://docs.kaitaku.xyz/guide/#%E9%85%8D%E7%BD%AE%E4%B8%BB%E9%A2%98)以进行下一步配置
-
-## 📚子项目
-- [ShokaX docs](https://github.com/theme-shoka-x/shokaX-docs) ShokaX 主题文档 (正在编写中，欢迎加入！)
-- [HRMNMI](https://github.com/theme-shoka-x/hexo-renderer-multi-next-markdown-it) ShokaX 正在使用的 markdown 渲染器 (等待重构)
-- [ShokaX CLI](https://github.com/theme-shoka-x/shokaX-CLI) ShokaX 命令行安装程序
-- [ShokaX Pjax](https://github.com/theme-shoka-x/theme-shokax-pjax) ShokaX 提供的高效 Pjax 实现
-- [ShokaX Anime](https://github.com/theme-shoka-x/theme-shokax-anime) ShokaX 提供的精简版 Anime.js 实现
-
-## 🛠️二次开发
-[ShokaX官方开发文档](https://docs.kaitaku.xyz/develop/basic/)
-
-参与开发建议阅读的文档:
-- [Hexo 官方文档](https://hexo.io/zh-cn/docs/templates)
-- [Stylus 中文网](http://stylus.bootcss.com/)
-- [Pug 模板引擎中文文档](https://www.pugjs.cn/api/getting-started.html)
-- [Typescript 中文网](https://www.tslang.cn/docs/home.html)
-- [Easy hexo](https://easyhexo.com/)
-
-# [许可证](https://github.com/theme-shoka-x/hexo-theme-shokaX/blob/main/LICENSE)
-许可证: AGPL 3 or later
-
-## 特别说明
-AGPL许可证主要目的是限制修改后的分发行为，避免未经许可的二次修改封装商业行为 \
-仅修改源代码**需要**开源，因为根据AGPL许可，搭建网站需要开源修改部分
-
-## 使用特殊说明
-依照AGPLv3 Section 7，我们添加了一些附加条款:
-请查看[使用限制](./UsageRestrictions.md)，使用ShokaX则默认您已知晓此文件内容
-
-# 致谢名单
-## 开源项目
-| 名称               | 作者                | 描述                 |
-|:-----------------|:------------------|:-------------------|
-| Hexo             | Hexo contributors | 为本项目提供了良好的基础       |
-| hexo-theme-shoka | amehime           | 本项目的父主题            |
-
-## 开发者们
-Hexo 主题： \
-[![](https://contributors-img.web.app/image?repo=theme-shoka-x/hexo-theme-shokaX)](https://github.com/theme-shoka-x/hexo-theme-shokaX/graphs/contributors) \
-ShokaX 文档： \
-[![](https://contributors-img.web.app/image?repo=theme-shoka-x/shokaX-docs)](https://github.com/theme-shoka-x/shokaX-docs/graphs/contributors) \
-
-## 特别鸣谢
-[<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)
+# 📣 公告
+[你的 ShokaX 和 Shoka 站点可能正在遭遇供应链攻击](https://github.com/theme-shoka-x/hexo-theme-shokaX/discussions/293) \
+[关于 ShokaX 部署平台和 Astro 迁移的调查](https://github.com/theme-shoka-x/hexo-theme-shokaX/discussions/229)
+
+# 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): 简体中文 | [English](./README_en.MD) \
+此项目是shoka的一个二次开发版(算精神续作),致力于提高性能和优化魔改体验 \
+诞生原因是目前shoka已经三年没有更新了,积压了大量BUG和功能请求。
+
+shokaX的社区资源导航和插件仓库为[awesome-shokaX](https://github.com/theme-shoka-x/awesome-shokaX)
+
+## 技术栈
+![TypeScript](https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white)
+![Vue.js](https://img.shields.io/badge/vuejs-%2335495e.svg?style=for-the-badge&logo=vuedotjs&logoColor=%234FC08D)
+![Pug](https://img.shields.io/badge/Pug-FFF?style=for-the-badge&logo=pug&logoColor=A86454)
+![Stylus](https://img.shields.io/badge/stylus-%23ff6347.svg?style=for-the-badge&logo=stylus&logoColor=white)
+
+## 💬 和shoka的区别
+原先shoka使用了javascript+Native+nunjucks的技术 \
+而shokaX则使用了typescript+Vue 3+Pug的技术搭配 \
+更改了大量难以访问的CDN链接
+
+## ✨ 功能清单 
+
+|   功能名称   | 实现状态 |     功能名称     | 实现状态 |
+|:--------:|:----:|:------------:|:----:|
+|  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
+# hexo init 初始化环境
+SXC install shokaX
+```
+[点此](https://docs.kaitaku.xyz/guide/#%E9%85%8D%E7%BD%AE%E4%B8%BB%E9%A2%98)以进行下一步配置
+
+## 📚子项目
+- [ShokaX docs](https://github.com/theme-shoka-x/shokaX-docs) ShokaX 主题文档 (正在编写中，欢迎加入！)
+- [HRMNMI](https://github.com/theme-shoka-x/hexo-renderer-multi-next-markdown-it) ShokaX 正在使用的 markdown 渲染器 (等待重构)
+- [ShokaX CLI](https://github.com/theme-shoka-x/shokaX-CLI) ShokaX 命令行安装程序
+- [ShokaX Pjax](https://github.com/theme-shoka-x/theme-shokax-pjax) ShokaX 提供的高效 Pjax 实现
+- [ShokaX Anime](https://github.com/theme-shoka-x/theme-shokax-anime) ShokaX 提供的精简版 Anime.js 实现
+
+## 🛠️二次开发
+[ShokaX官方开发文档](https://docs.kaitaku.xyz/develop/basic/)
+
+参与开发建议阅读的文档:
+- [Hexo 官方文档](https://hexo.io/zh-cn/docs/templates)
+- [Stylus 中文网](http://stylus.bootcss.com/)
+- [Pug 模板引擎中文文档](https://www.pugjs.cn/api/getting-started.html)
+- [Typescript 中文网](https://www.tslang.cn/docs/home.html)
+- [Easy hexo](https://easyhexo.com/)
+
+# [许可证](https://github.com/theme-shoka-x/hexo-theme-shokaX/blob/main/LICENSE)
+许可证: AGPL 3 or later
+
+## 特别说明
+AGPL许可证主要目的是限制修改后的分发行为，避免未经许可的二次修改封装商业行为 \
+仅修改源代码**需要**开源，因为根据AGPL许可，搭建网站需要开源修改部分
+
+## 使用特殊说明
+依照AGPLv3 Section 7，我们添加了一些附加条款:
+请查看[使用限制](./UsageRestrictions.md)，使用ShokaX则默认您已知晓此文件内容
+
+# 致谢名单
+## 开源项目
+| 名称               | 作者                | 描述                 |
+|:-----------------|:------------------|:-------------------|
+| Hexo             | Hexo contributors | 为本项目提供了良好的基础       |
+| hexo-theme-shoka | amehime           | 本项目的父主题            |
+
+## 开发者们
+Hexo 主题： \
+[![](https://contributors-img.web.app/image?repo=theme-shoka-x/hexo-theme-shokaX)](https://github.com/theme-shoka-x/hexo-theme-shokaX/graphs/contributors) \
+ShokaX 文档： \
+[![](https://contributors-img.web.app/image?repo=theme-shoka-x/shokaX-docs)](https://github.com/theme-shoka-x/shokaX-docs/graphs/contributors) \
+
+## 特别鸣谢
+[<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,90 +1,91 @@
-# 📣 Announcement
-* [ShokaX is looking for community maintainers](https://github.com/theme-shoka-x/hexo-theme-shokaX/discussions/137)
-
-# 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 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 guide and plugin repository for shokaX are available at [awesome-shokaX](https://github.com/theme-shoka-x/awesome-shokaX)
-
-## Technology Stack
-![TypeScript](https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white)
-![Vue.js](https://img.shields.io/badge/vuejs-%2335495e.svg?style=for-the-badge&logo=vuedotjs&logoColor=%234FC08D)
-![Pug](https://img.shields.io/badge/Pug-FFF?style=for-the-badge&logo=pug&logoColor=A86454)
-![Stylus](https://img.shields.io/badge/stylus-%23ff6347.svg?style=for-the-badge&logo=stylus&logoColor=white)
-
-## 💬 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             | 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       |   ✅    |
-
-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/en/guide/) for the next configuration steps.
-
-## 📚 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](https://hexo.io/docs/templates.html))
-- [Stylus Documentation](https://stylus-lang.com/)
-- [Stylus Chinese Documentation](https://stylus.bootcss.com/)
-- [Pug Template Engine Chinese Documentation](https://www.pugjs.cn/api/getting-started.html)
-- [TypeScript Documentation](https://www.typescriptlang.org/docs/)
-- [TypeScript Chinese Documentation](https://www.tslang.cn/docs/home.html)
-- [Easy Hexo](https://easyhexo.com/)
-
-# [License](https://github.com/theme-shoka-x/hexo-theme-shokaX/blob/main/LICENSE)
-License: AGPL 3 or later
-
-## 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://contributors-img.web.app/image?repo=theme-shoka-x/hexo-theme-shokaX)](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)
-
-## Other Information
-![Star history chart](https://api.star-history.com/svg?repos=theme-shoka-x/hexo-theme-shokaX&type=Date)
+# 📣 Announcement
+* [Your sites using the ShokaX and Shoka themes may be experiencing a Supply Chain Attack.](https://github.com/theme-shoka-x/hexo-theme-shokaX/discussions/293)
+* [ShokaX is looking for community maintainers](https://github.com/theme-shoka-x/hexo-theme-shokaX/discussions/137)
+
+# 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 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 guide and plugin repository for shokaX are available at [awesome-shokaX](https://github.com/theme-shoka-x/awesome-shokaX)
+
+## Technology Stack
+![TypeScript](https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white)
+![Vue.js](https://img.shields.io/badge/vuejs-%2335495e.svg?style=for-the-badge&logo=vuedotjs&logoColor=%234FC08D)
+![Pug](https://img.shields.io/badge/Pug-FFF?style=for-the-badge&logo=pug&logoColor=A86454)
+![Stylus](https://img.shields.io/badge/stylus-%23ff6347.svg?style=for-the-badge&logo=stylus&logoColor=white)
+
+## 💬 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             | 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       |   ✅    |
+
+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/en/guide/) for the next configuration steps.
+
+## 📚 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](https://hexo.io/docs/templates.html))
+- [Stylus Documentation](https://stylus-lang.com/)
+- [Stylus Chinese Documentation](https://stylus.bootcss.com/)
+- [Pug Template Engine Chinese Documentation](https://www.pugjs.cn/api/getting-started.html)
+- [TypeScript Documentation](https://www.typescriptlang.org/docs/)
+- [TypeScript Chinese Documentation](https://www.tslang.cn/docs/home.html)
+- [Easy Hexo](https://easyhexo.com/)
+
+# [License](https://github.com/theme-shoka-x/hexo-theme-shokaX/blob/main/LICENSE)
+License: AGPL 3 or later
+
+## 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://contributors-img.web.app/image?repo=theme-shoka-x/hexo-theme-shokaX)](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)
+
+## Other Information
+![Star history chart](https://api.star-history.com/svg?repos=theme-shoka-x/hexo-theme-shokaX&type=Date)

package/UsageRestrictions.md

@@ -1,26 +1,26 @@
-# 使用限制
-感谢您使用 ShokaX 及其子项目。在使用之前，请仔细阅读并遵守以下使用限制。使用 ShokaX 及其子项目，表示您同意遵守以下规定：
-## 归属权
-1. 您需要保留页脚和控制台的主题链接。 (根据 `AGPLv3 七 (b)`)
-2. 分发 ShokaX 及其子项目的修改版本时，必须以合理的方式更改软件名称或版本号，以将其与原始版本区分开来。(根据 `AGPLv3 七 (c)`)
-
-## 责任
-1. ShokaX 及其子项目仅提供了网页的框架，对于网页内容不会也无法进行审核，因此网页内容导致的一切问题与 ShokaX 项目组无关。我们**鼓励**您发表有用且合理合法的信息。(根据`AGPLv3 七 (a)`)
-2. ShokaX 项目组**可以**在不进行任何事先告知的情况下对API进行更名、重构、添加和删除等操作，ShokaX 项目组会**尽可能**事先在文档及其他渠道中通知以便用户平滑升级。(根据`AGPLv3 七 (a)`)
-3. 使用 ShokaX 及其子项目则意味着 ShokaX 项目组不承担由 ShokaX 导致的一切问题的责任，ShokaX 项目组也不作出任何明示或暗示的保证 (根据`AGPLv3 七 (a)`)
-
-## 商业使用
-1. ShokaX 项目组不会提供企业或商业咨询服务，任何使用者获取帮助的方式都是一致的 (仅为声明)
-2. ShokaX 项目组不会制作收费版或高级版的项目，ShokaX及其子项目有且只有社区版 (仅为声明)
-
-## 处理方式
-如果您违反了上述使用限制和AGPLv3的任何规定，ShokaX 项目组保留采取以下措施之一或多个的权利：
-- 发出警告通知并要求立即纠正违规行为；(根据`AGPLv3 八`)
-- 暂停或终止您对 ShokaX 及其子项目的使用权限并取消GPLv3授予您的权利；(根据`AGPLv3 八`)
-- 取消您获取 ShokaX 社区支持和进行协作的权利；(社区管理)
-- 追究法律责任，包括要求赔偿因违规行为给 ShokaX 项目组造成的损失。(依照相关法律而定)
-
-当发生纠纷时，全部由甲方(即zkz098)所在地负责，适用中华人民共和国法律。
-
-此文件及其后续更新适用于所有版本的 ShokaX，无论其发行版内携带哪种版本的此文件或不携带此文件，均以 Github main分支储存的最新版为准。
+# 使用限制
+感谢您使用 ShokaX 及其子项目。在使用之前，请仔细阅读并遵守以下使用限制。使用 ShokaX 及其子项目，表示您同意遵守以下规定：
+## 归属权
+1. 您需要保留页脚和控制台的主题链接。 (根据 `AGPLv3 七 (b)`)
+2. 分发 ShokaX 及其子项目的修改版本时，必须以合理的方式更改软件名称或版本号，以将其与原始版本区分开来。(根据 `AGPLv3 七 (c)`)
+
+## 责任
+1. ShokaX 及其子项目仅提供了网页的框架，对于网页内容不会也无法进行审核，因此网页内容导致的一切问题与 ShokaX 项目组无关。我们**鼓励**您发表有用且合理合法的信息。(根据`AGPLv3 七 (a)`)
+2. ShokaX 项目组**可以**在不进行任何事先告知的情况下对API进行更名、重构、添加和删除等操作，ShokaX 项目组会**尽可能**事先在文档及其他渠道中通知以便用户平滑升级。(根据`AGPLv3 七 (a)`)
+3. 使用 ShokaX 及其子项目则意味着 ShokaX 项目组不承担由 ShokaX 导致的一切问题的责任，ShokaX 项目组也不作出任何明示或暗示的保证 (根据`AGPLv3 七 (a)`)
+
+## 商业使用
+1. ShokaX 项目组不会提供企业或商业咨询服务，任何使用者获取帮助的方式都是一致的 (仅为声明)
+2. ShokaX 项目组不会制作收费版或高级版的项目，ShokaX及其子项目有且只有社区版 (仅为声明)
+
+## 处理方式
+如果您违反了上述使用限制和AGPLv3的任何规定，ShokaX 项目组保留采取以下措施之一或多个的权利：
+- 发出警告通知并要求立即纠正违规行为；(根据`AGPLv3 八`)
+- 暂停或终止您对 ShokaX 及其子项目的使用权限并取消GPLv3授予您的权利；(根据`AGPLv3 八`)
+- 取消您获取 ShokaX 社区支持和进行协作的权利；(社区管理)
+- 追究法律责任，包括要求赔偿因违规行为给 ShokaX 项目组造成的损失。(依照相关法律而定)
+
+当发生纠纷时，全部由甲方(即zkz098)所在地负责，适用中华人民共和国法律。
+
+此文件及其后续更新适用于所有版本的 ShokaX，无论其发行版内携带哪种版本的此文件或不携带此文件，均以 Github main分支储存的最新版为准。
 如果本文件内容与 Github main 分支最新版有冲突的，本文件冲突部分无效，按照 Github main 分支最新版执行