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