mirror of
https://github.com/gkd-kit/docs.git
synced 2024-11-16 02:52:20 +08:00
30 lines
611 B
Markdown
30 lines
611 B
Markdown
# 说明
|
|
|
|
GKD 文档(尚未开发完毕), 基于 [vitepress](https://vitepress.dev/zh/) 构建
|
|
|
|
可前往 [gkd.li](https://gkd.li) 预览
|
|
|
|
## 提交贡献
|
|
|
|
欢迎提交 [规则示例](./docs/guide/subscription.md) 和 [选择示例](./docs/guide/example.md)
|
|
|
|
确保你对 [vitepress](https://vitepress.dev/zh/) 有基本了解
|
|
|
|
然后 [Fork](https://github.com/gkd-kit/docs/fork) 仓库
|
|
|
|
准备环境: node20+, pnpm9+ 最好使用最新版本
|
|
|
|
安装依赖
|
|
|
|
```sh
|
|
pnpm i
|
|
```
|
|
|
|
启动文档预览, 此时修改 md 文件会自动刷新浏览器界面
|
|
|
|
```sh
|
|
pnpm dev
|
|
```
|
|
|
|
修改提交推送后发起 pull request
|