Merge branch 'hotfix/readme_en'

Former-commit-id: d689ed29cf5bc43194e343d9b2d2ed217ad1f8d5 [formerly d689ed29cf5bc43194e343d9b2d2ed217ad1f8d5 [formerly d689ed29cf5bc43194e343d9b2d2ed217ad1f8d5 [formerly d689ed29cf5bc43194e343d9b2d2ed217ad1f8d5 [formerly a6d35d8efb86beecfc35bf0f3eef6fc21852ded5 [formerly 8de066bebb8bdc27b59a4a296ca53e9b75ac331a]]]]]
Former-commit-id: 0b974a87e955a272aff7df29f4aa1253d85e41b6
Former-commit-id: c53e91fa9db7d42f3ef66f8e3f553a910634b346
Former-commit-id: 85e59b309b78483c30ea0d9270e1601ae9d19181 [formerly bd366347bb69903e865034587b8c5814dc231021]
Former-commit-id: 5048f3bb8e18a72263577967775d8b2d6c8540c0
Former-commit-id: 77ce4bb75b7a5b213963f86d62f2d540b2281807
Former-commit-id: acd10e47ce4565f3d8393ceab61641ae7dd194fa
Former-commit-id: 8bd76f53a5f6c91f2d43b40feb22f7ffc76cf6c4
Former-commit-id: 9331733039ddff082377cff094ebd85be7eb79c2
This commit is contained in:
liyang
2018-09-04 09:29:57 +08:00
10 changed files with 164 additions and 264 deletions

105
README.md
View File

