-
Notifications
You must be signed in to change notification settings - Fork 43
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
58 additions
and
98 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,91 +1,75 @@ | ||
| # 📣 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) | ||
| [Your ShokaX and Shoka sites might be under a supply chain attack](https://github.com/theme-shoka-x/hexo-theme-shokaX/discussions/293) \ | ||
| [Survey on ShokaX deployment platform and Astro migration](https://github.com/theme-shoka-x/hexo-theme-shokaX/discussions/229) | ||
|
|
||
| # hexo-theme-shokaX | ||
|  | ||
|  | ||
|  | ||
|  | ||
|
|
||
| #### 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. | ||
| #### Language: Simplified Chinese | [English](./README_en.MD) \ | ||
| This project is a secondary development version of Shoka (considered a spiritual successor), dedicated to improving performance and optimizing the custom modification experience. \ | ||
| The reason for its creation is that Shoka hasn't been updated for three 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 | ||
|  | ||
|  | ||
|  | ||
|  | ||
| ShokaX's community resource guide and plugin repository can be found at [awesome-shokaX](https://github.com/theme-shoka-x/awesome-shokaX). | ||
|
|
||
| ## 💬 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. | ||
| The original Shoka used javascript+Native+nunjucks technology, \ | ||
| while ShokaX uses typescript+Vue 3+Pug technology. \ | ||
| Many inaccessible CDN links have been changed. | ||
|
|
||
| ## ✨ 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 | ✅ | | ||
| | Feature Name | Status | Feature Name | Status | | ||
| |:--------------------------------:|:------:|:----------------------------:|:------:| | ||
| | PWA Support | ✅ | JSD Split | ✅ | | ||
| | API Injection | ✅ | Community Plugin System | ✅ | | ||
| | Custom Fonts | ✅* | Custom Styles | ✅* | | ||
| | Multiple Comment Systems Support | ✅ | AI-Generated Article Summary | 🔬 | | ||
| | Footer 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/) | ||
| - *: Requires API injection | ||
| - 🔬: Experimental, may have issues | ||
|
|
||
| ## 🔧 How to Install? | ||
| Note: This project requires node.js version 18.x or higher to run. \ | ||
| See the [installation guide](https://docs-hexo.shokax.top/getting-started/) in the documentation. | ||
|
|
||
| ## 📚 Sub-Projects | ||
| - [ShokaX docs](https://github.com/theme-shoka-x/shokaX-docs) ShokaX theme documentation (currently being written, feel free to join!) | ||
| - [HRMNMI](https://github.com/theme-shoka-x/hexo-renderer-multi-next-markdown-it) Markdown renderer used by ShokaX (awaiting refactoring) | ||
| - [ShokaX Pjax](https://github.com/theme-shoka-x/theme-shokax-pjax) Efficient Pjax implementation provided by ShokaX | ||
| - [ShokaX Anime](https://github.com/theme-shoka-x/theme-shokax-anime) Simplified version of Anime.js provided by ShokaX | ||
|
|
||
| # [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. | ||
| ## Special Notes | ||
| The AGPL license primarily aims to restrict modified distribution behavior to avoid unauthorized secondary modifications and commercial packaging. \ | ||
| Any modifications to the source code **must** be open-sourced because, according to the AGPL license, building a website requires the modified portions to be open-sourced. | ||
|
|
||
| ## 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. | ||
| ## Special Usage Instructions | ||
| According to AGPLv3 Section 7, we have added some additional terms: \ | ||
| Please see [Usage Restrictions](./UsageRestrictions.md). By using ShokaX, you acknowledge this file's content. | ||
|
|
||
| # Acknowledgments | ||
| # Acknowledgements | ||
| ## Open Source Projects | ||
| | Name | Author | Description | | ||
| |:----------------:|:-----------------:|:--------------------------------------------:| | ||
| | Hexo | Hexo contributors | Provided a solid foundation for this project | | ||
| | Hexo | Hexo contributors | Provided a great 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) | ||
| Hexo theme: \ | ||
| [](https://github.com/theme-shoka-x/hexo-theme-shokaX/graphs/contributors) \ | ||
| ShokaX documentation: \ | ||
| [](https://github.com/theme-shoka-x/shokaX-docs/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 | ||
|  | ||
|  |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -373,9 +373,9 @@ vendors: | |
| pace: bytedance|pace/1.2.4/pace.min.js | ||
| async_js: | ||
| fancybox: bytedance|??jquery/3.5.1/jquery.min.js,fancybox/3.5.7/jquery.fancybox.min.js,justifiedGallery/3.8.1/js/jquery.justifiedGallery.min.js | ||
| # copy_tex: npm_webcache|[email protected]/dist/contrib/copy-tex.min.js | ||
| copy_tex: npm_webcache|[email protected]/dist/contrib/copy-tex.min.js | ||
| css: | ||
| # katex: npm_webcache|[email protected]/dist/katex.min.css | ||
| katex: npm_webcache|[email protected]/dist/katex.min.css | ||
| comment: css/comment.css | ||
| fancybox: npm_webcache|@fancyapps/[email protected]/dist/jquery.fancybox.min.css | ||
| justifiedGallery: npm_webcache|[email protected]/dist/css/justifiedGallery.min.css | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| { | ||
| "name": "hexo-theme-shokax", | ||
| "version": "0.4.6-dev6", | ||
| "version": "0.4.6", | ||
| "description": "a hexo theme based on shoka", | ||
| "main": "index.js", | ||
| "repository": "https://github.com/theme-shoka-x/hexo-theme-shokaX", | ||
|
|
@@ -9,41 +9,40 @@ | |
| "packageManager": "[email protected]", | ||
| "scripts": { | ||
| "test": "tsc --build --verbose", | ||
| "build": "node ./toolbox/compiler.mjs", | ||
| "install": "node ./toolbox/hoistdep.mjs" | ||
| "build": "node ./toolbox/compiler.mjs" | ||
| }, | ||
| "devDependencies": { | ||
| "@types/fancybox": "^3.5.7", | ||
| "@types/jquery": "^3.5.30", | ||
| "@types/js-yaml": "^4.0.9", | ||
| "@types/katex": "^0.16.7", | ||
| "@types/node": "^20.14.8", | ||
| "@types/node": "^20.14.9", | ||
| "@types/quicklink": "^2.3.4", | ||
| "@typescript-eslint/eslint-plugin": "^7.13.1", | ||
| "@typescript-eslint/parser": "^7.13.1", | ||
| "eslint": "^9.5.0", | ||
| "@typescript-eslint/eslint-plugin": "^7.15.0", | ||
| "@typescript-eslint/parser": "^7.15.0", | ||
| "eslint": "^9.6.0", | ||
| "eslint-config-standard": "~17", | ||
| "eslint-plugin-import": "^2.29.1", | ||
| "eslint-plugin-n": "^17.9.0", | ||
| "eslint-plugin-promise": "^6.2.0", | ||
| "eslint-plugin-vue": "^9.26.0", | ||
| "typescript": "^5.5.2" | ||
| "eslint-plugin-promise": "^6.4.0", | ||
| "eslint-plugin-vue": "^9.27.0", | ||
| "typescript": "^5.5.3" | ||
| }, | ||
| "dependencies": { | ||
| "@algolia/client-search": "^4.23.3", | ||
| "@waline/client": "^3.2.2", | ||
| "algoliasearch": "4.23.3", | ||
| "esbuild": "^0.21.5", | ||
| "hexo": "7.2.0", | ||
| "hexo-algoliasearch": "latest", | ||
| "hexo-feed": "latest", | ||
| "hexo-algoliasearch": "^2.0.1", | ||
| "hexo-feed": "^1.1.2", | ||
| "hexo-fs": "^4.1.3", | ||
| "hexo-pagination": "^3.0.0", | ||
| "hexo-renderer-pug": "latest", | ||
| "hexo-renderer-pug": "^3.0.0", | ||
| "hexo-util": "^3.3.0", | ||
| "instantsearch.js": "^4.72.1", | ||
| "js-yaml": "^4.1.0", | ||
| "katex": "^0.16.10", | ||
| "katex": "^0.16.11", | ||
| "mouse-firework": "^0.0.5", | ||
| "quicklink": "^2.3.0", | ||
| "theme-shokax-anime": "^0.0.6", | ||
|
|
||