hexo-theme-shokax 0.4.6-dev5 → 0.4.6

Sign up to get free protection for your applications and to get access to all the features.
Files changed (186) hide show
  1. package/CODE_OF_CONDUCT.md +128 -128
  2. package/CONTRIBUTING.md +58 -58
  3. package/LICENSE +660 -660
  4. package/LICENSE-shoka +21 -21
  5. package/README.md +76 -99
  6. package/README_en.MD +75 -91
  7. package/UsageRestrictions.md +25 -25
  8. package/_config.yml +381 -381
  9. package/_images.yml +9 -9
  10. package/eslint.config.mjs +55 -55
  11. package/languages/README.md +19 -19
  12. package/languages/default.yml +1 -1
  13. package/languages/en.yml +153 -153
  14. package/languages/ja.yml +153 -153
  15. package/languages/zh-CN.yml +153 -153
  16. package/languages/zh-HK.yml +153 -153
  17. package/languages/zh-TW.yml +153 -153
  18. package/layout/_alternate/atom.ejs +30 -30
  19. package/layout/_alternate/json.ejs +16 -16
  20. package/layout/_alternate/rss.ejs +34 -34
  21. package/layout/_mixin/breadcrumb.pug +33 -33
  22. package/layout/_mixin/card.pug +38 -38
  23. package/layout/_mixin/comment.pug +6 -6
  24. package/layout/_mixin/postmeta.pug +29 -29
  25. package/layout/_mixin/segment.pug +35 -35
  26. package/layout/_mixin/sidebar.pug +40 -40
  27. package/layout/_mixin/widgets.pug +28 -28
  28. package/layout/_partials/footer.pug +43 -43
  29. package/layout/_partials/head/head.pug +55 -55
  30. package/layout/_partials/head/head_com.pug +24 -24
  31. package/layout/_partials/head/pwa.pug +18 -18
  32. package/layout/_partials/header.pug +18 -18
  33. package/layout/_partials/layout.pug +140 -140
  34. package/layout/_partials/loading.pug +13 -13
  35. package/layout/_partials/pagination.pug +4 -4
  36. package/layout/_partials/post/copyright.pug +20 -20
  37. package/layout/_partials/post/footer.pug +17 -17
  38. package/layout/_partials/post/nav.pug +13 -13
  39. package/layout/_partials/post/post.pug +41 -41
  40. package/layout/_partials/post/reward.pug +18 -18
  41. package/layout/_partials/sidebar/menu.pug +37 -37
  42. package/layout/_partials/sidebar/overview.pug +42 -42
  43. package/layout/_partials/third-party/baidu-analytics.pug +11 -11
  44. package/layout/_partials/third-party/clarity.pug +8 -8
  45. package/layout/_partials/third-party/google-analytics.pug +9 -9
  46. package/layout/archive.pug +118 -118
  47. package/layout/category.pug +59 -59
  48. package/layout/index.pug +33 -33
  49. package/layout/page.pug +55 -55
  50. package/layout/post.pug +36 -36
  51. package/layout/tag.pug +43 -43
  52. package/package.json +72 -72
  53. package/scripts/filters/locals.js +52 -0
  54. package/scripts/filters/post.js +5 -0
  55. package/scripts/generaters/archive.js +133 -0
  56. package/scripts/generaters/config.js +51 -0
  57. package/scripts/generaters/images.js +23 -0
  58. package/scripts/generaters/index.js +107 -0
  59. package/scripts/generaters/pages.js +15 -0
  60. package/scripts/generaters/script.js +156 -0
  61. package/scripts/helpers/asset.js +73 -0
  62. package/scripts/helpers/engine.js +177 -0
  63. package/scripts/helpers/list_categories.js +80 -0
  64. package/scripts/helpers/summary_ai.js +107 -0
  65. package/scripts/helpers/symbols_count_time.js +69 -0
  66. package/scripts/plugin/check.js +32 -0
  67. package/scripts/plugin/index.js +81 -0
  68. package/scripts/plugin/lib/injects-point.js +20 -0
  69. package/scripts/plugin/lib/injects.js +89 -0
  70. package/scripts/tags/links.js +44 -0
  71. package/scripts/tags/media.js +19 -0
  72. package/scripts/utils.js +13 -0
  73. package/source/assets/algolia_logo.svg +9 -9
  74. package/source/assets/logo.svg +16 -16
  75. package/source/css/_colors.styl +207 -207
  76. package/source/css/_common/components/components.styl +6 -6
  77. package/source/css/_common/components/highlight/highlight.styl +357 -357
  78. package/source/css/_common/components/highlight/operation.styl +21 -21
  79. package/source/css/_common/components/pages/collapse.styl +119 -119
  80. package/source/css/_common/components/pages/home.styl +391 -391
  81. package/source/css/_common/components/pages/pages.styl +56 -56
  82. package/source/css/_common/components/pages/tag-cloud.styl +12 -12
  83. package/source/css/_common/components/post/breadcrumb.styl +39 -39
  84. package/source/css/_common/components/post/copyright.styl +41 -41
  85. package/source/css/_common/components/post/expand.styl +263 -263
  86. package/source/css/_common/components/post/footer.styl +11 -11
  87. package/source/css/_common/components/post/header.styl +79 -79
  88. package/source/css/_common/components/post/nav.styl +64 -64
  89. package/source/css/_common/components/post/post.styl +29 -29
  90. package/source/css/_common/components/post/reward.styl +50 -50
  91. package/source/css/_common/components/post/rtl.styl +12 -12
  92. package/source/css/_common/components/post/tags.styl +39 -39
  93. package/source/css/_common/components/tags/collapse.styl +72 -72
  94. package/source/css/_common/components/tags/container.styl +49 -49
  95. package/source/css/_common/components/tags/label.styl +12 -12
  96. package/source/css/_common/components/tags/links.styl +77 -77
  97. package/source/css/_common/components/tags/list.styl +131 -131
  98. package/source/css/_common/components/tags/note.styl +70 -70
  99. package/source/css/_common/components/tags/player.styl +361 -361
  100. package/source/css/_common/components/tags/quiz.styl +200 -200
  101. package/source/css/_common/components/tags/tabs.styl +89 -89
  102. package/source/css/_common/components/tags/tags.styl +9 -9
  103. package/source/css/_common/components/third-party/loading.styl +222 -222
  104. package/source/css/_common/components/third-party/mermaid/class.styl +90 -90
  105. package/source/css/_common/components/third-party/mermaid/flowchart.styl +72 -72
  106. package/source/css/_common/components/third-party/mermaid/gantt.styl +251 -251
  107. package/source/css/_common/components/third-party/mermaid/git.styl +7 -7
  108. package/source/css/_common/components/third-party/mermaid/mermaid.styl +37 -37
  109. package/source/css/_common/components/third-party/mermaid/pie.styl +9 -9
  110. package/source/css/_common/components/third-party/mermaid/sequence.styl +95 -95
  111. package/source/css/_common/components/third-party/mermaid/state.styl +130 -130
  112. package/source/css/_common/components/third-party/pace.styl +18 -18
  113. package/source/css/_common/components/third-party/search.styl +167 -167
  114. package/source/css/_common/components/third-party/theme.styl +151 -151
  115. package/source/css/_common/components/third-party/third-party.styl +22 -22
  116. package/source/css/_common/components/third-party/widgets.styl +57 -57
  117. package/source/css/_common/outline/footer/footer.styl +67 -67
  118. package/source/css/_common/outline/header/brand.styl +77 -77
  119. package/source/css/_common/outline/header/header.styl +20 -20
  120. package/source/css/_common/outline/header/image.styl +85 -85
  121. package/source/css/_common/outline/header/menu.styl +117 -117
  122. package/source/css/_common/outline/header/nav.styl +81 -81
  123. package/source/css/_common/outline/header/right.styl +15 -15
  124. package/source/css/_common/outline/header/tool.styl +207 -207
  125. package/source/css/_common/outline/header/waves.styl +57 -57
  126. package/source/css/_common/outline/mobile.styl +46 -46
  127. package/source/css/_common/outline/outline.styl +78 -78
  128. package/source/css/_common/outline/sidebar/author.styl +59 -59
  129. package/source/css/_common/outline/sidebar/dimmer.styl +23 -23
  130. package/source/css/_common/outline/sidebar/menu.styl +63 -63
  131. package/source/css/_common/outline/sidebar/quick.styl +43 -43
  132. package/source/css/_common/outline/sidebar/related.styl +56 -56
  133. package/source/css/_common/outline/sidebar/sidebar.styl +80 -80
  134. package/source/css/_common/outline/sidebar/social.styl +69 -69
  135. package/source/css/_common/outline/sidebar/state.styl +37 -37
  136. package/source/css/_common/outline/sidebar/tab.styl +71 -71
  137. package/source/css/_common/outline/sidebar/toc.styl +47 -47
  138. package/source/css/_common/scaffolding/animate.styl +322 -322
  139. package/source/css/_common/scaffolding/base.styl +190 -190
  140. package/source/css/_common/scaffolding/buttons.styl +48 -48
  141. package/source/css/_common/scaffolding/divider.styl +36 -36
  142. package/source/css/_common/scaffolding/iconfont.styl +443 -443
  143. package/source/css/_common/scaffolding/normalize.styl +273 -273
  144. package/source/css/_common/scaffolding/pagination.styl +81 -81
  145. package/source/css/_common/scaffolding/ribbon.styl +38 -38
  146. package/source/css/_common/scaffolding/scaffolding.styl +14 -14
  147. package/source/css/_common/scaffolding/scrollbar.styl +37 -37
  148. package/source/css/_common/scaffolding/tables.styl +50 -50
  149. package/source/css/_common/scaffolding/tip.styl +19 -19
  150. package/source/css/_common/scaffolding/toggles.styl +59 -59
  151. package/source/css/_iconfont.styl +455 -455
  152. package/source/css/_mixins.styl +148 -148
  153. package/source/css/_variables.styl +89 -89
  154. package/source/css/app.styl +41 -41
  155. package/source/css/mermaid.styl +5 -5
  156. package/source/css/optimize.styl +5 -5
  157. package/source/js/_app/components/comments.ts +88 -88
  158. package/source/js/_app/components/sidebar.ts +239 -239
  159. package/source/js/_app/components/tcomments.ts +54 -54
  160. package/source/js/_app/globals/globalVars.ts +99 -99
  161. package/source/js/_app/globals/handles.ts +124 -124
  162. package/source/js/_app/globals/themeColor.ts +63 -63
  163. package/source/js/_app/globals/thirdparty.ts +63 -63
  164. package/source/js/_app/globals/tools.ts +75 -75
  165. package/source/js/_app/library/anime.ts +110 -110
  166. package/source/js/_app/library/declare.d.ts +128 -128
  167. package/source/js/_app/library/dom.ts +28 -28
  168. package/source/js/_app/library/loadFile.ts +47 -47
  169. package/source/js/_app/library/proto.ts +137 -137
  170. package/source/js/_app/library/scriptPjax.ts +72 -72
  171. package/source/js/_app/library/storage.ts +12 -12
  172. package/source/js/_app/library/vue.ts +49 -49
  173. package/source/js/_app/page/common.ts +43 -43
  174. package/source/js/_app/page/fancybox.ts +72 -72
  175. package/source/js/_app/page/post.ts +266 -266
  176. package/source/js/_app/page/search.ts +115 -115
  177. package/source/js/_app/page/tab.ts +60 -60
  178. package/source/js/_app/pjax/domInit.ts +97 -97
  179. package/source/js/_app/pjax/refresh.ts +140 -140
  180. package/source/js/_app/pjax/siteInit.ts +106 -106
  181. package/source/js/_app/player.ts +798 -798
  182. package/toolbox/compiler.mjs +10 -6
  183. package/toolbox/hoistdep.mjs +5 -5
  184. package/toolbox/lib.mjs +63 -63
  185. package/index.html +0 -231
  186. package/meta.json +0 -6431
