diff --git a/README.md b/README.md index 3a572fc2..c409481e 100755 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ Solution of management system front-end based on `vue.js` and `ElementUI` Welcome everyone to maintain -[Documentation (English)](https://fairyever.github.io/d2admin-vue-element-doc/) / [中文文档](https://fairyever.github.io/d2admin-vue-element-doc/zh/) +[Documentation (English)](https://fairyever.github.io/d2admin-vue-element/) / [中文文档](https://fairyever.github.io/d2admin-vue-element/zh/) [Online preview / 在线预览](http://d2admin.fairyever.com/) @@ -128,91 +128,4 @@ v8.11.1 edunpm - http://registry.enpmjs.org/ ``` -> Not recommended for use `cnpm` - -## preview - -login - -![Snip20180526_1](https://raw.githubusercontent.com/FairyEver/d2admin-vue-element/master/doc/image/Snip20180526_1.png) - -dashboard - -![Snip20180526_2](https://raw.githubusercontent.com/FairyEver/d2admin-vue-element/master/doc/image/Snip20180526_2.png) - -mock data demo - -![Snip20180526_3](https://raw.githubusercontent.com/FairyEver/d2admin-vue-element/master/doc/image/Snip20180526_3.png) - -dragable and modified size card - -![Snip20180526_4](https://raw.githubusercontent.com/FairyEver/d2admin-vue-element/master/doc/image/Snip20180526_4.png) - -dragable layout - -![Snip20180526_5](https://raw.githubusercontent.com/FairyEver/d2admin-vue-element/master/doc/image/Snip20180526_5.png) - -multi-language support - -![Snip20180526_6](https://raw.githubusercontent.com/FairyEver/d2admin-vue-element/master/doc/image/Snip20180526_6.png) - -import `csv` `xlsx` -export `csv` `xlsx` and text - -![Snip20180526_7](https://raw.githubusercontent.com/FairyEver/d2admin-vue-element/master/doc/image/Snip20180526_7.png) - -![Snip20180526_8](https://raw.githubusercontent.com/FairyEver/d2admin-vue-element/master/doc/image/Snip20180526_8.png) - -three modes page container component - -![Snip20180526_9](https://raw.githubusercontent.com/FairyEver/d2admin-vue-element/master/doc/image/Snip20180526_9.png) - -integrated rich text editor - -![Snip20180526_10](https://raw.githubusercontent.com/FairyEver/d2admin-vue-element/master/doc/image/Snip20180526_10.png) - -integrated markdown editor - -![Snip20180526_11](https://raw.githubusercontent.com/FairyEver/d2admin-vue-element/master/doc/image/Snip20180526_11.png) - -integrated icon font - -![Snip20180526_12](https://raw.githubusercontent.com/FairyEver/d2admin-vue-element/master/doc/image/Snip20180526_12.png) - -encapsulation icon component - -![Snip20180526_13](https://raw.githubusercontent.com/FairyEver/d2admin-vue-element/master/doc/image/Snip20180526_13.png) - -support automatically import SVG folder icon, and through the use of components - -![Snip20180526_14](https://raw.githubusercontent.com/FairyEver/d2admin-vue-element/master/doc/image/Snip20180526_14.png) - -icon selector component - -![Snip20180526_15](https://raw.githubusercontent.com/FairyEver/d2admin-vue-element/master/doc/image/Snip20180526_15.png) - -Integrated markdown rendering function and optimized the Baidu cloud sharing link in the rendering result display - -![Snip20180526_16](https://raw.githubusercontent.com/FairyEver/d2admin-vue-element/master/doc/image/Snip20180526_16.png) - -integrated digital animation plug-in - -![Snip20180526_17](https://raw.githubusercontent.com/FairyEver/d2admin-vue-element/master/doc/image/Snip20180526_17.png) - -hightLight in source code viewer - -![Snip20180526_18](https://raw.githubusercontent.com/FairyEver/d2admin-vue-element/master/doc/image/Snip20180526_18.png) - -integrated chart - -![Snip20180526_19](https://raw.githubusercontent.com/FairyEver/d2admin-vue-element/master/doc/image/Snip20180526_19.png) - -support chart drag and resize and drag and drop locations - -![Snip20180526_20](https://raw.githubusercontent.com/FairyEver/d2admin-vue-element/master/doc/image/Snip20180526_20.png) - -separate chart example - -![Snip20180526_21](https://raw.githubusercontent.com/FairyEver/d2admin-vue-element/master/doc/image/Snip20180526_21.png) - - +> Not recommended for use `cnpm` \ No newline at end of file diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 929add7c..071e74dd 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -57,6 +57,7 @@ function sideBarGuide (title) { collapsable: false, children: [ '', + 'q-a', 'change-log' ] } diff --git a/docs/zh/guide/q-a.md b/docs/zh/guide/q-a.md new file mode 100644 index 00000000..50d55a54 --- /dev/null +++ b/docs/zh/guide/q-a.md @@ -0,0 +1,21 @@ +# 常见问题 + +## 如何启动文档的开发环境 + +这里目前还有一个小遗憾,d2admin 使用的 webpack 版本不能符合 vuepress 的要求,所以如果你想在本地启动文档站点的服务,需要按下述步骤 + +首先将 vuepress 安装到全局 + +``` +npm i -g vuepress +``` + +启动服务 + +``` +npm run doc:dev +``` + +::: tip +你可能会发现项目目录中有一个 deploy.sh 文件,这个文件是为了方便发布文档用的,你并不需要使用它 +::: \ No newline at end of file