xref: /DADK/docs/dev-guide/how-to-write-docs.md (revision 9d215902460b2bc731a598632971ea7e18d83360)
1# 如何编写文档?
2
3## 准备运行环境
4
5在开始编写文档之前,您需要准备一个运行环境。请确保您已经安装了nodejs 和 npm。
6
7- Nodejs: ≥ v20
8- npm: ≥ 10
9
10## 安装依赖
11
12在项目的`docs/`目录下运行以下命令来安装依赖:
13
14```
15npm install
16```
17
18## 启动开发服务器
19
20安装完依赖后,您可以启动开发服务器来实时预览文档的更改。运行以下命令:
21
22```
23npm run docs:dev
24```
25
26然后,您就能在浏览器中实时预览文档了。
27
28## 编写文档
29
30您可以在`docs/`目录下找到文档的源文件,并根据需要进行编辑和添加。
31
32### 添加一个新的文档
33
34您创建md之后,需要在`docs/.vitepress/config.js`中添加路由。