package/LICENSE-shoka CHANGED
@@ -1,21 +1,21 @@
1
- MIT License
2
-
3
- Copyright (c) 2020 霜月琉璃
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- SOFTWARE.
1
+ MIT License
2
+
3
+ Copyright (c) 2020 霜月琉璃
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,99 +1,76 @@
1
- # 📣 公告
2
- [你的 ShokaX 和 Shoka 站点可能正在遭遇供应链攻击](https://github.com/theme-shoka-x/hexo-theme-shokaX/discussions/293) \
3
- [关于 ShokaX 部署平台和 Astro 迁移的调查](https://github.com/theme-shoka-x/hexo-theme-shokaX/discussions/229)
4
-
5
- # hexo-theme-shokaX
6
- ![LICENSE]( https://img.shields.io/github/license/theme-shoka-x/hexo-theme-shokaX)
7
- ![stars](https://img.shields.io/github/stars/theme-shoka-x/hexo-theme-shokaX)
8
- ![version](https://shields.io/npm/v/hexo-theme-shokax)
9
- ![build](https://img.shields.io/github/actions/workflow/status/theme-shoka-x/hexo-theme-shokaX/build-theme.yml)
10
-
11
- #### 语言(language): 简体中文 | [English](./README_en.MD) \
12
- 此项目是shoka的一个二次开发版(算精神续作),致力于提高性能和优化魔改体验 \
13
- 诞生原因是目前shoka已经三年没有更新了,积压了大量BUG和功能请求。
14
-
15
- shokaX的社区资源导航和插件仓库为[awesome-shokaX](https://github.com/theme-shoka-x/awesome-shokaX)
16
-
17
- ## 技术栈
18
- ![TypeScript](https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white)
19
- ![Vue.js](https://img.shields.io/badge/vuejs-%2335495e.svg?style=for-the-badge&logo=vuedotjs&logoColor=%234FC08D)
20
- ![Pug](https://img.shields.io/badge/Pug-FFF?style=for-the-badge&logo=pug&logoColor=A86454)
21
- ![Stylus](https://img.shields.io/badge/stylus-%23ff6347.svg?style=for-the-badge&logo=stylus&logoColor=white)
22
-
23
- ## 💬 和shoka的区别
24
- 原先shoka使用了javascript+Native+nunjucks的技术 \
25
- 而shokaX则使用了typescript+Vue 3+Pug的技术搭配 \
26
- 更改了大量难以访问的CDN链接
27
-
28
- ## ✨ 功能清单
29
-
30
- | 功能名称 | 实现状态 | 功能名称 | 实现状态 |
31
- |:--------:|:----:|:------------:|:----:|
32
- | PWA支持 | ✅ | JSD拆分 | ✅ |
33
- | 注入API | ✅ | 社区插件系统 | ✅ |
34
- | 自定义字体 | ✅* | 自定义样式 | ✅* |
35
- | 多种评论系统支持 | ✅ | AI生成文章概括 | 🔬 |
36
- | 底部备案号 | ✅ | 自定义页尾 | ✅* |
37
- | CSS渐变封面 | ✅ | typescript支持 | ✅ |
38
-
39
- 备注:
40
- - *: 需要使用注入API实现
41
- - 🔬: 实验中,可能存在问题
42
-
43
-
44
- ## 🔧 如何安装?
45
- 注意: 本项目需要 node.js 18.x 或更高版本才能运行 \
46
- 建议使用[ShokaX-CLI](https://github.com/zkz098/shokaX-CLI) ,执行下列命令即可:
47
- ```bash
48
- npm i shokax-cli --location=global
49
- # hexo init 初始化环境
50
- SXC install shokaX
51
- ```
52
- [点此](https://docs.kaitaku.xyz/guide/#%E9%85%8D%E7%BD%AE%E4%B8%BB%E9%A2%98)以进行下一步配置
53
-
54
- ## 📚子项目
55
- - [ShokaX docs](https://github.com/theme-shoka-x/shokaX-docs) ShokaX 主题文档 (正在编写中,欢迎加入!)
56
- - [HRMNMI](https://github.com/theme-shoka-x/hexo-renderer-multi-next-markdown-it) ShokaX 正在使用的 markdown 渲染器 (等待重构)
57
- - [ShokaX CLI](https://github.com/theme-shoka-x/shokaX-CLI) ShokaX 命令行安装程序
58
- - [ShokaX Pjax](https://github.com/theme-shoka-x/theme-shokax-pjax) ShokaX 提供的高效 Pjax 实现
59
- - [ShokaX Anime](https://github.com/theme-shoka-x/theme-shokax-anime) ShokaX 提供的精简版 Anime.js 实现
60
-
61
- ## 🛠️二次开发
62
- [ShokaX官方开发文档](https://docs.kaitaku.xyz/develop/basic/)
63
-
64
- 参与开发建议阅读的文档:
65
- - [Hexo 官方文档](https://hexo.io/zh-cn/docs/templates)
66
- - [Stylus 中文网](http://stylus.bootcss.com/)
67
- - [Pug 模板引擎中文文档](https://www.pugjs.cn/api/getting-started.html)
68
- - [Typescript 中文网](https://www.tslang.cn/docs/home.html)
69
- - [Easy hexo](https://easyhexo.com/)
70
-
71
- # [许可证](https://github.com/theme-shoka-x/hexo-theme-shokaX/blob/main/LICENSE)
72
- 许可证: AGPL 3 or later
73
-
74
- ## 特别说明
75
- AGPL许可证主要目的是限制修改后的分发行为,避免未经许可的二次修改封装商业行为 \
76
- 仅修改源代码**需要**开源,因为根据AGPL许可,搭建网站需要开源修改部分
77
-
78
- ## 使用特殊说明
79
- 依照AGPLv3 Section 7,我们添加了一些附加条款:
80
- 请查看[使用限制](./UsageRestrictions.md),使用ShokaX则默认您已知晓此文件内容
81
-
82
- # 致谢名单
83
- ## 开源项目
84
- | 名称 | 作者 | 描述 |
85
- |:-----------------|:------------------|:-------------------|
86
- | Hexo | Hexo contributors | 为本项目提供了良好的基础 |
87
- | hexo-theme-shoka | amehime | 本项目的父主题 |
88
-
89
- ## 开发者们
90
- Hexo 主题: \
91
- [![](https://contributors-img.web.app/image?repo=theme-shoka-x/hexo-theme-shokaX)](https://github.com/theme-shoka-x/hexo-theme-shokaX/graphs/contributors) \
92
- ShokaX 文档: \
93
- [![](https://contributors-img.web.app/image?repo=theme-shoka-x/shokaX-docs)](https://github.com/theme-shoka-x/shokaX-docs/graphs/contributors) \
94
-
95
- ## 特别鸣谢
96
- [<img src="https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.png" width="25%">](https://jb.gg/OpenSourceSupport)
97
-
98
- ## 其他信息
99
- ![Star history chart](https://api.star-history.com/svg?repos=theme-shoka-x/hexo-theme-shokaX&type=Date)
1
+ # 📣 公告
2
+ [你的 ShokaX 和 Shoka 站点可能正在遭遇供应链攻击](https://github.com/theme-shoka-x/hexo-theme-shokaX/discussions/293) \
3
+ [关于 ShokaX 部署平台和 Astro 迁移的调查](https://github.com/theme-shoka-x/hexo-theme-shokaX/discussions/229)
4
+
5
+ # hexo-theme-shokaX
6
+ ![LICENSE]( https://img.shields.io/github/license/theme-shoka-x/hexo-theme-shokaX)
7
+ ![stars](https://img.shields.io/github/stars/theme-shoka-x/hexo-theme-shokaX)
8
+ ![version](https://shields.io/npm/v/hexo-theme-shokax)
9
+ ![build](https://img.shields.io/github/actions/workflow/status/theme-shoka-x/hexo-theme-shokaX/build-theme.yml)
10
+
11
+ #### 语言(language): 简体中文 | [English](./README_en.MD) \
12
+ 此项目是shoka的一个二次开发版(算精神续作),致力于提高性能和优化魔改体验 \
13
+ 诞生原因是目前shoka已经三年没有更新了,积压了大量BUG和功能请求。
14
+
15
+ shokaX的社区资源导航和插件仓库为[awesome-shokaX](https://github.com/theme-shoka-x/awesome-shokaX)
16
+
17
+ ## 💬 和shoka的区别
18
+ 原先shoka使用了javascript+Native+nunjucks的技术 \
19
+ 而shokaX则使用了typescript+Vue 3+Pug的技术搭配 \
20
+ 更改了大量难以访问的CDN链接
21
+
22
+ ## ✨ 功能清单
23
+
24
+ | 功能名称 | 实现状态 | 功能名称 | 实现状态 |
25
+ |:--------:|:----:|:------------:|:----:|
26
+ | PWA支持 | ✅ | JSD拆分 | ✅ |
27
+ | 注入API | ✅ | 社区插件系统 | ✅ |
28
+ | 自定义字体 | ✅* | 自定义样式 | ✅* |
29
+ | 多种评论系统支持 | ✅ | AI生成文章概括 | 🔬 |
30
+ | 底部备案号 | ✅ | 自定义页尾 | ✅* |
31
+ | CSS渐变封面 | ✅ | typescript支持 | ✅ |
32
+
33
+ 备注:
34
+ - *: 需要使用注入API实现
35
+ - 🔬: 实验中,可能存在问题
36
+
37
+
38
+ ## 🔧 如何安装?
39
+ 注意: 本项目需要 node.js 18.x 或更高版本才能运行 \
40
+ 见文档中[如何安装](https://docs-hexo.shokax.top/getting-started/)部分
41
+
42
+ ## 📚子项目
43
+ - [ShokaX docs](https://github.com/theme-shoka-x/shokaX-docs) ShokaX 主题文档 (正在编写中,欢迎加入!)
44
+ - [HRMNMI](https://github.com/theme-shoka-x/hexo-renderer-multi-next-markdown-it) ShokaX 正在使用的 markdown 渲染器 (等待重构)
45
+ - [ShokaX Pjax](https://github.com/theme-shoka-x/theme-shokax-pjax) ShokaX 提供的高效 Pjax 实现
46
+ - [ShokaX Anime](https://github.com/theme-shoka-x/theme-shokax-anime) ShokaX 提供的精简版 Anime.js 实现
47
+
48
+ # [许可证](https://github.com/theme-shoka-x/hexo-theme-shokaX/blob/main/LICENSE)
49
+ 许可证: AGPL 3 or later
50
+
51
+ ## 特别说明
52
+ AGPL许可证主要目的是限制修改后的分发行为,避免未经许可的二次修改封装商业行为 \
53
+ 仅修改源代码**需要**开源,因为根据AGPL许可,搭建网站需要开源修改部分
54
+
55
+ ## 使用特殊说明
56
+ 依照AGPLv3 Section 7,我们添加了一些附加条款:
57
+ 请查看[使用限制](./UsageRestrictions.md),使用ShokaX则默认您已知晓此文件内容
58
+
59
+ # 致谢名单
60
+ ## 开源项目
61
+ | 名称 | 作者 | 描述 |
62
+ |:-----------------|:------------------|:-------------------|
63
+ | Hexo | Hexo contributors | 为本项目提供了良好的基础 |
64
+ | hexo-theme-shoka | amehime | 本项目的父主题 |
65
+
66
+ ## 开发者们
67
+ Hexo 主题: \
68
+ [![](https://contributors-img.web.app/image?repo=theme-shoka-x/hexo-theme-shokaX)](https://github.com/theme-shoka-x/hexo-theme-shokaX/graphs/contributors) \
69
+ ShokaX 文档: \
70
+ [![](https://contributors-img.web.app/image?repo=theme-shoka-x/shokaX-docs)](https://github.com/theme-shoka-x/shokaX-docs/graphs/contributors) \
71
+
72
+ ## 特别鸣谢
73
+ [<img src="https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.png" width="25%">](https://jb.gg/OpenSourceSupport)
74
+
75
+ ## 其他信息
76
+ ![Star history chart](https://api.star-history.com/svg?repos=theme-shoka-x/hexo-theme-shokaX&type=Date)
package/README_en.MD CHANGED
@@ -1,91 +1,75 @@
1
- # 📣 Announcement
2
- * [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)
3
- * [ShokaX is looking for community maintainers](https://github.com/theme-shoka-x/hexo-theme-shokaX/discussions/137)
4
-
5
- # hexo-theme-shokaX
6
- ![LICENSE](https://img.shields.io/github/license/theme-shoka-x/hexo-theme-shokaX)
7
- ![stars](https://img.shields.io/github/stars/theme-shoka-x/hexo-theme-shokaX)
8
- ![version](https://shields.io/npm/v/hexo-theme-shokax)
9
- ![build](https://img.shields.io/github/actions/workflow/status/theme-shoka-x/hexo-theme-shokaX/build-theme.yml)
10
-
11
- #### Language: [简体中文](./README.md) | English \
12
- This project is a fork (spiritual successor) of Shoka, aimed at improving performance and optimizing the modified experience. \
13
- The reason for its creation is that Shoka has not been updated for two years, accumulating a large number of bugs and feature requests.
14
-
15
- The community resource guide and plugin repository for shokaX are available at [awesome-shokaX](https://github.com/theme-shoka-x/awesome-shokaX)
16
-
17
- ## Technology Stack
18
- ![TypeScript](https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white)
19
- ![Vue.js](https://img.shields.io/badge/vuejs-%2335495e.svg?style=for-the-badge&logo=vuedotjs&logoColor=%234FC08D)
20
- ![Pug](https://img.shields.io/badge/Pug-FFF?style=for-the-badge&logo=pug&logoColor=A86454)
21
- ![Stylus](https://img.shields.io/badge/stylus-%23ff6347.svg?style=for-the-badge&logo=stylus&logoColor=white)
22
-
23
- ## 💬 Differences from Shoka
24
- The original Shoka used a combination of JavaScript + Native + Nunjucks technologies. \
25
- ShokaX, on the other hand, uses TypeScript + Vue 3 + Pug technologies and has changed many hard-to-access CDN links.
26
-
27
- ## Feature List
28
-
29
- | Feature | Status | Feature | Status |
30
- |:-------------------------------:|:------:|:------------------------------:|:------:|
31
- | PWA Support | ✅ | JSD Split | ✅ |
32
- | Injection API | ✅ | Community Plugin System | ✅ |
33
- | Custom Fonts | ✅* | Custom Styles | ✅* |
34
- | Multiple Comment System Support | ✅ | AI-generated Article Summaries | 🔬 |
35
- | Bottom Record Number | ✅ | Custom Footer | ✅* |
36
- | CSS Gradient Cover | ✅ | TypeScript Support | ✅ |
37
-
38
- Notes:
39
- - *: Requires implementation using Injection API
40
- - 🔬: In experimentation, may have issues
41
-
42
- ## 🔧 How to Install
43
- Note: This project requires node.js 18.x or higher to run. \
44
- It is recommended to use [ShokaX-CLI](https://github.com/zkz098/shokaX-CLI) \
45
- [Click here](https://docs.kaitaku.xyz/en/guide/) for the next configuration steps.
46
-
47
- ## 📚 Sub-projects
48
- - [ShokaX docs](https://github.com/theme-shoka-x/shokaX-docs) ShokaX Theme Documentation (work in progress, contributions welcome!)
49
- - [HRMNMI](https://github.com/theme-shoka-x/hexo-renderer-multi-next-markdown-it) The markdown renderer used by ShokaX (awaiting refactoring)
50
- - [ShokaX CLI](https://github.com/theme-shoka-x/shokaX-CLI) ShokaX Command Line Installer
51
- - [ShokaX Pjax](https://github.com/theme-shoka-x/theme-shokax-pjax) Efficient Pjax implementation by ShokaX
52
- - [ShokaX Anime](https://github.com/theme-shoka-x/theme-shokax-anime) Minimalistic Anime.js implementation by ShokaX
53
-
54
- ## 🛠️ Development
55
- [ShokaX Official Development Documentation](https://docs.kaitaku.xyz/develop/basic/)
56
-
57
- Recommended reading for contributing:
58
- - [Hexo Official Documentation]([https://hexo.io/zh-cn/docs/templates](https://hexo.io/docs/templates.html))
59
- - [Stylus Documentation](https://stylus-lang.com/)
60
- - [Stylus Chinese Documentation](https://stylus.bootcss.com/)
61
- - [Pug Template Engine Chinese Documentation](https://www.pugjs.cn/api/getting-started.html)
62
- - [TypeScript Documentation](https://www.typescriptlang.org/docs/)
63
- - [TypeScript Chinese Documentation](https://www.tslang.cn/docs/home.html)
64
- - [Easy Hexo](https://easyhexo.com/)
65
-
66
- # [License](https://github.com/theme-shoka-x/hexo-theme-shokaX/blob/main/LICENSE)
67
- License: AGPL 3 or later
68
-
69
- ## Special Note
70
- The primary purpose of the AGPL license is to restrict distribution after modification, preventing unauthorized secondary modification for commercial purposes. \
71
- Modifications to the source code **must** be open-sourced, as per the AGPL license. Building a website requires open-sourcing modified parts.
72
-
73
- ## Usage Special Note
74
- In accordance with AGPLv3 Section 7, we have added some additional terms. \
75
- Please see [Usage Restrictions](./UsageRestrictions.md). Using ShokaX implies that you are aware of the contents of this file.
76
-
77
- # Acknowledgments
78
- ## Open Source Projects
79
- | Name | Author | Description |
80
- |:----------------:|:-----------------:|:--------------------------------------------:|
81
- | Hexo | Hexo contributors | Provided a solid foundation for this project |
82
- | hexo-theme-shoka | amehime | Parent theme of this project |
83
-
84
- ## Developers
85
- [![](https://contributors-img.web.app/image?repo=theme-shoka-x/hexo-theme-shokaX)](https://github.com/theme-shoka-x/hexo-theme-shokaX/graphs/contributors)
86
-
87
- ## Special Thanks
88
- [<img src="https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.png" width="25%">](https://jb.gg/OpenSourceSupport)
89
-
90
- ## Other Information
91
- ![Star history chart](https://api.star-history.com/svg?repos=theme-shoka-x/hexo-theme-shokaX&type=Date)
1
+ # 📣 Announcement
2
+ [Your ShokaX and Shoka sites might be under a supply chain attack](https://github.com/theme-shoka-x/hexo-theme-shokaX/discussions/293) \
3
+ [Survey on ShokaX deployment platform and Astro migration](https://github.com/theme-shoka-x/hexo-theme-shokaX/discussions/229)
4
+
5
+ # hexo-theme-shokaX
6
+ ![LICENSE](https://img.shields.io/github/license/theme-shoka-x/hexo-theme-shokaX)
7
+ ![stars](https://img.shields.io/github/stars/theme-shoka-x/hexo-theme-shokaX)
8
+ ![version](https://shields.io/npm/v/hexo-theme-shokax)
9
+ ![build](https://img.shields.io/github/actions/workflow/status/theme-shoka-x/hexo-theme-shokaX/build-theme.yml)
10
+
11
+ #### Language: Simplified Chinese | [English](./README_en.MD) \
12
+ This project is a secondary development version of Shoka (considered a spiritual successor), dedicated to improving performance and optimizing the custom modification experience. \
13
+ The reason for its creation is that Shoka hasn't been updated for three years, accumulating a large number of bugs and feature requests.
14
+
15
+ ShokaX's community resource guide and plugin repository can be found at [awesome-shokaX](https://github.com/theme-shoka-x/awesome-shokaX).
16
+
17
+ ## 💬 Differences from Shoka
18
+ The original Shoka used javascript+Native+nunjucks technology, \
19
+ while ShokaX uses typescript+Vue 3+Pug technology. \
20
+ Many inaccessible CDN links have been changed.
21
+
22
+ ## ✨ Feature List
23
+
24
+ | Feature Name | Status | Feature Name | Status |
25
+ |:--------------------------------:|:------:|:----------------------------:|:------:|
26
+ | PWA Support | ✅ | JSD Split | ✅ |
27
+ | API Injection | ✅ | Community Plugin System | ✅ |
28
+ | Custom Fonts | ✅* | Custom Styles | ✅* |
29
+ | Multiple Comment Systems Support || AI-Generated Article Summary | 🔬 |
30
+ | Footer Record Number | ✅ | Custom Footer | ✅* |
31
+ | CSS Gradient Cover | ✅ | Typescript Support | ✅ |
32
+
33
+ Notes:
34
+ - *: Requires API injection
35
+ - 🔬: Experimental, may have issues
36
+
37
+ ## 🔧 How to Install?
38
+ Note: This project requires node.js version 18.x or higher to run. \
39
+ See the [installation guide](https://docs-hexo.shokax.top/getting-started/) in the documentation.
40
+
41
+ ## 📚 Sub-Projects
42
+ - [ShokaX docs](https://github.com/theme-shoka-x/shokaX-docs) ShokaX theme documentation (currently being written, feel free to join!)
43
+ - [HRMNMI](https://github.com/theme-shoka-x/hexo-renderer-multi-next-markdown-it) Markdown renderer used by ShokaX (awaiting refactoring)
44
+ - [ShokaX Pjax](https://github.com/theme-shoka-x/theme-shokax-pjax) Efficient Pjax implementation provided by ShokaX
45
+ - [ShokaX Anime](https://github.com/theme-shoka-x/theme-shokax-anime) Simplified version of Anime.js provided by ShokaX
46
+
47
+ # [License](https://github.com/theme-shoka-x/hexo-theme-shokaX/blob/main/LICENSE)
48
+ License: AGPL 3 or later
49
+
50
+ ## Special Notes
51
+ The AGPL license primarily aims to restrict modified distribution behavior to avoid unauthorized secondary modifications and commercial packaging. \
52
+ 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.
53
+
54
+ ## Special Usage Instructions
55
+ According to AGPLv3 Section 7, we have added some additional terms: \
56
+ Please see [Usage Restrictions](./UsageRestrictions.md). By using ShokaX, you acknowledge this file's content.
57
+
58
+ # Acknowledgements
59
+ ## Open Source Projects
60
+ | Name | Author | Description |
61
+ |:----------------:|:-----------------:|:--------------------------------------------:|
62
+ | Hexo | Hexo contributors | Provided a great foundation for this project |
63
+ | hexo-theme-shoka | amehime | Parent theme of this project |
64
+
65
+ ## Developers
66
+ Hexo theme: \
67
+ [![](https://contributors-img.web.app/image?repo=theme-shoka-x/hexo-theme-shokaX)](https://github.com/theme-shoka-x/hexo-theme-shokaX/graphs/contributors) \
68
+ ShokaX documentation: \
69
+ [![](https://contributors-img.web.app/image?repo=theme-shoka-x/shokaX-docs)](https://github.com/theme-shoka-x/shokaX-docs/graphs/contributors)
70
+
71
+ ## Special Thanks
72
+ [<img src="https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.png" width="25%">](https://jb.gg/OpenSourceSupport)
73
+
74
+ ## Other Information
75
+ ![Star history chart](https://api.star-history.com/svg?repos=theme-shoka-x/hexo-theme-shokaX&type=Date)
@@ -1,26 +1,26 @@
1
- # 使用限制
2
- 感谢您使用 ShokaX 及其子项目。在使用之前,请仔细阅读并遵守以下使用限制。使用 ShokaX 及其子项目,表示您同意遵守以下规定:
3
- ## 归属权
4
- 1. 您需要保留页脚和控制台的主题链接。 (根据 `AGPLv3 七 (b)`)
5
- 2. 分发 ShokaX 及其子项目的修改版本时,必须以合理的方式更改软件名称或版本号,以将其与原始版本区分开来。(根据 `AGPLv3 七 (c)`)
6
-
7
- ## 责任
8
- 1. ShokaX 及其子项目仅提供了网页的框架,对于网页内容不会也无法进行审核,因此网页内容导致的一切问题与 ShokaX 项目组无关。我们**鼓励**您发表有用且合理合法的信息。(根据`AGPLv3 七 (a)`)
9
- 2. ShokaX 项目组**可以**在不进行任何事先告知的情况下对API进行更名、重构、添加和删除等操作,ShokaX 项目组会**尽可能**事先在文档及其他渠道中通知以便用户平滑升级。(根据`AGPLv3 七 (a)`)
10
- 3. 使用 ShokaX 及其子项目则意味着 ShokaX 项目组不承担由 ShokaX 导致的一切问题的责任,ShokaX 项目组也不作出任何明示或暗示的保证 (根据`AGPLv3 七 (a)`)
11
-
12
- ## 商业使用
13
- 1. ShokaX 项目组不会提供企业或商业咨询服务,任何使用者获取帮助的方式都是一致的 (仅为声明)
14
- 2. ShokaX 项目组不会制作收费版或高级版的项目,ShokaX及其子项目有且只有社区版 (仅为声明)
15
-
16
- ## 处理方式
17
- 如果您违反了上述使用限制和AGPLv3的任何规定,ShokaX 项目组保留采取以下措施之一或多个的权利:
18
- - 发出警告通知并要求立即纠正违规行为;(根据`AGPLv3 八`)
19
- - 暂停或终止您对 ShokaX 及其子项目的使用权限并取消GPLv3授予您的权利;(根据`AGPLv3 八`)
20
- - 取消您获取 ShokaX 社区支持和进行协作的权利;(社区管理)
21
- - 追究法律责任,包括要求赔偿因违规行为给 ShokaX 项目组造成的损失。(依照相关法律而定)
22
-
23
- 当发生纠纷时,全部由甲方(即zkz098)所在地负责,适用中华人民共和国法律。
24
-
25
- 此文件及其后续更新适用于所有版本的 ShokaX,无论其发行版内携带哪种版本的此文件或不携带此文件,均以 Github main分支储存的最新版为准。
1
+ # 使用限制
2
+ 感谢您使用 ShokaX 及其子项目。在使用之前,请仔细阅读并遵守以下使用限制。使用 ShokaX 及其子项目,表示您同意遵守以下规定:
3
+ ## 归属权
4
+ 1. 您需要保留页脚和控制台的主题链接。 (根据 `AGPLv3 七 (b)`)
5
+ 2. 分发 ShokaX 及其子项目的修改版本时,必须以合理的方式更改软件名称或版本号,以将其与原始版本区分开来。(根据 `AGPLv3 七 (c)`)
6
+
7
+ ## 责任
8
+ 1. ShokaX 及其子项目仅提供了网页的框架,对于网页内容不会也无法进行审核,因此网页内容导致的一切问题与 ShokaX 项目组无关。我们**鼓励**您发表有用且合理合法的信息。(根据`AGPLv3 七 (a)`)
9
+ 2. ShokaX 项目组**可以**在不进行任何事先告知的情况下对API进行更名、重构、添加和删除等操作,ShokaX 项目组会**尽可能**事先在文档及其他渠道中通知以便用户平滑升级。(根据`AGPLv3 七 (a)`)
10
+ 3. 使用 ShokaX 及其子项目则意味着 ShokaX 项目组不承担由 ShokaX 导致的一切问题的责任,ShokaX 项目组也不作出任何明示或暗示的保证 (根据`AGPLv3 七 (a)`)
11
+
12
+ ## 商业使用
13
+ 1. ShokaX 项目组不会提供企业或商业咨询服务,任何使用者获取帮助的方式都是一致的 (仅为声明)
14
+ 2. ShokaX 项目组不会制作收费版或高级版的项目,ShokaX及其子项目有且只有社区版 (仅为声明)
15
+
16
+ ## 处理方式
17
+ 如果您违反了上述使用限制和AGPLv3的任何规定,ShokaX 项目组保留采取以下措施之一或多个的权利:
18
+ - 发出警告通知并要求立即纠正违规行为;(根据`AGPLv3 八`)
19
+ - 暂停或终止您对 ShokaX 及其子项目的使用权限并取消GPLv3授予您的权利;(根据`AGPLv3 八`)
20
+ - 取消您获取 ShokaX 社区支持和进行协作的权利;(社区管理)
21
+ - 追究法律责任,包括要求赔偿因违规行为给 ShokaX 项目组造成的损失。(依照相关法律而定)
22
+
23
+ 当发生纠纷时,全部由甲方(即zkz098)所在地负责,适用中华人民共和国法律。
24
+
25
+ 此文件及其后续更新适用于所有版本的 ShokaX,无论其发行版内携带哪种版本的此文件或不携带此文件,均以 Github main分支储存的最新版为准。
26
26
  如果本文件内容与 Github main 分支最新版有冲突的,本文件冲突部分无效,按照 Github main 分支最新版执行