From 03b708870bcef45c19f8eaa4ad5283f8b910e17e Mon Sep 17 00:00:00 2001 From: Pan Date: Mon, 25 Jun 2018 14:54:02 +0800 Subject: [PATCH] update doc --- README.md | 106 ++++++++++++++--------- README.zh-CN.md | 99 +++++++++++++-------- src/router/index.js | 2 +- src/views/components-demo/tinymce.vue | 2 +- src/views/documentation/index.vue | 2 +- src/views/errorLog/index.vue | 2 +- src/views/example/components/Warning.vue | 2 +- src/views/svg-icons/index.vue | 2 +- src/views/theme/index.vue | 2 +- 9 files changed, 133 insertions(+), 86 deletions(-) diff --git a/README.md b/README.md index 5a931f37..72d36536 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ vue - element-ui + element-ui Build Status @@ -24,33 +24,34 @@ English | [简体中文](./README.zh-CN.md) ## Introduction -`vue-element-admin` is a production-ready solution for admin interfaces. Based on [Vue.js](https://github.com/vuejs/vue) and use the UI Toolkit -- [element](https://github.com/ElemeFE/element). `vue-element-admin` is a magical vue admin, it based on the newest development stack of vue, built-in i18n solution, typical templates for enterprise applications, lots of awesome features. It helps you build a large complex Single-Page Applications. I believe whatever your needs are, this project will help you. +[vue-element-admin](http://panjiachen.github.io/vue-element-admin) is a front-end management background integration solution based on [vue](https://github.com/vuejs/vue) and use the UI Toolkit -- [element](https://github.com/ElemeFE/element). + +It is a magical vue admin. It based on the newest development stack of vue, built-in i18n solution, typical templates for enterprise applications, lots of awesome features. It helps you build a large complex Single-Page Applications. I believe whatever your needs are, this project will help you. - [Preview](http://panjiachen.github.io/vue-element-admin) -- [Documentation](https://panjiachen.github.io/vue-element-admin-site/#/) +- [Documentation](https://panjiachen.github.io/vue-element-admin-site/) - [Gitter](https://gitter.im/vue-element-admin/discuss) - [Wiki](https://github.com/PanJiaChen/vue-element-admin/wiki) -- [Donate](https://panjiachen.github.io/vue-element-admin-site/#/donate) +- [Donate](https://panjiachen.github.io/vue-element-admin-site/donate/) -**vue-element-admin is an admin interfaces integration solution, which is not suitable for secondary development as a base template.** +**This project is positioned as a background integration solution and is not suitable for secondary development as a basic template.** - Base template recommends using: [vueAdmin-template](https://github.com/PanJiaChen/vueAdmin-template)   - Desktop: [electron-vue-admin](https://github.com/PanJiaChen/electron-vue-admin) -**Note: This project uses element-ui@2.3.0+ version, so the minimum compatible vue@2.5.0+** - ## Preparation -You need to install [node](http://nodejs.org/) and [git](https://git-scm.com/) locally. The project is based on [ES2015+](http://es6.ruanyifeng.com/), [vue](https://cn.vuejs.org/index.html), [vuex](https://vuex.vuejs.org/zh-cn/), [vue-router](https://router.vuejs.org/zh-cn/) and [element-ui](https://github.com/ElemeFE/element). All data requests for this project are simulated using [Mock.js](https://github.com/nuysoft/Mock). It would be helpful if you have pre-existing knowledge on those. - - **This project is not a scaffolding and is more of an integrated solution.** +You need to install [node](http://nodejs.org/) and [git](https://git-scm.com/) locally. The project is based on [ES2015+](http://es6.ruanyifeng.com/), [vue](https://cn.vuejs.org/index.html), [vuex](https://vuex.vuejs.org/zh-cn/), [vue-router](https://router.vuejs.org/zh-cn/), [axios](https://github.com/axios/axios) and [element-ui](https://github.com/ElemeFE/element), all request data is simulated using [Mock.js](https://github.com/nuysoft/Mock). + Understanding and learning this knowledge in advance will greatly help the use of this project. **This project does not support low version browsers (e.g. IE). Please add polyfill yourself if you need them.** + **Note: This project uses element-ui@2.3.0+ version, so the minimum compatible vue@2.5.0+** +

