xref: /DADK/docs/dev-guide/how-to-write-docs.md (revision 2c1a697be787a4320d89f007f63fbc0fc2be2b67)
19d215902SLoGin# 如何编写文档?
29d215902SLoGin
39d215902SLoGin## 准备运行环境
49d215902SLoGin
59d215902SLoGin在开始编写文档之前,您需要准备一个运行环境。请确保您已经安装了nodejs 和 npm。
69d215902SLoGin
79d215902SLoGin- Nodejs: ≥ v20
89d215902SLoGin- npm: ≥ 10
99d215902SLoGin
109d215902SLoGin## 安装依赖
119d215902SLoGin
129d215902SLoGin在项目的`docs/`目录下运行以下命令来安装依赖:
139d215902SLoGin
149d215902SLoGin```
159d215902SLoGinnpm install
169d215902SLoGin```
179d215902SLoGin
189d215902SLoGin## 启动开发服务器
199d215902SLoGin
209d215902SLoGin安装完依赖后,您可以启动开发服务器来实时预览文档的更改。运行以下命令:
219d215902SLoGin
229d215902SLoGin```
239d215902SLoGinnpm run docs:dev
249d215902SLoGin```
259d215902SLoGin
269d215902SLoGin然后,您就能在浏览器中实时预览文档了。
279d215902SLoGin
289d215902SLoGin## 编写文档
299d215902SLoGin
309d215902SLoGin您可以在`docs/`目录下找到文档的源文件,并根据需要进行编辑和添加。
319d215902SLoGin
329d215902SLoGin### 添加一个新的文档
339d215902SLoGin
34*2c1a697bSLoGin您创建md之后,需要在`docs/.vuepress/config.js`中添加路由。
35