Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Candinya committed Aug 12, 2024
1 parent 99ffb8f commit d0696ac
Showing 1 changed file with 10 additions and 20 deletions.
30 changes: 10 additions & 20 deletions ReadMe.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,33 +12,23 @@

## 🍭 关于主题

最初是一个从 Wordpress 移植过来的主题,抱着别浪费原开发者辛勤劳动的血汗成果的心态接手继续开发,竟逐渐迭代出了一套属于自己的生态。

<!-- TODO:在 Wiki 里继续扩展 -->
简约但不简陋,现代但不抽象。本体精简而周边丰富,功能不多但扩展强大。脱胎于一个大名鼎鼎的 Wordpress 主题,迭代出一套独一无二的健康生态。

## 💞 安装使用

当前主题正在开发全新的 V3 版本,相关的流程还未完全准备就绪;如果您需要参考 V2 的部署文档,您可以前往 [branch/v2] 来查看相关的内容。

需要注意的是, V3 版本的使用方法和 V2 会有非常大的改变,届时我们将会整理出一份详细的迁移文档供您参考。

[branch/v2]: https://github.com/Candinya/Kratos-Rebirth/tree/v2
当前主题的 V3 版本正在测试阶段,相关的流程还未完全准备就绪;如果您想先开始尝试一下,可以参考 [快速开始](https://wiki.krt.moe/posts/quickstart/) 使用 https://github.com/kratos-rebirth/quickstart 模板仓库来创建您的站点。

<!-- TODO:基于 https://github.com/kratos-rebirth/quickstart 模板初始化,把详细流程和配置说明放到 Wiki 里 -->
如果您需要参考 V2 的相关资料,您可以前往 [branch/v2](https://github.com/Candinya/Kratos-Rebirth/tree/v2) 来查看。需要注意的是, V2 版本的支持已经结束。

## 💬 周边生态支持

出于扩展性考虑, V3 版本开始的主题将不再内置具体的生态插件(如评论或是站点音乐播放器等),您可以根据自己的需要自行引入对应的资源文件。我们将会提供一个详细的文档说明,以及一些 V2 版本时可用的平台的相关样例
出于扩展性考虑, V3 版本开始的主题将不再内置具体的生态插件(如评论或是站点音乐播放器等),您可以根据自己的需要自行引入对应的资源文件。具体请参见 [V2 版本升级迁移指南](https://wiki.krt.moe/posts/from-v2-migration-guide/)

<!-- TODO:模板写到 Wiki 里,具体的评论实现和配置写到 ecosystem 里 -->

## 🍩 二次开发
## 🍩 二次开发与项目周边

V3 版本的二次开发工作流与 V2 版本相差不大,主要的变化为提交时不再需要构建资源文件,转而使用 CI 在打包上传时自动构建。如果您有二次开发或是传统使用方式(放置在站点的 themes 目录下)的需求,您需要注意手动构建最新的资源文件。

我们使用 pnpm 作为包管理工具,它比起 yarn 和 npm 这种传统解决方案来说更注重节约硬盘空间,可以在一定程度上避免银河系中心黑洞级的 node_modules 目录出现。

<!-- TODO:写到 Wiki 里 -->
我们在 [Wiki](https://wiki.krt.moe/#%E5%BC%80%E5%8F%91%E8%80%85%E7%9A%84%E5%AE%9E%E9%AA%8C%E5%AE%A4) 上为您提供了一些二次开发与项目周边开发时可能会用到的帮助文档,您可以自行前往查看。

## 💮 非常感谢

Expand All @@ -51,18 +41,18 @@ V3 版本的二次开发工作流与 V2 版本相差不大,主要的变化为
| 完成的工作 | 开发者 |
| ------------------------- | ------------ |
| 基础项目 Kratos 开发 | Seaton Jiang |
| 基础项目 Kratos-M2 开发 | MoeDog |
| 基础项目 Kratos-M 开发 | MoeDog |
| 基础项目 Kratos-Hexo 开发 | 蓝冰记忆 |

### 用户们

- 各位一直以来都坚持陪伴着我们的用户们 <!-- TODO:链接到 awesome 页面 -->
- 各位一直以来都坚持 [陪伴着我们的用户们](https://awesome.krt.moe/)

### 项目

请参见 Wiki (等待补充)
您可以在 [周边生态](https://eco.krt.moe/) 找到支持这个主题的项目。

<!-- (从编辑历史里找这块对应的内容) -->
如果您有开发出新的周边生态项目支持,也欢迎您随时向 [kratos-rebirth/ecosystem](https://github.com/kratos-rebirth/ecosystem) 仓库提交一个 PR 。

## 🎵 开源授权

Expand Down

0 comments on commit d0696ac

Please sign in to comment.