@@ -58,41 +59,64 @@ You need to install [node](http://nodejs.org/) and [git](https://git-scm.com/) l ## Features ``` - Login / Logout -- Permission authentication + +- Permission Authentication + - Page permission + - Directive permission + - Two-step login + - Multi-environment build -- Dynamic sidebar (supports multi-level routing) -- Dynamic breadcrumb -- I18n -- Customizable theme -- Tags-view(Tab page Support right-click operation) -- Rich text editor -- Markdown editor -- JSON editor -- Screenfull -- Drag and drop list -- Svg Sprite + - dev sit stage prod + +- Global Features + - I18n + - Multiple dynamic themes + - Dynamic sidebar (supports multi-level routing) + - Dynamic breadcrumb + - Tags-view(Tab page Support right-click operation) + - Svg Sprite + - Mock data + - Screenfull + - Responsive Sidebar + +- Editor + - Rich Text Editor + - Markdown Editor + - JSON Editor + +- Excel + - Export Excel + - Export zip + - Upload Excel + - Visualization Excel + +- Table + - Dynamic Table + - Drag And Drop Table + - Tree Table + - Inline Edit Table + +- Error Page + - 401 + - 404 + +- Components + - Avatar Upload + - Back To Top + - Drag Dialog + - Drag Kanban + - Drag List + - SplitPane + - Dropzone + - Sticky + - CountTo + +- Advanced Example +- Error Log - Dashboard - Guide Page -- Mock data - Echarts - Clipboard -- 401/404 error page -- Error log -- Export excel -- Export zip -- Front-end visualization excel -- Tree Table -- Table example -- Dynamictable example -- Drag and drop table example -- Inline edit table example -- Form example -- Two-step login -- SplitPane -- Drag Dialog -- Dropzone -- Sticky -- CountTo - Markdown to html ``` @@ -135,7 +159,7 @@ npm run lint npm run lint -- --fix ``` -Refer to [Documentation](https://panjiachen.github.io/vue-element-admin-site/#/deploy) for more information +Refer to [Documentation](https://panjiachen.github.io/vue-element-admin-site/guide/essentials/deploy.html) for more information ## Changelog Detailed changes for each release are documented in the [release notes](https://github.com/PanJiaChen/vue-element-admin/releases). diff --git a/README.zh-CN.md b/README.zh-CN.md index de8f7c70..b98a3af0 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -7,7 +7,7 @@ vue - element-ui + element-ui Build Status @@ -24,27 +24,25 @@ ## 简介 -`vue-element-admin` 是一个后台集成解决方案，它基于 [Vue.js](https://github.com/vuejs/vue) 和 [element](https://github.com/ElemeFE/element)。它使用了最新的前端技术栈，内置了i18国际化解决方案，动态路由，权限验证等很多功能特性，相信不管你的需求是什么，本项目都能帮助到你。 +[vue-element-admin](http://panjiachen.github.io/vue-element-admin) 是一个后台集成解决方案，它基于 [vue](https://github.com/vuejs/vue) 和 [element](https://github.com/ElemeFE/element)。它使用了最新的前端技术栈，内置了i18国际化解决方案，动态路由，权限验证，提炼了典型的业务模型，提供了丰富的功能组件，它可以帮助你快速搭建企业级中后台产品原型。相信不管你的需求是什么，本项目都能帮助到你。 - [在线访问](http://panjiachen.github.io/vue-element-admin) -- [使用文档](https://panjiachen.github.io/vue-element-admin-site/#/zh-cn/) +- [使用文档](https://panjiachen.github.io/vue-element-admin-site/zh/) - [Gitter讨论组](https://gitter.im/vue-element-admin/discuss) - [Wiki](https://github.com/PanJiaChen/vue-element-admin/wiki) -- [Donate](https://panjiachen.github.io/vue-element-admin-site/#/zh-cn/donate) +- [Donate](https://panjiachen.github.io/vue-element-admin-site/zh/donate/) **本项目的定位是后台集成方案，不适合当基础模板来开发。** - 模板建议使用: [vueAdmin-template](https://github.com/PanJiaChen/vueAdmin-template)   - 桌面端: [electron-vue-admin](https://github.com/PanJiaChen/electron-vue-admin) -**注意：该项目使用 element-ui@2.3.0+ 版本，所以最低兼容 vue@2.5.0+** - ## 前序准备 -你的本地环境需要安装 [node](http://nodejs.org/) 和 [git](https://git-scm.com/)。我们的技术栈基于 [ES2015+](http://es6.ruanyifeng.com/)、[vue](https://cn.vuejs.org/index.html)、[vuex](https://vuex.vuejs.org/zh-cn/)、[vue-router](https://router.vuejs.org/zh-cn/) and [element-ui](https://github.com/ElemeFE/element)，所有的请求数据都使用[Mock.js](https://github.com/nuysoft/Mock)模拟，提前了解和学习这些知识会对使用本项目有很大的帮助。 +你需要在本地安装 [node](http://nodejs.org/) 和 [git](https://git-scm.com/)。本项目技术栈基于 [ES2015+](http://es6.ruanyifeng.com/)、[vue](https://cn.vuejs.org/index.html)、[vuex](https://vuex.vuejs.org/zh-cn/)、[vue-router](https://router.vuejs.org/zh-cn/) 、[axios](https://github.com/axios/axios) 和 [element-ui](https://github.com/ElemeFE/element)，所有的请求数据都使用[Mock.js](https://github.com/nuysoft/Mock)模拟，提前了解和学习这些知识会对使用本项目有很大的帮助。 同时配套一个系列的教程文章，如何从零构建后一个完整的后台项目，建议大家先看完这些文章再来实践本项目 - [手摸手，带你用 vue 撸后台 系列一(基础篇)](https://juejin.im/post/59097cd7a22b9d0065fb61d2) @@ -61,6 +59,8 @@ **本项目并不是一个脚手架，更倾向于是一个集成解决方案** + **注意：该项目使用 element-ui@2.3.0+ 版本，所以最低兼容 vue@2.5.0+** + **该项目不支持低版本浏览器(如ie)，有需求请自行添加polyfill [详情](https://github.com/PanJiaChen/vue-element-admin/wiki#babel-polyfill)**

@@ -69,42 +69,65 @@ ## 功能 ``` -- 登录/注销 +- 登录 / 注销 + - 权限验证 + - 页面权限 + - 指令权限 + - 二步登录 + - 多环境发布 -- 动态侧边栏（支持多级路由） -- 动态面包屑 -- 国际化多语言 -- 多种动态换肤 -- 快捷导航(标签页) -- 富文本编辑器 -- Markdown编辑器 -- JSON编辑器 -- Screenfull全屏 -- 列表拖拽 -- Svg Sprite 图标 + - dev sit stage prod + +- 全局功能 + - 国际化多语言 + - 多种动态换肤 + - 动态侧边栏（支持多级路由嵌套） + - 动态面包屑 + - 快捷导航(标签页) + - Svg Sprite 图标 + - 本地mock数据 + - Screenfull全屏 + - 自适应收缩侧边栏 + +- 编辑器 + - 富文本 + - Markdown + - JSON 等多格式 + +- Excel + - 导出excel + - 导出zip + - 导入excel + - 前端可视化excel + +- 表格 + - 动态表格 + - 拖拽表格 + - 树形表格 + - 内联编辑 + +- 错误页面 + - 401 + - 404 + +- 組件 + - 头像上传 + - 返回顶部 + - 拖拽Dialog + - 拖拽看板 + - 列表拖拽 + - SplitPane + - Dropzone + - Sticky + - CountTo + +- 综合实例 +- 错误日志 - Dashboard - 引导页 -- 本地mock数据 - Echarts 图表 - Clipboard(剪贴复制) -- 401/404错误页面 -- 错误日志 -- 导出excel -- 导出zip -- 前端可视化excel -- 树形table -- Table example -- 动态table example -- 拖拽table example -- 内联编辑table example -- Form example -- 二步登录 -- SplitPane -- 拖拽 Dialog -- Dropzone -- Sticky -- CountTo - Markdown2html ``` @@ -148,7 +171,7 @@ npm run lint npm run lint -- --fix ``` -更多信息请参考 [使用文档](https://panjiachen.github.io/vue-element-admin-site/#/zh-cn/deploy) +更多信息请参考 [使用文档](https://panjiachen.github.io/vue-element-admin-site/zh/) ## Changelog Detailed changes for each release are documented in the [release notes](https://github.com/PanJiaChen/vue-element-admin/releases). diff --git a/src/router/index.js b/src/router/index.js index 2c9dbcbd..aaaccd8d 100644 --- a/src/router/index.js +++ b/src/router/index.js @@ -7,7 +7,7 @@ Vue.use(Router) import Layout from '@/views/layout/Layout' /** note: submenu only apppear when children.length>=1 -* detail see https://panjiachen.github.io/vue-element-admin-site/#/router-and-nav?id=sidebar +* detail see https://panjiachen.github.io/vue-element-admin-site/guide/essentials/router-and-nav.html **/ /** diff --git a/src/views/components-demo/tinymce.vue b/src/views/components-demo/tinymce.vue index 89323a4c..10760f65 100644 --- a/src/views/components-demo/tinymce.vue +++ b/src/views/components-demo/tinymce.vue @@ -2,7 +2,7 @@

{{$t('components.tinymceTips')}} - {{$t('components.documentation')}} + {{$t('components.documentation')}}
diff --git a/src/views/documentation/index.vue b/src/views/documentation/index.vue index 8d3482d1..d9f8b9e8 100644 --- a/src/views/documentation/index.vue +++ b/src/views/documentation/index.vue @@ -1,6 +1,6 @@ diff --git a/src/views/svg-icons/index.vue b/src/views/svg-icons/index.vue index 0b95a87f..d371cc9a 100644 --- a/src/views/svg-icons/index.vue +++ b/src/views/svg-icons/index.vue @@ -1,7 +1,7 @@