@@ -1,75 +1,70 @@
<img src="https://raw.githubusercontent.com/FairyEver/d2-admin/master/dev/github/banner.png"/>
![banner](https://raw.githubusercontent.com/FairyEver/d2-admin/master/doc/image/banner.png)
D2Admin 是一个开源的管理系统前端集成方案,为了方便开发者快速进行管理系统开发而设计。
<p align="center">
<a><img src="https://img.shields.io/github/release/d2-projects/d2-admin.svg"/></a>
<a><img src="https://badge.fury.io/js/%40d2-admin%2Fice-scaffold.svg"/></a>
<a><img src="https://www.travis-ci.org/d2-projects/d2-admin.svg?branch=master"/></a>
<a><img src="https://img.shields.io/github/last-commit/d2-projects/d2-admin.svg"/></a>
<a><img src="https://img.shields.io/badge/code_style-standard-brightgreen.svg"/></a>
</p>
[![Build Status](https://www.travis-ci.org/d2-projects/d2-admin.svg?branch=master)](https://www.travis-ci.org/d2-projects/d2-admin)
<p align="center">
<a><img src="https://img.shields.io/github/issues/d2-projects/d2-admin.svg"/></a>
<a><img src="https://img.shields.io/github/issues-closed/d2-projects/d2-admin.svg"/></a>
<a><img src="https://img.shields.io/github/issues-pr/d2-projects/d2-admin.svg"/></a>
<a><img src="https://img.shields.io/github/issues-pr-closed/d2-projects/d2-admin.svg"/></a>
<a><img src="https://img.shields.io/github/forks/d2-projects/d2-admin.svg"/></a>
<a><img src="https://img.shields.io/github/stars/d2-projects/d2-admin.svg"/></a>
</p>
## 仓库和文档
[D2Admin](https://github.com/d2-projects/d2-admin) 是一个完全**开源免费**的管理系统前端集成方案,为您做好大部分项目前期准备工作,提供大量示例代码,方便快速进行管理系统开发。
**文档**
## 文档
[中文文档](https://d2-projects.github.io/d2-admin-doc/zh/)
**完整版**
## 预览
[Github 仓库](https://github.com/d2-projects/d2-admin) |
[码云仓库](https://gitee.com/fairyever/d2-admin) |
[预览地址](https://d2-projects.github.io/d2-admin/)
> 演示项目部署在 GitHub Page如果网络较慢无法加载,请克隆到本地运行
**简化版模板**
[Github 仓库](https://github.com/d2-projects/d2-admin-start-kit) |
[码云仓库](https://gitee.com/fairyever/d2-admin-start-kit) |
[预览地址](https://fairyever.gitee.io/d2-admin-start-kit-preview)
**飞冰物料**
[D2Admin ICE](https://alibaba.github.io/ice/scaffold?type=vue) |
[介绍](https://juejin.im/post/5b6349716fb9a04f834669d6) |
[预览地址](https://fairyever.gitee.io/d2-admin-ice-preview)
> 预览部署在 Github Page ,如果您访问时由于网络原因卡在载入界面或者白屏,请克隆或者下载本仓库在本地运行查看效果。
## 功能
* 使用 vue-cli3 构建
* 首屏加载等待动画 避免首次加载白屏尴尬
* 简约主题
* 每个插件和组件都配有介绍文档
* 首屏加载等待动画
* 五款主题
* 详细的文档
* 登录和注销
* 根据路由自动生成菜单
* 分离的路由和菜单设置
* 可折叠侧边栏
* 方便的菜单设置
* 多国语言支持
* 多国语
* 富文本编辑器
* Markdown 编辑器
* 全屏功能
* 全屏
* Fontawesome 图标库
* 图标选择器(组件)
* 自动引入下载的 SVG 图标
* 前端假数据支持( mock
* 简化剪贴板操作
* 集成图表插件
* 图标选择器
* 自动注册 SVG 图标
* 模拟数据
* 剪贴板封装
* 图表库
* 时间日期计算工具
* 导入 Excel xlsx 格式 + csv 格式
* 数据导出 Excel xlsx 格式 + csv 格式
* 导入 Excel xlsx + csv
* 数据导出 Excel xlsx + csv
* 数据导出文本
* 数字动画
* 可拖拽调整大小的切分布局
* 可拖拽调整大小的区块布局
* 可拖拽调整大小和位置的网格布局
* 提供三种方便的页面容器组件(正常卡片,隐形容器,填满页面)
* 代码高亮显示
* 加载并解析(或者直接指定资源) markdown 文件
* 开箱即用的页面布局组件
* 加载并解析 markdown 文件
* GitHub 样式的 markdown 显示组件
* markdown 内代码高亮
* 为 markdown 扩展了百度云链接解析和优化显示
* 右键菜单组件
* 自定义滚动条和滚动控制
* 内置5种主题
* 公用样式抽离,方便的主题定制
* 打包后随意目录部署(已经做好兼容设置)
* 支持临时菜单配置
* 提供“试验台”功能 方便展示系统功能调用方法 `1.1.4 +`
* 系统功能展示模块 `1.1.4 +`
* 多标签页模式 `1.1.4 +`
* 美化滚动条 `1.1.4 +`
* json view `1.1.4 +`
@@ -83,10 +78,28 @@ D2Admin 是一个开源的管理系统前端集成方案,为了方便开发者
* 支持菜单 svg 图标 `1.3.0 +`
* 日志记录和错误捕捉 `1.3.0 +`
* 全局菜单搜索 `1.3.0 +`
* 登录重定向 `1.3.0 +`
* 自定义登录重定向 `1.3.0 +`
## 其它版本
| 名称 | Github / 主页 | 码云 | 预览 | 介绍 |
| --- | --- | --- | --- | --- |
| 简化版模板 | [Github](https://github.com/d2-projects/d2-admin-start-kit) | [码云](https://gitee.com/fairyever/d2-admin-start-kit) | [预览](https://fairyever.gitee.io/d2-admin-start-kit-preview) | 无 |
| 飞冰脚手架 | [飞冰](https://alibaba.github.io/ice/scaffold?type=vue) | 无 | [预览](https://fairyever.gitee.io/d2-admin-ice-preview) | [介绍](https://juejin.im/post/5b6349716fb9a04f834669d6) |
## 加入我们
D2Admin 是完全开源免费的项目,旨在帮助开发者更方便地进行管理系统开发,同时也提供 2000 人的 QQ 交流群和微信群,前后端的朋友可以相互答疑,项目组成员全部在内,所有 D2 相关项目使用问题欢迎在群内提问。
![join](https://raw.githubusercontent.com/FairyEver/d2-admin/master/doc/image/join@2x.png)
> 隐性福利:重要通知会发群红包
## 支持
![reward-me](https://raw.githubusercontent.com/FairyEver/d2-admin/master/doc/image/reward-me@2x.png)
![join](https://raw.githubusercontent.com/FairyEver/d2-admin/master/doc/image/give-a-star@2x.png)
## 加入小组
D2Admin 是完全开源免费的管理系统集成方案,由 [FairyEver](https://github.com/FairyEver) 在工作之余完全由兴趣驱动完成,如果你也一样喜欢前端开发,欢迎加入我们的讨论/学习群,群内可以`提问答疑``分享学习资料`或者随便扯淡
<img src="https://raw.githubusercontent.com/FairyEver/d2-admin/master/dev/github/join@2x.png"/>

View File

@@ -1,27 +0,0 @@
#!/usr/bin/env sh
# 确保脚本抛出遇到的错误
set -e
# 生成静态文件
npm run build
# 进入生成的文件夹
cd dist
# 如果是发布到自定义域名
# echo 'www.example.com' > CNAME
git init
git add -A
git commit -m 'deploy'
# 如果发布到 https://<USERNAME>.github.io
# git push -f git@github.com:<USERNAME>/<USERNAME>.github.io.git master
# 如果发布到 https://<USERNAME>.github.io/<REPO>
git push -f git@gitee.com:fairyever/d2-admin-preview-dev.git master
cd -
echo "publish to https://fairyever.gitee.io/d2-admin-preview-dev/#/index"

View File

@@ -1,27 +0,0 @@
#!/usr/bin/env sh
# 确保脚本抛出遇到的错误
set -e
# 生成静态文件
npm run build
# 进入生成的文件夹
cd dist
# 如果是发布到自定义域名
# echo 'www.example.com' > CNAME
git init
git add -A
git commit -m 'deploy'
# 如果发布到 https://<USERNAME>.github.io
# git push -f git@github.com:<USERNAME>/<USERNAME>.github.io.git master
# 如果发布到 https://<USERNAME>.github.io/<REPO>
git push -f git@gitee.com:fairyever/d2-admin-preview.git master
cd -
echo "publish to https://fairyever.gitee.io/d2-admin-preview/#/index"

View File

@@ -1,82 +0,0 @@
{
// 一个新的页面
"d2-new-page": {
"prefix": "dd-new-page",
"body": [
"<template>",
" <d2-container class=\"${1:page-name}\">",
" <!--",
" 可选 type = full(默认) | card | ghost",
" 可选 better-scroll 属性",
" 可选 better-scroll-option 属性",
" 文档 https://d2-projects.github.io/d2-admin-doc/zh/components/container.html",
" -->",
" <template slot=\"header\">header</template>",
" <span class=\"${1:page-name}_title\">this is [ {{name}} ]</span>",
" <template slot=\"footer\">footer</template>",
" </d2-container>",
"</template>",
"<script>",
"import { mapState, mapMutations } from 'vuex'",
"export default {",
" name: '${1:page-name}',",
" data () {",
" return {",
" name: '${1:page-name}'",
" }",
" },",
" computed: {",
" ...mapState({",
" // 访问用户信息",
" userInfo: state => state.d2admin.userInfo",
" })",
" },",
" methods: {",
" ...mapMutations([",
" // 操作公用数据",
" 'd2adminUtilDatabase',",
" // 操作用户私有数据",
" 'd2adminUtilDatabaseUser'",
" ])",
" }",
"}",
"</script>",
"<style lang=\"scss\" scoped>",
"@import '~@/assets/style/public.scss';",
".${1:page-name} {",
" .${1:page-name}_title {",
" font-size: 14px;",
" }",
" // Your page style here",
" // Do not use empty rulesets",
" // If the page does not need an additional definition style, please delete",
"}",
"</style>"
],
"description": "new page"
},
// d2-container 组件 header 插槽
"d2-container-header": {
"prefix": "dd-container-header",
"body": [
"<template slot=\"header\">${1:header}</template>"
],
"description": "d2-container component header slot"
},
// d2-container 组件 footer 插槽
"d2-container-footer": {
"prefix": "dd-container-footer",
"body": [
"<template slot=\"footer\">${1:footer}</template>"
],
"description": "d2-container component footer slot"
},
// 图标组件
"d2-icon": {
"prefix": "dd-icon",
"body": [
"<d2-icon name=\"${1:github}\"/>"
],
"description": "d2-icon component"
}
}

View File

@@ -1,82 +0,0 @@
{
// 一个新的页面
"d2-new-page": {
"prefix": "dd-new-page",
"body": [
"<template>",
" <d2-container class=\"${1:page-name}\">",
" <!--",
" 可选 type = full(默认) | card | ghost",
" 可选 better-scroll 属性",
" 可选 better-scroll-option 属性",
" 文档 https://d2-projects.github.io/d2-admin-doc/zh/components/container.html",
" -->",
" <template slot=\"header\">header</template>",
" <span class=\"${1:page-name}_title\">this is [ {{name}} ]</span>",
" <template slot=\"footer\">footer</template>",
" </d2-container>",
"</template>",
"<script>",
"import { mapState, mapMutations } from 'vuex'",
"export default {",
" name: '${1:page-name}',",
" data () {",
" return {",
" name: '${1:page-name}'",
" }",
" },",
" computed: {",
" ...mapState({",
" // 访问用户信息",
" userInfo: state => state.d2admin.userInfo",
" })",
" },",
" methods: {",
" ...mapMutations([",
" // 操作公用数据",
" 'd2adminUtilDatabase',",
" // 操作用户私有数据",
" 'd2adminUtilDatabaseUser'",
" ])",
" }",
"}",
"</script>",
"<style lang=\"scss\" scoped>",
"@import '~@/assets/style/public.scss';",
".${1:page-name} {",
" .${1:page-name}_title {",
" font-size: 14px;",
" }",
" // Your page style here",
" // Do not use empty rulesets",
" // If the page does not need an additional definition style, please delete",
"}",
"</style>"
],
"description": "new page"
},
// d2-container 组件 header 插槽
"d2-container-header": {
"prefix": "dd-container-header",
"body": [
"<template slot=\"header\">${1:header}</template>"
],
"description": "d2-container component header slot"
},
// d2-container 组件 footer 插槽
"d2-container-footer": {
"prefix": "dd-container-footer",
"body": [
"<template slot=\"footer\">${1:footer}</template>"
],
"description": "d2-container component footer slot"
},
// 图标组件
"d2-icon": {
"prefix": "dd-icon",
"body": [
"<d2-icon name=\"${1:github}\"/>"
],
"description": "d2-icon component"
}
}

105
doc/CH.md Normal file
View File

@@ -0,0 +1,105 @@
![banner](https://raw.githubusercontent.com/FairyEver/d2-admin/master/doc/image/banner.png)
<p align="center">
<a><img src="https://img.shields.io/github/release/d2-projects/d2-admin.svg"/></a>
<a><img src="https://badge.fury.io/js/%40d2-admin%2Fice-scaffold.svg"/></a>
<a><img src="https://www.travis-ci.org/d2-projects/d2-admin.svg?branch=master"/></a>
<a><img src="https://img.shields.io/github/last-commit/d2-projects/d2-admin.svg"/></a>
<a><img src="https://img.shields.io/badge/code_style-standard-brightgreen.svg"/></a>
</p>
<p align="center">
<a><img src="https://img.shields.io/github/issues/d2-projects/d2-admin.svg"/></a>
<a><img src="https://img.shields.io/github/issues-closed/d2-projects/d2-admin.svg"/></a>
<a><img src="https://img.shields.io/github/issues-pr/d2-projects/d2-admin.svg"/></a>
<a><img src="https://img.shields.io/github/issues-pr-closed/d2-projects/d2-admin.svg"/></a>
<a><img src="https://img.shields.io/github/forks/d2-projects/d2-admin.svg"/></a>
<a><img src="https://img.shields.io/github/stars/d2-projects/d2-admin.svg"/></a>
</p>
[D2Admin](https://github.com/d2-projects/d2-admin) 是一个完全**开源免费**的管理系统前端集成方案,为您做好大部分项目前期准备工作,提供大量示例代码,方便快速进行管理系统开发。
## 文档
[中文文档](https://d2-projects.github.io/d2-admin-doc/zh/)
## 预览
[预览地址](https://d2-projects.github.io/d2-admin/)
> 预览部署在 Github Page ,如果您访问时由于网络原因卡在载入界面或者白屏,请克隆或者下载本仓库在本地运行查看效果。
## 功能
* 使用 vue-cli3 构建
* 首屏加载等待动画
* 五款主题
* 详细的文档
* 登录和注销
* 分离的路由和菜单设置
* 可折叠侧边栏
* 多国语
* 富文本编辑器
* Markdown 编辑器
* 全屏
* Fontawesome 图标库
* 图标选择器
* 自动注册 SVG 图标
* 模拟数据
* 剪贴板封装
* 图表库
* 时间日期计算工具
* 导入 Excel xlsx + csv
* 数据导出 Excel xlsx + csv
* 数据导出文本
* 数字动画
* 可拖拽调整大小的区块布局
* 可拖拽调整大小和位置的网格布局
* 开箱即用的页面布局组件
* 加载并解析 markdown 文件
* GitHub 样式的 markdown 显示组件
* markdown 内代码高亮
* 为 markdown 扩展了百度云链接解析和优化显示
* 右键菜单组件
* 自定义滚动条和滚动控制
* 公用样式抽离,方便的主题定制
* 支持临时菜单配置
* 系统功能展示模块 `1.1.4 +`
* 多标签页模式 `1.1.4 +`
* 美化滚动条 `1.1.4 +`
* json view `1.1.4 +`
* cookie 封装 `1.1.5 +`
* 多标签页全局控制 API `1.1.5 +`
* 菜单全局控制 API `1.1.5 +`
* 多标签页关闭控制支持右键菜单 `1.1.10 +`
* 模块化全局状态管理 `1.2.0 +`
* 多种数据持久化方式:区分用户,区分路由,页面数据快照功能 `1.2.0 +`
* 支持跳出外部链接的菜单系统 `1.2.0 +`
* 支持菜单 svg 图标 `1.3.0 +`
* 日志记录和错误捕捉 `1.3.0 +`
* 全局菜单搜索 `1.3.0 +`
* 自定义登录重定向 `1.3.0 +`
## 其它版本
| 名称 | Github / 主页 | 码云 | 预览 | 介绍 |
| --- | --- | --- | --- | --- |
| 简化版模板 | [Github](https://github.com/d2-projects/d2-admin-start-kit) | [码云](https://gitee.com/fairyever/d2-admin-start-kit) | [预览](https://fairyever.gitee.io/d2-admin-start-kit-preview) | 无 |
| 飞冰脚手架 | [飞冰](https://alibaba.github.io/ice/scaffold?type=vue) | 无 | [预览](https://fairyever.gitee.io/d2-admin-ice-preview) | [介绍](https://juejin.im/post/5b6349716fb9a04f834669d6) |
## 加入我们
D2Admin 是完全开源免费的项目,旨在帮助开发者更方便地进行管理系统开发,同时也提供 2000 人的 QQ 交流群和微信群,前后端的朋友可以相互答疑,项目组成员全部在内,所有 D2 相关项目使用问题欢迎在群内提问。
![join](https://raw.githubusercontent.com/FairyEver/d2-admin/master/doc/image/join@2x.png)
> 隐性福利:重要通知会发群红包
## 支持
![reward-me](https://raw.githubusercontent.com/FairyEver/d2-admin/master/doc/image/reward-me@2x.png)
![join](https://raw.githubusercontent.com/FairyEver/d2-admin/master/doc/image/give-a-star@2x.png)