diff --git a/README.md b/README.md index 44f3b09e..e903e83a 100755 --- a/README.md +++ b/README.md @@ -1,30 +1,10 @@ -
-
-
|
|
+
+> 微信群需要先加群主才可以拉进群 PS 微信群交流不太方便,建议QQ群
## TODO
-D2Admin 仍然处于开发中,这里有一些计划:
+D2Admin 仍然处于开发中,这里有一些暂时的计划:
* 分离出简化版本
* 推出基于 [ice](https://alibaba.github.io/ice) 平台的版本
* 增加右上角通知中心
* 增加一些实例页面以提供业务页面布局建议
-* 更换图表库
-* 多 tab 页结构
* 面包屑导航
* 树型表格组件
-* `1.1.0 完成` 抽离项目里的文档,集中存放在文档站点
-* `1.1.0 完成` 对主界面进行一次完善,调整整体布局和颜色
-* `1.1.0 完成` 切换主题功能
+* 更多类型的编辑器
+* socket 连接
+* 浏览器版本提示
+* 日志控制台
+* `1.1.4 已完成` 自定义滚动条
+* `1.1.4 已完成` 多 tab 页结构
+* `1.1.3 已完成` 更换图表库
+* `1.1.0 已完成` 抽离项目里的文档,集中存放在文档站点
+* `1.1.0 已完成` 对主界面进行一次完善,调整整体布局和颜色
+* `1.1.0 已完成` 切换主题功能
欢迎你为 D2Admin 的开发作出贡献(代码编写/文档翻译)。
@@ -91,6 +91,8 @@ D2Admin 仍然处于开发中,这里有一些计划:
```
├─ build
├─ config
+├─ deploy
+├─ dist
├─ docs // 文档
├─ src
│ ├─ assets // 资源
@@ -99,17 +101,17 @@ D2Admin 仍然处于开发中,这里有一些计划:
│ │ ├─ library
│ │ └─ style
│ ├─ components // 组件
-│ │ ├─ charts
-│ │ ├─ core
-│ │ └─ demo
+│ │ ├─ charts // 图表组件
+│ │ ├─ core // 核心组件
+│ │ └─ demo // 示例组件
│ ├─ i18n // 多国语
+│ ├─ libs // 通用库
│ ├─ menu // 菜单
│ ├─ mock // 模拟数据
│ ├─ pages // 页面
│ ├─ plugin // 插件
│ ├─ router // 路由
│ ├─ store // vuex
-│ ├─ utils
│ ├─ App.vue
│ └─ main.js
├─ static // 静态资源
@@ -128,6 +130,18 @@ D2Admin 仍然处于开发中,这里有一些计划:
└─ package.json
```
+## 获取代码
+
+有两种方式可以获得 D2Admin 的代码
+
+* 在 [releases](https://github.com/FairyEver/d2-admin/releases) 页面下载最新的发行版。发行版一般是完成了某个大升级或者修复重要 bug 后发布的压缩包,你可以下载下来直接使用
+
+* Fork 仓库到你的 github 然后克隆到本地,然后使用 master 分支继续你的开发。这种方式得到的是最新的代码,但是会有未完成的新功能。**不建议使用这种方式**
+
+* 由于 github 访问较慢,推荐前往码云仓库下载 [gitee.com/fairyever/d2-admin](https://gitee.com/fairyever/d2-admin),码云上的仓库**在每次发布版本才会更新**,所以如果你选择此方法,请直接 fork 仓库并克隆到本地
+
+> 码云的仓库由 github 同步,但是发行版和标签同步有一些问题,所以推荐直接 fork 仓库
+
## 使用
```
@@ -140,19 +154,3 @@ npm run dev
// 打包
npm run build
```
-
-## 书写文档
-
-这里目前还有一个小遗憾,d2admin 使用的 webpack 版本不能符合 vuepress 的要求,所以如果你想在本地启动文档站点的服务,需要按下述步骤
-
-首先将 vuepress 安装到全局
-
-```
-npm i -g vuepress
-```
-
-启动服务
-
-```
-npm run doc:dev
-```
diff --git a/deploy-github-add.sh b/deploy-github-add.sh
deleted file mode 100755
index 956a4c0e..00000000
--- a/deploy-github-add.sh
+++ /dev/null
@@ -1,5 +0,0 @@
-set -e
-
-git add --all
-
-git commit -m 'auto commit on save'
\ No newline at end of file
diff --git a/deploy-doc.sh b/deploy/doc.sh
similarity index 100%
rename from deploy-doc.sh
rename to deploy/doc.sh
diff --git a/deploy-github.sh b/deploy/github.sh
similarity index 100%
rename from deploy-github.sh
rename to deploy/github.sh
diff --git a/deploy-preview.sh b/deploy/preview.sh
similarity index 100%
rename from deploy-preview.sh
rename to deploy/preview.sh
diff --git a/design.sketch.REMOVED.git-id b/design.sketch.REMOVED.git-id
index 7d792df5..6a952f10 100644
--- a/design.sketch.REMOVED.git-id
+++ b/design.sketch.REMOVED.git-id
@@ -1 +1 @@
-fa557a428388c3e73ddee4997e5feb56297e1304
\ No newline at end of file
+6a5c83d50f23558fd07642b7445ac467a31d9354
\ No newline at end of file
diff --git a/design/d2-layout-main-group.xmind.REMOVED.git-id b/design/d2-layout-main-group.xmind.REMOVED.git-id
new file mode 100644
index 00000000..ba2b8b21
--- /dev/null
+++ b/design/d2-layout-main-group.xmind.REMOVED.git-id
@@ -0,0 +1 @@
+f6ee530a7841eb687cae7821453739533292ddd6
\ No newline at end of file
diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
index a0edcd07..250e2a18 100644
--- a/docs/.vuepress/config.js
+++ b/docs/.vuepress/config.js
@@ -90,6 +90,7 @@ function sideBarComponents (title) {
children: [
'',
'charts',
+ 'charts-new',
'container',
'count-up',
'highlight',
diff --git a/docs/zh/components/charts-new.md b/docs/zh/components/charts-new.md
new file mode 100644
index 00000000..3a4f8b86
--- /dev/null
+++ b/docs/zh/components/charts-new.md
@@ -0,0 +1,13 @@
+# 图表 [ v-charts ]
+
+::: tip
+`1.1.0` 版本使用的是 `G2` 图表库,`1.1.3` 开始使用 `v-charts`
+:::
+
+## 介绍
+
+在使用 echarts 生成图表时,经常需要做繁琐的数据类型转化、修改复杂的配置项,v-charts 的出现正是为了解决这个痛点。基于 Vue2.0 和 echarts 封装的 v-charts 图表组件,只需要统一提供一种对前后端都友好的数据格式设置简单的配置项,便可轻松生成常见的图表。
+
+[v-charts 文档](https://v-charts.js.org/#/)
+
+处于对用户使用方便的角度考虑,从 `1.1.3` 开始使用 v-charts。项目中已经安装并注册完毕 v-charts,你可以直接使用
\ No newline at end of file
diff --git a/docs/zh/components/container.md b/docs/zh/components/container.md
index e5dabe9a..ca365897 100644
--- a/docs/zh/components/container.md
+++ b/docs/zh/components/container.md
@@ -7,6 +7,7 @@
| 参数名 | 介绍 | 必选 | 值类型 | 可选值 | 默认值 |
| --- | --- | --- | --- | --- | --- |
| type | 容器类型 | 非 | String | card ghost full | card |
+| scroll | 滚动优化 | 非 | Boolean | | false |
| responsive | 响应式宽度 | 非 | Boolean | | false |
::: tip
@@ -39,7 +40,7 @@ export default {
```
-## 基础页面容器
+### 基础页面容器
高度根据内容适应
@@ -58,7 +59,7 @@ export default {
```
-## 自适应填充页面容器
+### 自适应填充页面容器
无论内容高度多少,都会自动撑满页面,并有可选的 `header` 和 `footer` 插槽
@@ -78,12 +79,34 @@ export default {
```
-## 隐形页面容器
+`v1.1.4` 新增
-不显示任何背景色和边框
+你可以通过设置 `scroll` 来启用自定义滚动条,看起来更美观一些
+
+示例:
+
+``` vue
+
+