hexo-theme-shokax 0.3.13 → 0.3.15

Sign up to get free protection for your applications and to get access to all the features.
Files changed (140) 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 +99 -99
  6. package/README_en.MD +90 -90
  7. package/UsageRestrictions.md +25 -25
  8. package/_config.yml +370 -370
  9. package/_images.yml +9 -9
  10. package/languages/README.md +19 -19
  11. package/languages/default.yml +1 -1
  12. package/languages/en.yml +153 -153
  13. package/languages/ja.yml +153 -153
  14. package/languages/zh-CN.yml +153 -153
  15. package/languages/zh-HK.yml +153 -153
  16. package/languages/zh-TW.yml +153 -153
  17. package/layout/_alternate/atom.ejs +30 -30
  18. package/layout/_alternate/json.ejs +16 -16
  19. package/layout/_alternate/rss.ejs +34 -34
  20. package/layout/_mixin/breadcrumb.pug +33 -33
  21. package/layout/_mixin/card.pug +38 -38
  22. package/layout/_mixin/comment.pug +41 -41
  23. package/layout/_mixin/postmeta.pug +29 -29
  24. package/layout/_mixin/segment.pug +32 -32
  25. package/layout/_mixin/sidebar.pug +40 -40
  26. package/layout/_mixin/widgets.pug +33 -33
  27. package/layout/_partials/footer.pug +42 -42
  28. package/layout/_partials/head/head.pug +57 -57
  29. package/layout/_partials/head/head_com.pug +17 -17
  30. package/layout/_partials/head/pwa.pug +18 -18
  31. package/layout/_partials/header.pug +18 -18
  32. package/layout/_partials/layout.pug +139 -139
  33. package/layout/_partials/loading.pug +13 -13
  34. package/layout/_partials/pagination.pug +4 -4
  35. package/layout/_partials/post/copyright.pug +20 -20
  36. package/layout/_partials/post/footer.pug +25 -25
  37. package/layout/_partials/post/nav.pug +13 -13
  38. package/layout/_partials/post/post.pug +41 -41
  39. package/layout/_partials/post/reward.pug +18 -18
  40. package/layout/_partials/sidebar/menu.pug +37 -37
  41. package/layout/_partials/sidebar/overview.pug +42 -42
  42. package/layout/_partials/third-party/baidu-analytics.pug +11 -11
  43. package/layout/_partials/third-party/clarity.pug +8 -8
  44. package/layout/_partials/third-party/google-analytics.pug +9 -9
  45. package/layout/archive.pug +118 -118
  46. package/layout/category.pug +59 -59
  47. package/layout/index.pug +33 -33
  48. package/layout/page.pug +55 -55
  49. package/layout/post.pug +36 -36
  50. package/layout/tag.pug +43 -43
  51. package/package.json +47 -47
  52. package/scripts/helpers/asset.js +61 -61
  53. package/scripts/plugin/check.js +2 -2
  54. package/scripts/tags/links.js +4 -4
  55. package/source/assets/algolia_logo.svg +9 -9
  56. package/source/assets/logo.svg +16 -16
  57. package/source/css/_colors.styl +207 -207
  58. package/source/css/_common/components/components.styl +6 -6
  59. package/source/css/_common/components/highlight/highlight.styl +357 -357
  60. package/source/css/_common/components/highlight/operation.styl +21 -21
  61. package/source/css/_common/components/pages/collapse.styl +119 -119
  62. package/source/css/_common/components/pages/home.styl +391 -391
  63. package/source/css/_common/components/pages/pages.styl +56 -56
  64. package/source/css/_common/components/pages/tag-cloud.styl +12 -12
  65. package/source/css/_common/components/post/breadcrumb.styl +39 -39
  66. package/source/css/_common/components/post/copyright.styl +41 -41
  67. package/source/css/_common/components/post/expand.styl +263 -263
  68. package/source/css/_common/components/post/footer.styl +11 -11
  69. package/source/css/_common/components/post/header.styl +79 -79
  70. package/source/css/_common/components/post/nav.styl +63 -63
  71. package/source/css/_common/components/post/post.styl +29 -29
  72. package/source/css/_common/components/post/reward.styl +50 -50
  73. package/source/css/_common/components/post/rtl.styl +12 -12
  74. package/source/css/_common/components/post/tags.styl +39 -39
  75. package/source/css/_common/components/tags/collapse.styl +72 -72
  76. package/source/css/_common/components/tags/container.styl +49 -49
  77. package/source/css/_common/components/tags/label.styl +12 -12
  78. package/source/css/_common/components/tags/links.styl +77 -77
  79. package/source/css/_common/components/tags/list.styl +131 -131
  80. package/source/css/_common/components/tags/note.styl +70 -70
  81. package/source/css/_common/components/tags/player.styl +361 -361
  82. package/source/css/_common/components/tags/quiz.styl +200 -200
  83. package/source/css/_common/components/tags/tabs.styl +89 -89
  84. package/source/css/_common/components/tags/tags.styl +9 -9
  85. package/source/css/_common/components/third-party/loading.styl +222 -222
  86. package/source/css/_common/components/third-party/mermaid/class.styl +90 -90
  87. package/source/css/_common/components/third-party/mermaid/flowchart.styl +72 -72
  88. package/source/css/_common/components/third-party/mermaid/gantt.styl +251 -251
  89. package/source/css/_common/components/third-party/mermaid/git.styl +7 -7
  90. package/source/css/_common/components/third-party/mermaid/mermaid.styl +37 -37
  91. package/source/css/_common/components/third-party/mermaid/pie.styl +9 -9
  92. package/source/css/_common/components/third-party/mermaid/sequence.styl +95 -95
  93. package/source/css/_common/components/third-party/mermaid/state.styl +130 -130
  94. package/source/css/_common/components/third-party/pace.styl +18 -18
  95. package/source/css/_common/components/third-party/search.styl +167 -167
  96. package/source/css/_common/components/third-party/theme.styl +151 -151
  97. package/source/css/_common/components/third-party/third-party.styl +22 -22
  98. package/source/css/_common/components/third-party/widgets.styl +57 -57
  99. package/source/css/_common/outline/footer/footer.styl +69 -69
  100. package/source/css/_common/outline/header/brand.styl +77 -77
  101. package/source/css/_common/outline/header/header.styl +20 -20
  102. package/source/css/_common/outline/header/image.styl +85 -85
  103. package/source/css/_common/outline/header/menu.styl +117 -117
  104. package/source/css/_common/outline/header/nav.styl +81 -81
  105. package/source/css/_common/outline/header/right.styl +15 -15
  106. package/source/css/_common/outline/header/tool.styl +207 -207
  107. package/source/css/_common/outline/header/waves.styl +57 -57
  108. package/source/css/_common/outline/mobile.styl +46 -46
  109. package/source/css/_common/outline/outline.styl +78 -78
  110. package/source/css/_common/outline/sidebar/author.styl +59 -59
  111. package/source/css/_common/outline/sidebar/dimmer.styl +23 -23
  112. package/source/css/_common/outline/sidebar/menu.styl +63 -63
  113. package/source/css/_common/outline/sidebar/quick.styl +43 -43
  114. package/source/css/_common/outline/sidebar/related.styl +56 -56
  115. package/source/css/_common/outline/sidebar/sidebar.styl +75 -75
  116. package/source/css/_common/outline/sidebar/social.styl +69 -69
  117. package/source/css/_common/outline/sidebar/state.styl +37 -37
  118. package/source/css/_common/outline/sidebar/tab.styl +71 -71
  119. package/source/css/_common/outline/sidebar/toc.styl +47 -47
  120. package/source/css/_common/scaffolding/animate.styl +322 -322
  121. package/source/css/_common/scaffolding/base.styl +190 -190
  122. package/source/css/_common/scaffolding/buttons.styl +48 -48
  123. package/source/css/_common/scaffolding/divider.styl +36 -36
  124. package/source/css/_common/scaffolding/iconfont.styl +443 -443
  125. package/source/css/_common/scaffolding/normalize.styl +273 -273
  126. package/source/css/_common/scaffolding/pagination.styl +81 -81
  127. package/source/css/_common/scaffolding/ribbon.styl +38 -38
  128. package/source/css/_common/scaffolding/scaffolding.styl +14 -14
  129. package/source/css/_common/scaffolding/scrollbar.styl +37 -37
  130. package/source/css/_common/scaffolding/tables.styl +50 -50
  131. package/source/css/_common/scaffolding/tip.styl +19 -19
  132. package/source/css/_common/scaffolding/toggles.styl +59 -59
  133. package/source/css/_iconfont.styl +455 -455
  134. package/source/css/_mixins.styl +148 -148
  135. package/source/css/_variables.styl +89 -89
  136. package/source/css/app.styl +41 -41
  137. package/source/css/comment.styl +3 -3
  138. package/source/css/mermaid.styl +5 -5
  139. package/source/css/optimize.styl +5 -5
  140. package/source/js/_app/pjax/refresh.js +1 -1
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,99 @@
1
- # 📣 公告
2
- [关于ShokaX markdown扩展特性的讨论](https://github.com/theme-shoka-x/hexo-theme-shokaX/discussions/177) \
3
- [关于删除部分评论系统的讨论](https://github.com/theme-shoka-x/hexo-theme-shokaX/discussions/175)
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 markdown扩展特性的讨论](https://github.com/theme-shoka-x/hexo-theme-shokaX/discussions/177) \
3
+ [关于删除部分评论系统的讨论](https://github.com/theme-shoka-x/hexo-theme-shokaX/discussions/175)
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)
package/README_en.MD CHANGED
@@ -1,90 +1,90 @@
1
- # 📣 Announcement
2
- * [ShokaX is looking for community maintainers](https://github.com/theme-shoka-x/hexo-theme-shokaX/discussions/137)
3
-
4
- # hexo-theme-shokaX
5
- ![LICENSE](https://img.shields.io/github/license/theme-shoka-x/hexo-theme-shokaX)
6
- ![stars](https://img.shields.io/github/stars/theme-shoka-x/hexo-theme-shokaX)
7
- ![version](https://shields.io/npm/v/hexo-theme-shokax)
8
- ![build](https://img.shields.io/github/actions/workflow/status/theme-shoka-x/hexo-theme-shokaX/build-theme.yml)
9
-
10
- #### Language: [简体中文](./README.md) | English \
11
- This project is a fork (spiritual successor) of Shoka, aimed at improving performance and optimizing the modified experience. \
12
- The reason for its creation is that Shoka has not been updated for two years, accumulating a large number of bugs and feature requests.
13
-
14
- The community resource guide and plugin repository for shokaX are available at [awesome-shokaX](https://github.com/theme-shoka-x/awesome-shokaX)
15
-
16
- ## Technology Stack
17
- ![TypeScript](https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white)
18
- ![Vue.js](https://img.shields.io/badge/vuejs-%2335495e.svg?style=for-the-badge&logo=vuedotjs&logoColor=%234FC08D)
19
- ![Pug](https://img.shields.io/badge/Pug-FFF?style=for-the-badge&logo=pug&logoColor=A86454)
20
- ![Stylus](https://img.shields.io/badge/stylus-%23ff6347.svg?style=for-the-badge&logo=stylus&logoColor=white)
21
-
22
- ## 💬 Differences from Shoka
23
- The original Shoka used a combination of JavaScript + Native + Nunjucks technologies. \
24
- ShokaX, on the other hand, uses TypeScript + Vue 3 + Pug technologies and has changed many hard-to-access CDN links.
25
-
26
- ## ✨ Feature List
27
-
28
- | Feature | Status | Feature | Status |
29
- |:-------------------------------:|:------:|:------------------------------:|:------:|
30
- | PWA Support | ✅ | JSD Split | ✅ |
31
- | Injection API | ✅ | Community Plugin System | ✅ |
32
- | Custom Fonts | ✅* | Custom Styles | ✅* |
33
- | Multiple Comment System Support | ✅ | AI-generated Article Summaries | 🔬 |
34
- | Bottom Record Number | ✅ | Custom Footer | ✅* |
35
- | CSS Gradient Cover | ✅ | TypeScript Support | ✅ |
36
-
37
- Notes:
38
- - *: Requires implementation using Injection API
39
- - 🔬: In experimentation, may have issues
40
-
41
- ## 🔧 How to Install
42
- Note: This project requires node.js 18.x or higher to run. \
43
- It is recommended to use [ShokaX-CLI](https://github.com/zkz098/shokaX-CLI) \
44
- [Click here](https://docs.kaitaku.xyz/en/guide/) for the next configuration steps.
45
-
46
- ## 📚 Sub-projects
47
- - [ShokaX docs](https://github.com/theme-shoka-x/shokaX-docs) ShokaX Theme Documentation (work in progress, contributions welcome!)
48
- - [HRMNMI](https://github.com/theme-shoka-x/hexo-renderer-multi-next-markdown-it) The markdown renderer used by ShokaX (awaiting refactoring)
49
- - [ShokaX CLI](https://github.com/theme-shoka-x/shokaX-CLI) ShokaX Command Line Installer
50
- - [ShokaX Pjax](https://github.com/theme-shoka-x/theme-shokax-pjax) Efficient Pjax implementation by ShokaX
51
- - [ShokaX Anime](https://github.com/theme-shoka-x/theme-shokax-anime) Minimalistic Anime.js implementation by ShokaX
52
-
53
- ## 🛠️ Development
54
- [ShokaX Official Development Documentation](https://docs.kaitaku.xyz/develop/basic/)
55
-
56
- Recommended reading for contributing:
57
- - [Hexo Official Documentation]([https://hexo.io/zh-cn/docs/templates](https://hexo.io/docs/templates.html))
58
- - [Stylus Documentation](https://stylus-lang.com/)
59
- - [Stylus Chinese Documentation](https://stylus.bootcss.com/)
60
- - [Pug Template Engine Chinese Documentation](https://www.pugjs.cn/api/getting-started.html)
61
- - [TypeScript Documentation](https://www.typescriptlang.org/docs/)
62
- - [TypeScript Chinese Documentation](https://www.tslang.cn/docs/home.html)
63
- - [Easy Hexo](https://easyhexo.com/)
64
-
65
- # [License](https://github.com/theme-shoka-x/hexo-theme-shokaX/blob/main/LICENSE)
66
- License: AGPL 3 or later
67
-
68
- ## Special Note
69
- The primary purpose of the AGPL license is to restrict distribution after modification, preventing unauthorized secondary modification for commercial purposes. \
70
- Modifications to the source code **must** be open-sourced, as per the AGPL license. Building a website requires open-sourcing modified parts.
71
-
72
- ## Usage Special Note
73
- In accordance with AGPLv3 Section 7, we have added some additional terms. \
74
- Please see [Usage Restrictions](./UsageRestrictions.md). Using ShokaX implies that you are aware of the contents of this file.
75
-
76
- # Acknowledgments
77
- ## Open Source Projects
78
- | Name | Author | Description |
79
- |:----------------:|:-----------------:|:--------------------------------------------:|
80
- | Hexo | Hexo contributors | Provided a solid foundation for this project |
81
- | hexo-theme-shoka | amehime | Parent theme of this project |
82
-
83
- ## Developers
84
- [![](https://contributors-img.web.app/image?repo=theme-shoka-x/hexo-theme-shokaX)](https://github.com/theme-shoka-x/hexo-theme-shokaX/graphs/contributors)
85
-
86
- ## Special Thanks
87
- [<img src="https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.png" width="25%">](https://jb.gg/OpenSourceSupport)
88
-
89
- ## Other Information
90
- ![Star history chart](https://api.star-history.com/svg?repos=theme-shoka-x/hexo-theme-shokaX&type=Date)
1
+ # 📣 Announcement
2
+ * [ShokaX is looking for community maintainers](https://github.com/theme-shoka-x/hexo-theme-shokaX/discussions/137)
3
+
4
+ # hexo-theme-shokaX
5
+ ![LICENSE](https://img.shields.io/github/license/theme-shoka-x/hexo-theme-shokaX)
6
+ ![stars](https://img.shields.io/github/stars/theme-shoka-x/hexo-theme-shokaX)
7
+ ![version](https://shields.io/npm/v/hexo-theme-shokax)
8
+ ![build](https://img.shields.io/github/actions/workflow/status/theme-shoka-x/hexo-theme-shokaX/build-theme.yml)
9
+
10
+ #### Language: [简体中文](./README.md) | English \
11
+ This project is a fork (spiritual successor) of Shoka, aimed at improving performance and optimizing the modified experience. \
12
+ The reason for its creation is that Shoka has not been updated for two years, accumulating a large number of bugs and feature requests.
13
+
14
+ The community resource guide and plugin repository for shokaX are available at [awesome-shokaX](https://github.com/theme-shoka-x/awesome-shokaX)
15
+
16
+ ## Technology Stack
17
+ ![TypeScript](https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white)
18
+ ![Vue.js](https://img.shields.io/badge/vuejs-%2335495e.svg?style=for-the-badge&logo=vuedotjs&logoColor=%234FC08D)
19
+ ![Pug](https://img.shields.io/badge/Pug-FFF?style=for-the-badge&logo=pug&logoColor=A86454)
20
+ ![Stylus](https://img.shields.io/badge/stylus-%23ff6347.svg?style=for-the-badge&logo=stylus&logoColor=white)
21
+
22
+ ## 💬 Differences from Shoka
23
+ The original Shoka used a combination of JavaScript + Native + Nunjucks technologies. \
24
+ ShokaX, on the other hand, uses TypeScript + Vue 3 + Pug technologies and has changed many hard-to-access CDN links.
25
+
26
+ ## ✨ Feature List
27
+
28
+ | Feature | Status | Feature | Status |
29
+ |:-------------------------------:|:------:|:------------------------------:|:------:|
30
+ | PWA Support | ✅ | JSD Split | ✅ |
31
+ | Injection API | ✅ | Community Plugin System | ✅ |
32
+ | Custom Fonts | ✅* | Custom Styles | ✅* |
33
+ | Multiple Comment System Support | ✅ | AI-generated Article Summaries | 🔬 |
34
+ | Bottom Record Number | ✅ | Custom Footer | ✅* |
35
+ | CSS Gradient Cover | ✅ | TypeScript Support | ✅ |
36
+
37
+ Notes:
38
+ - *: Requires implementation using Injection API
39
+ - 🔬: In experimentation, may have issues
40
+
41
+ ## 🔧 How to Install
42
+ Note: This project requires node.js 18.x or higher to run. \
43
+ It is recommended to use [ShokaX-CLI](https://github.com/zkz098/shokaX-CLI) \
44
+ [Click here](https://docs.kaitaku.xyz/en/guide/) for the next configuration steps.
45
+
46
+ ## 📚 Sub-projects
47
+ - [ShokaX docs](https://github.com/theme-shoka-x/shokaX-docs) ShokaX Theme Documentation (work in progress, contributions welcome!)
48
+ - [HRMNMI](https://github.com/theme-shoka-x/hexo-renderer-multi-next-markdown-it) The markdown renderer used by ShokaX (awaiting refactoring)
49
+ - [ShokaX CLI](https://github.com/theme-shoka-x/shokaX-CLI) ShokaX Command Line Installer
50
+ - [ShokaX Pjax](https://github.com/theme-shoka-x/theme-shokax-pjax) Efficient Pjax implementation by ShokaX
51
+ - [ShokaX Anime](https://github.com/theme-shoka-x/theme-shokax-anime) Minimalistic Anime.js implementation by ShokaX
52
+
53
+ ## 🛠️ Development
54
+ [ShokaX Official Development Documentation](https://docs.kaitaku.xyz/develop/basic/)
55
+
56
+ Recommended reading for contributing:
57
+ - [Hexo Official Documentation]([https://hexo.io/zh-cn/docs/templates](https://hexo.io/docs/templates.html))
58
+ - [Stylus Documentation](https://stylus-lang.com/)
59
+ - [Stylus Chinese Documentation](https://stylus.bootcss.com/)
60
+ - [Pug Template Engine Chinese Documentation](https://www.pugjs.cn/api/getting-started.html)
61
+ - [TypeScript Documentation](https://www.typescriptlang.org/docs/)
62
+ - [TypeScript Chinese Documentation](https://www.tslang.cn/docs/home.html)
63
+ - [Easy Hexo](https://easyhexo.com/)
64
+
65
+ # [License](https://github.com/theme-shoka-x/hexo-theme-shokaX/blob/main/LICENSE)
66
+ License: AGPL 3 or later
67
+
68
+ ## Special Note
69
+ The primary purpose of the AGPL license is to restrict distribution after modification, preventing unauthorized secondary modification for commercial purposes. \
70
+ Modifications to the source code **must** be open-sourced, as per the AGPL license. Building a website requires open-sourcing modified parts.
71
+
72
+ ## Usage Special Note
73
+ In accordance with AGPLv3 Section 7, we have added some additional terms. \
74
+ Please see [Usage Restrictions](./UsageRestrictions.md). Using ShokaX implies that you are aware of the contents of this file.
75
+
76
+ # Acknowledgments
77
+ ## Open Source Projects
78
+ | Name | Author | Description |
79
+ |:----------------:|:-----------------:|:--------------------------------------------:|
80
+ | Hexo | Hexo contributors | Provided a solid foundation for this project |
81
+ | hexo-theme-shoka | amehime | Parent theme of this project |
82
+
83
+ ## Developers
84
+ [![](https://contributors-img.web.app/image?repo=theme-shoka-x/hexo-theme-shokaX)](https://github.com/theme-shoka-x/hexo-theme-shokaX/graphs/contributors)
85
+
86
+ ## Special Thanks
87
+ [<img src="https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.png" width="25%">](https://jb.gg/OpenSourceSupport)
88
+
89
+ ## Other Information
90
+ ![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 分支最新版执行