From 33cbad6f167c5917098a6bb525748746d400b8a9 Mon Sep 17 00:00:00 2001 From: Xinlei_Zhou <105836659+ZhouXiinlei@users.noreply.github.com> Date: Mon, 24 Apr 2023 16:43:54 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E8=B4=A1=E7=8C=AE=E6=8C=87=E5=8D=97?= =?UTF-8?q?=E6=96=B0=E5=A2=9E=20=E6=9E=84=E5=BB=BA=E6=8C=87=E5=8D=97?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CONTRIBUTING.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e6d9f94..6832f61 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -30,6 +30,22 @@ 4. 标题内的英文单词首字母大写。 5. 代码块使用 ` ``` ` 包裹,并标注常见的语言标识符,如 ` ```python `。 + +## 项目构建指南 + +需要 nodejs v16.14.0 及以上版本 + +使用包管理器 npm + +```bash +npm install +npm run docs:dev #运行预览环境 +``` +```bash +npm run docs:bulid #编译线上环境 +npm run docs:preview #预览线上环境 +``` + ## 项目配置指南 修改新添加或移动位置的 md 文件需要在 `.vitepress/config.js` 中的 `sidebar` 中添加或修改对应的配置。