hexo-theme-shokax 0.0.2-alpha1 → 0.0.2-alpha3

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+main@kaitaku.xyz.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

package/CONTRIBUTING.md

@@ -0,0 +1,56 @@
+# Contributing for hexo-theme-shokaX
+
+---
+> 请在贡献前仔细阅读本文档
+目录:
+1. [代码贡献指南](#代码贡献指南)
+2. [翻译贡献指南](#翻译贡献指南)
+3. [最后需要注意的事项](#最后需要注意的事项)
+
+# 代码贡献指南
+## 前言
+在提交代码之前,我们默认以下几点:
+1. 您已阅读并同意[BSD-3-Clause](https://opensource.org/licenses/BSD-3-Clause) 授权许可
+2. 您同意我们在未来进行授权许可更改时包含您所贡献的代码
+3. 您有对于 shokaX 所使用的相关技术和 github PR 及 actions 的基础了解
+
+有关提交的说明:
+1. 您在提交时的`commit message`应描述其改动
+2. 如果您提交的代码中包括图片资源，建议使用`webp`或`avif`格式
+3. 由于 Copilot 所生成的代码可能存在版权问题，如果您使用了 Copilot，请在 PR 正文中说明
+4. 条件允许的情况下代码应当附有注释以便维护
+
+有关审查（Review）的说明:
+1. 您在 PR 时应打开允许维护者修改 PR，以便我们进行修改
+2. 您愿意接受长时间的等待（一般不超过15天）
+3. 您能够接受因代码质量等问题而提出的疑问,并愿意讨论是否接受更改
+
+## Github PR
+此处为在使用 Github PR 提交时应注意的事:
+- 默认你对 Git、GitHub 已经有了一定的了解,并且懂得使用 PR（此方面问题可以去讨论区发起 Q&A）
+- 请提交 PR 至 main 分支
+- PR 标题应简要明了地描述改动
+- 未完工的代码仍可提交 PR，可以先设置为 Draft
+- 善用相关词语填写 PR 信息或 Commit 信息，如提交、更新/修改、删除
+- 请确保您所提交的代码可以正常运行
+- 如果 PR 中删除了没有替代的代码，请注明删除原因
+
+# 翻译贡献指南
+在提交代码之前,我们默认以下几点:
+1. 您已阅读并同意[BSD-3-Clause](https://opensource.org/licenses/BSD-3-Clause) 授权许可
+2. 您同意我们在未来进行授权许可更改时包含您所贡献的翻译
+3. 您有对于 shokaX 的翻译原文和 github PR 及 actions 的基础了解
+
+翻译排版参考[中文文案排版指北](https://github.com/sparanoid/chinese-copywriting-guidelines/blob/master/README.zh-Hans.md) \
+**截止本指南写就时，shokaX 存在大量不符合此指北的翻译，我们欢迎提交 PR 修正这些错误**
+
+有关审查（Review）的说明:
+1. 您在 PR 时应打开允许维护者修改 PR，以便我们进行修改
+2. 您愿意接受长时间的等待（一般不超过15天）
+3. 您能够接受因翻译质量等问题而提出的疑问,并愿意讨论是否接受更改
+
+PR提交参考代码贡献指南即可
+
+# 最后需要注意的事项
+有问题可以前往讨论区进行讨论，其他渠道正在建设 \
+**本项目的每个贡献者都是理应感谢的人。**

package/LICENSE

@@ -1,28 +1,28 @@
-BSD 3-Clause License
-
-Copyright (c) 2022, zkz098
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
-1. Redistributions of source code must retain the above copyright notice, this
-   list of conditions and the following disclaimer.
-
-2. Redistributions in binary form must reproduce the above copyright notice,
-   this list of conditions and the following disclaimer in the documentation
-   and/or other materials provided with the distribution.
-
-3. Neither the name of the copyright holder nor the names of its
-   contributors may be used to endorse or promote products derived from
-   this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+BSD 3-Clause License
+
+Copyright (c) 2022, zkz098
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

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,53 +1,46 @@
-# hexo-theme-shokaX
-[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fzkz098%2Fhexo-theme-shokaX.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fzkz098%2Fhexo-theme-shokaX?ref=badge_shield)
-![LICENSE](	https://img.shields.io/github/license/zkz098/hexo-theme-shokaX)
-![stars](https://img.shields.io/github/stars/zkz098/hexo-theme-shokaX)
-![version](https://shields.io/npm/v/hexo-theme-shokax)
-
-此项目是shoka的一个二次开发版(算精神续作),致力于提高性能和优化魔改体验 \
-诞生原因是目前shoka已经两年没有更新了,积压了大量BUG和功能请求。\
-本项目处于高强度开发期,但github仓库版本已基本可用 \
-二次开发与常见问题请看wiki
-
-## 待办名单
-- [x] 推出一个可用的测试版
-- [x] 支持twikoo和waline评论系统
-- [x] 优化部分html标签
-- [x] 原生PWA支持
-- [x] 注入js和css支持
-- [x] 自定义font
-- [x] 部分功能调整为可关闭
-- [ ] 插件系统
-
-## 和shoka的区别
-原先shoka使用了javascript+Native+nunjucks的技术 \
-而shokaX则使用了typescript+Vue 3+Pug的技术搭配 \
-图标库可能会更换为Font Awesome 6 \
-更改了大量难以访问的CDN链接
-
-## 如何安装?
-建议使用[ShokaX-CLI](https://github.com/zkz098/shokaX-CLI) ,执行下列命令即可:
-```bash
-npm i shokax-cli --location=global
-# hexo init 初始化环境
-SXC install shokaX
-```
-
-# 许可证
-许可证: BSD-3-Clause \
-请注意: `0.0.1-alpha6`版本开始,shokaX使用BSD协议,这意味着删除页脚处的shokaX标识是违反许可证的
-[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fzkz098%2Fhexo-theme-shokaX.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fzkz098%2Fhexo-theme-shokaX?ref=badge_large)
-
-# 致谢名单
-## 开源项目
-| 名称               | 作者                | 描述                 |
-|:-----------------|:------------------|:-------------------|
-| Hexo             | Hexo contributors | 为本项目提供了良好的基础       |
-| hexo-theme-shoka | amehime           | 本项目的父主题            |
-
-## 贡献者
-| 名称         | 站点                         | 描述                     |
-|:-----------|:---------------------------|:-----------------------|
-| Lavender   | https://www.lavenderdh.cn/ | 提供了大量shoka主题的魔改        |
-| AdminZhang | https://www.a9-9.top/      | 为本项目提供了大量想法并进行了DEBUG工作 |
-
+# hexo-theme-shokaX
+[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fzkz098%2Fhexo-theme-shokaX.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fzkz098%2Fhexo-theme-shokaX?ref=badge_shield)
+![LICENSE](	https://img.shields.io/github/license/zkz098/hexo-theme-shokaX)
+![stars](https://img.shields.io/github/stars/zkz098/hexo-theme-shokaX)
+![version](https://shields.io/npm/v/hexo-theme-shokax)
+
+语言(language): 简体中文 | [English](https://github.com/zkz098/hexo-theme-shokaX/blob/main/README_en.MD) \
+此项目是shoka的一个二次开发版(算精神续作),致力于提高性能和优化魔改体验 \
+诞生原因是目前shoka已经两年没有更新了,积压了大量BUG和功能请求。\
+本项目处于高强度开发期,但github仓库版本已基本可用 \
+二次开发与常见问题请看wiki \
+`0.0.2-alpha2`开始,`lantern`和`qweather`已迁移为插件 \
+插件系统已完工,食用方法见[awesome-shokaX](https://github.com/zkz098/awesome-shokaX)
+
+## 和shoka的区别
+原先shoka使用了javascript+Native+nunjucks的技术 \
+而shokaX则使用了typescript+Vue 3+Pug的技术搭配 \
+图标库可能会更换为Font Awesome 6 \
+更改了大量难以访问的CDN链接
+
+## 如何安装?
+建议使用[ShokaX-CLI](https://github.com/zkz098/shokaX-CLI) ,执行下列命令即可:
+```bash
+npm i shokax-cli --location=global
+# hexo init 初始化环境
+SXC install shokaX
+```
+后续配置请点[这里](https://www.kaitaku.xyz/webbuild/shokaX/) 查看
+
+# 许可证
+许可证: BSD-3-Clause \
+[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fzkz098%2Fhexo-theme-shokaX.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fzkz098%2Fhexo-theme-shokaX?ref=badge_large)
+
+# 致谢名单
+## 开源项目
+| 名称               | 作者                | 描述                 |
+|:-----------------|:------------------|:-------------------|
+| Hexo             | Hexo contributors | 为本项目提供了良好的基础       |
+| hexo-theme-shoka | amehime           | 本项目的父主题            |
+
+## 贡献者
+| 名称         | 站点                         | 描述                     |
+|:-----------|:---------------------------|:-----------------------|
+| Lavender   | https://www.lavenderdh.cn/ | 提供了大量shoka主题的魔改        |
+| AdminZhang | https://www.a9-9.top/      | 为本项目提供了大量想法并进行了DEBUG工作 |
+

package/README_en.MD

@@ -0,0 +1,25 @@
+# hexo-theme-shokaX
+[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fzkz098%2Fhexo-theme-shokaX.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fzkz098%2Fhexo-theme-shokaX?ref=badge_shield)
+![LICENSE](	https://img.shields.io/github/license/zkz098/hexo-theme-shokaX)
+![stars](https://img.shields.io/github/stars/zkz098/hexo-theme-shokaX)
+![version](https://shields.io/npm/v/hexo-theme-shokax)
+
+语言(language): [简体中文](https://github.com/zkz098/hexo-theme-shokaX/blob/main/README.md) | English \
+This project is a secondary development version of Shoka, dedicated to improving performance and optimizing the development experience. \
+This project is in a period of intensive development, but the github repository version is basically available. \
+Please refer to the wiki for secondary development and common problems.
+Starting with `0.0.2-alpha2`, `lantern` and `qweather` have been migrated as plugins.
+The plugin system is complete, see [awesome-shokaX](https://github.com/zkz098/awesome-shokaX) for how to use it.
+
+## How to install?
+[ShokaX-CLI](https://github.com/zkz098/shokaX-CLI) is recommended:
+```bash
+npm i shokax-cli --location=global
+# hexo init
+SXC install -r=github shokaX
+```
+
+# License
+License: BSD-3-Clause \
+[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fzkz098%2Fhexo-theme-shokaX.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fzkz098%2Fhexo-theme-shokaX?ref=badge_large)
+