docs/README.md

30 lines
611 B
Markdown
Raw Normal View History

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