diff --git a/README.md b/README.md index c23b1a2ccd2984f7d694ff40c7f6f53b2434b78d..f9a0476dfbb5b243cbbc512acc49eb04a120e056 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` 命令来预览