Skip to content

Commit e1276fe

Browse files
committed
docs: 创建 README.md 文件
- 新增 README.md 文件,介绍 MuRainBot2Doc 项目用途和贡献指南 - 说明项目背景和文档框架 - 提供安装依赖和预览文档的命令示例
1 parent f911ef6 commit e1276fe

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# MuRainBot2Doc
2+
3+
本项目是 [MuRainBot2](https://github.com/MuRainBot/MuRainBot2) 的文档, 用于文档的更新, 部署等。
4+
5+
# Contribution
6+
7+
如果只需要进行简单的修改可以直接修改对应文档的 markdown 源码, 如果修改较为复杂请参考以下步骤.
8+
9+
MuRainBot2 采用 **[VitePress](https://vitepress.dev/zh/guide/what-is-vitepress)** 作为文档框架, 请参考其文档进行贡献.
10+
11+
**安装好** VitePress 后, **重启终端**, 于拉取的本项目根目录下执行以下代码安装依赖:
12+
13+
```bash
14+
npm install
15+
```
16+
17+
安装依赖后执行以下代码进行预览:
18+
19+
```bash
20+
npm run docs:dev
21+
```

0 commit comments

Comments
 (0)