Files
mes-ui-d2/docs/zh/guide/README.md
liyang 9b66857c06 no message
Former-commit-id: 6975ab2f3fee9271b0093e25bc110063f568d2b3 [formerly 00922c2d5802ef0eadc80db63f4425fd3e569cc6] [formerly 6975ab2f3fee9271b0093e25bc110063f568d2b3 [formerly 00922c2d5802ef0eadc80db63f4425fd3e569cc6] [formerly 6975ab2f3fee9271b0093e25bc110063f568d2b3 [formerly 00922c2d5802ef0eadc80db63f4425fd3e569cc6] [formerly 00922c2d5802ef0eadc80db63f4425fd3e569cc6 [formerly 588b21765e2555084561883276c9aacdb3f667dc [formerly c1f711002539cec918785f3c199d01bae0e3337d]]]]]
Former-commit-id: 53eac93584feb4b0d4c9d74d55ac727fa40f7e52
Former-commit-id: f08c03a4167b96f89b83f37d925d1afd50d800ad
Former-commit-id: 8c788cb7c3811ef09fb6652b1212cc3c7c910d7c [formerly ae0970cc570ec60ffb3e7a19040dfc45c6ffad5e]
Former-commit-id: e7e417c3b0b64e2ca416fd8cc3ce158de3efa87e
Former-commit-id: 82cbef337da26e16534133429ebfc560a7479de9
Former-commit-id: 1e0ac750745edc4139dea13614d07b558b68bd1e
Former-commit-id: e7e3627a3ebf102021e61c07514af4cce23deb79
Former-commit-id: 2004f08234248a3234e0c1af816eddfb74f462dc
2018-06-20 16:33:55 +08:00

150 lines
4.7 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 介绍
D2Admin 是一个开源的管理系统前端集成方案
[Github仓库](https://github.com/FairyEver/d2-admin) - [预览地址](http://d2admin.fairyever.com/)
<div>
<iframe src="//ghbtns.com/github-btn.html?user=FairyEver&repo=d2-admin&type=star&count=true" allowtransparency="true" frameborder="0" scrolling="0" width="100" height="20"></iframe>
<iframe src="//ghbtns.com/github-btn.html?user=FairyEver&repo=d2-admin&type=fork&count=true" allowtransparency="true" frameborder="0" scrolling="0" width="100" height="20"></iframe>
</div>
::: tip
因为现在集成了很多的插件和组件,首次加载会占用很多的时间,虽然已经做了首屏加载动画,但还是建议您在发布之前一定要删除没有用到的代码,比如项目没有用到图表、示例、插件组件。
:::
## 关于
D2Admin 是完全开源免费的管理系统集成方案,由 [FairyEver](https://github.com/FairyEver) 在工作之余完全由兴趣驱动完成,如果你也一样喜欢前端开发,欢迎加入我们的讨论,群内可以`提问答疑``分享学习资料`或者随便扯淡
::: tip Thanks
D2Admin 创建于2018年1月14日零点51分在2018年5月26日正式发布中间断断续续做了四个多月发布一个月内收获将近 700star在此对支持我的人表示感谢
:::
<img style="margin-top: 50px;" src="./image/qr.png">
## 功能
* 首屏加载等待动画 避免首次加载白屏尴尬
* 简约主题
* 每个插件和组件都配有介绍文档
* 图片资源 sketch 源文件( 可以在这个文件内重新生成所有图片资源
* 登陆和注销
* 根据路由自动生成菜单
* 可折叠侧边栏
* 方便的菜单设置
* 多国语言支持
* 富文本编辑器
* Markdown 编辑器
* 全屏功能
* [Fontawesome](https://fontawesome.com/) 图标库
* 图标选择器(组件)
* 自动引入下载的 SVG 图标
* 前端假数据支持( mock
* 集成 [G2](http://g2.alipay.com/) 图表
* 图表自适应可拖拽大小的卡片容器(示例)
* 简化剪贴板操作
* 简化Cookie操作
* 时间日期计算工具
* 导入 Excel xlsx 格式 + csv 格式
* 数据导出 Excel xlsx 格式 + csv 格式
* 数据导出文本
* 数字动画
* 可拖拽调整大小的切分布局
* 可拖拽调整大小和位置的网格布局
* 提供三种方便的页面容器组件(正常卡片,隐形容器,填满页面)
* 代码高亮显示
* 加载并解析(或者直接指定资源) markdown 文件
* GitHub 样式的 markdown 显示组件
* markdown 内代码高亮
* 为 markdown 扩展了百度云链接解析和优化显示
* 右键菜单组件
* 自定义滚动条和滚动控制
* 内置4种主题
* 公用样式抽离,方便的主题定制
* 支持百万级数据量的表格组件
## TODO
D2Admin 仍然处于开发中,这里有一些计划:
* `1.1.0 完成` 抽离项目里的文档,集中存放在文档站点
* `1.1.0 完成` 对主界面进行一次完善,调整整体布局和颜色
* `1.1.0 完成` 切换主题功能
* `1.1.0 完成` 使用自定义滚动条
* 分离出简化版本
* 推出基于 [ice](https://alibaba.github.io/ice) 平台的版本
* 增加右上角通知中心
* 增加一些实例页面以提供业务页面布局建议
* 更换图表库
* 树型表格组件
欢迎你为 D2Admin 的开发作出贡献(代码编写/文档翻译)。
## 目录结构
```
├─ build
├─ config
├─ docs // 文档
├─ src
│ ├─ assets // 资源
│ │ ├─ icons
│ │ ├─ image
│ │ ├─ library
│ │ └─ style
│ ├─ components // 组件
│ │ ├─ charts
│ │ ├─ core
│ │ └─ demo
│ ├─ i18n // 多国语
│ ├─ menu // 菜单
│ ├─ mock // 模拟数据
│ ├─ pages // 页面
│ ├─ plugin // 插件
│ ├─ router // 路由
│ ├─ store // vuex
│ ├─ utils
│ ├─ App.vue
│ └─ main.js
├─ static // 静态资源
├─ .babelrc
├─ .editorconfig
├─ .eslintignore
├─ .eslintrc.js
├─ .gitattributes
├─ .gitignore
├─ .postcssrc.js
├─ LICENSE
├─ README.md
├─ deploy.sh
├─ design.sketch // 设计文件
├─ index.html
└─ package.json
```
## 使用
首先下载模板 [d2-admin/releases](https://github.com/FairyEver/d2-admin/releases)
::: tip
不要直接克隆本项目,请选择上面已经发行的版本,如果克隆仓库,你将会得到不完全的代码。尤其不要使用 dev 分支
:::
```
// 安装依赖
npm i
// 运行
npm run dev
// 打包
npm run build
// 本地文档调试
npm run doc:dev
```
> 如果上述步骤出现错误,建议您升级 node 版本 >8如果有其它疑问请参考[常见问题](/zh/guide/q-a.html)