From deb0327b9717fa0fbdc1315a8fab7fc5dc70301c Mon Sep 17 00:00:00 2001 From: MrSuM Date: Wed, 28 May 2025 20:49:03 +0800 Subject: [PATCH] =?UTF-8?q?docs(README):=20=E6=9B=B4=E6=96=B0=20README.md?= =?UTF-8?q?=20=E6=96=87=E4=BB=B6=EF=BC=8C=E6=B7=BB=E5=8A=A0=E5=BC=80?= =?UTF-8?q?=E5=8F=91=E6=8C=87=E5=8D=97?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - 在 README.md 中添加了开发指南部分,包括项目克隆、依赖安装、本地运行和构建的步骤 --- README.md | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c23b1a2..f9a0476 100644 --- a/README.md +++ b/README.md @@ -4,4 +4,27 @@ 原项目地址:https://gitee.com/XAUATiOSClub/language_learning -网址:https://plan.xauat.site/ \ No newline at end of file +网址:https://plan.xauat.site/ + +## 开发指南 + +1. 确保 Node.js 已经安装 +2. 将该项目 clone 到本地 + ```bash + git clone https://gitee.com/XAUATiOSClub/language_learning_website.git + cd language_learning + ``` +3. 安装 node 依赖 + ```bash + npm install + ``` +4. 在本地运行 + ```bash + npm run docs:dev + ``` + 根据控制台输出的提示,打开浏览器访问计划页面 +5. 构建该项目 + ```bash + npm run docs:build + ``` + 构建完成后,会在 `docs/.vuepress/dist` 文件夹下生成静态页面,通过 `npm run docs:preview` 命令来预览 -- Gitee