docs: convert base docs to English with Chinese translations Rename original Chinese docs to .zh.md suffix (README, CHANGELOG, CODE_OF_CONDUCT, CONTRIBUTING, SECURITY) Create English versions as main files with translation entry links
docs: convert base docs to English with Chinese translations
一只基于 Koishi 的全能框架的说!—— 炒鸡厉害的全能喵喵框架!(。>ω<。)ノ♡
Spak 是一只超级全能的小框架喵!它继承了 Koishi 的可爱基因(插件系统和依赖注入什么的),然后被咱 Spak Team 喂了神奇猫粮,长出了更多厉害的本领的说!
Spak 能干什么喵? (っ´ω`)ノ✨
咱 Spak 用的是 TypeScript,核心由这些可爱的包包组成:
@spakjs/core
@spakjs/cli
spak start
@spakjs/loader
@spakjs/utils
@spakjs/i18n-utils
还有可爱的小插件们:
@spakjs/plugin-server
@spakjs/plugin-http
@spakjs/plugin-hmr
# 把依赖都装好 pnpm install # 构建所有包包,注册 spak 到全局 pnpm build
在项目根目录创建 spak.config.yml:
name: my-spak-app plugins: server: http:
# 直接用默认配置启动喵 spak start # 也可以指定配置文件 spak start ./path/to/spak.config.yml
# 开发模式(构建 + 全局链接) pnpm dev # 清理喵 pnpm clean
🚧 这是个未来计划喵! 还没开始写,先画个饼的说~(>ω<)
SPM 是咱设想中的 Spak 原生包管理器,未来可能会代替 pnpm 成为 Spak 生态的核心包管理工具喵!
.yaml
.json
.spak
spm test
# 安装插件 spm install @spakjs/plugin-server # 构建项目 spm build # 发布插件 spm publish # 创建新插件模板 spm init plugin my-plugin
目前 Spak 使用 pnpm 作为包管理器,SPM 只是一个美好的设想喵!如果你有兴趣帮忙实现,欢迎来贡献代码的说!(。>ω<。)ノ✧
咱用的是 MIT License 喵~ 版权归 Spak Team 和 Shigma 所有地说!(=ↀωↀ=)
咕噜咕噜~如果主人想给 Spak 加新功能、修 bug,随时来找咱的说!咱会摇着尾巴陪主人一起干的喵!(。>ω<。)ノ✧
版权所有:中国计算机学会技术支持:开源发展技术委员会 京ICP备13000930号-9 京公网安备 11010802047560号
Spak 喵~ ✨
呜喵~这是什么呀?(=ↀωↀ=)
Spak 是一只超级全能的小框架喵!它继承了 Koishi 的可爱基因(插件系统和依赖注入什么的),然后被咱 Spak Team 喂了神奇猫粮,长出了更多厉害的本领的说!
Spak 能干什么喵? (っ´ω`)ノ✨
咱 Spak 用的是 TypeScript,核心由这些可爱的包包组成:
@spakjs/core🧠@spakjs/cli🎮spak start就能跑起来!@spakjs/loader📂@spakjs/utils🧰@spakjs/i18n-utils🌐还有可爱的小插件们:
@spakjs/plugin-server🖥️ — 服务器服务@spakjs/plugin-http🌍 — HTTP/WebSocket 客户端@spakjs/plugin-hmr🔥 — 热重载,改完代码不用重启的说!快速开始 喵!(>ω<)ノ
需要准备好这些喵~
第一步:把猫猫带回家~
第二步:写个配置文件的说~
在项目根目录创建 spak.config.yml:
第三步:启动!(=ↀωↀ=)✧
开发模式喵~
🔮 SPM - Spak Package Manager(展望中)
SPM 是咱设想中的 Spak 原生包管理器,未来可能会代替 pnpm 成为 Spak 生态的核心包管理工具喵!
设计目标
.yaml/.json配置.spak包,即装即用spm test自动检查插件兼容性想象中的用法喵~
许可证
咱用的是 MIT License 喵~ 版权归 Spak Team 和 Shigma 所有地说!(=ↀωↀ=)
咕噜咕噜~如果主人想给 Spak 加新功能、修 bug,随时来找咱的说!咱会摇着尾巴陪主人一起干的喵!(。>ω<。)ノ✧