diff --git a/docs/zh/guide/README.md b/docs/zh/guide/README.md index 91952e54..c3c8f299 100644 --- a/docs/zh/guide/README.md +++ b/docs/zh/guide/README.md @@ -71,7 +71,6 @@ D2Admin 仍然处于开发中,这里有一些计划: * `1.1.0 完成` 抽离项目里的文档,集中存放在文档站点 * `1.1.0 完成` 对主界面进行一次完善,调整整体布局和颜色 * `1.1.0 完成` 切换主题功能 -* `1.1.0 完成` 使用自定义滚动条 * 分离出简化版本 * 推出基于 [ice](https://alibaba.github.io/ice) 平台的版本 * 增加右上角通知中心 @@ -143,4 +142,24 @@ npm run dev npm run build ``` -> 如果上述步骤出现错误,建议您升级 node 版本 > 8,如果有其它疑问请参考[常见问题](/zh/guide/question.html) \ No newline at end of file +> 如果上述步骤出现错误,建议您升级 node 版本 > 8,如果有其它疑问请参考[常见问题](/zh/guide/question.html) + +## 书写文档 + +这里目前还有一个小遗憾,d2admin 使用的 webpack 版本不能符合 vuepress 的要求,所以如果你想在本地启动文档站点的服务,需要按下述步骤 + +首先将 vuepress 安装到全局 + +``` +npm i -g vuepress +``` + +启动服务 + +``` +npm run doc:dev +``` + +::: tip +你可能会发现项目目录中有一个 deploy.sh 文件,这个文件是为了方便发布文档用的,通常你并不需要使用它 +::: \ No newline at end of file diff --git a/docs/zh/guide/question.md b/docs/zh/guide/question.md index caca3777..39680fd3 100644 --- a/docs/zh/guide/question.md +++ b/docs/zh/guide/question.md @@ -1,6 +1,6 @@ # 常见问题 -## 项目为什么无法启动 +## 无法启动项目 首先建议您升级 node 版本 > 8,在以下环境测试可用 @@ -23,24 +23,4 @@ v8.11.1 ::: tip 推荐使用 [nrm](https://github.com/Pana/nrm) 管理 npm 源,不建议使用 cnpm -::: - -## 如何启动文档的开发环境 - -这里目前还有一个小遗憾,d2admin 使用的 webpack 版本不能符合 vuepress 的要求,所以如果你想在本地启动文档站点的服务,需要按下述步骤 - -首先将 vuepress 安装到全局 - -``` -npm i -g vuepress -``` - -启动服务 - -``` -npm run doc:dev -``` - -::: tip -你可能会发现项目目录中有一个 deploy.sh 文件,这个文件是为了方便发布文档用的,你并不需要使用它 ::: \ No newline at end of file