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..b96bb263 --- /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/#/) + +D2Admin 已经安装并注册完毕 v-charts,你可以直接使用 \ No newline at end of file diff --git a/docs/zh/components/container.md b/docs/zh/components/container.md index dbff3d8a..95731ba3 100644 --- a/docs/zh/components/container.md +++ b/docs/zh/components/container.md @@ -40,7 +40,7 @@ export default { ``` -## 基础页面容器 +### 基础页面容器 高度根据内容适应 @@ -59,7 +59,7 @@ export default { ``` -## 自适应填充页面容器 +### 自适应填充页面容器 无论内容高度多少,都会自动撑满页面,并有可选的 `header` 和 `footer` 插槽 @@ -83,7 +83,7 @@ export default { 你可以通过设置 `:scroll="true"` 来启用自定义滚动条,看起来更美观一些 -## 隐形页面容器 +### 隐形页面容器 不显示任何背景色和边框 @@ -91,4 +91,4 @@ export default { 主体内容 -``` \ No newline at end of file +``` diff --git a/docs/zh/guide/README.md b/docs/zh/guide/README.md index 756fe94d..fe680ad8 100644 --- a/docs/zh/guide/README.md +++ b/docs/zh/guide/README.md @@ -68,10 +68,12 @@ D2Admin 创建于2018年1月14日零点51分,在2018年5月26日正式发布 * 为 markdown 扩展了百度云链接解析和优化显示 * 右键菜单组件 * 自定义滚动条和滚动控制 -* 内置4种主题 +* 内置5种主题 * 公用样式抽离,方便的主题定制 * 支持百万级数据量的表格组件 * 打包后随意目录部署(已经做好兼容设置) +* 多标签页模式 `1.1.4 +` +* 支持临时菜单配置 ## TODO @@ -81,17 +83,18 @@ D2Admin 仍然处于开发中,这里有一些暂时的计划: * 推出基于 [ice](https://alibaba.github.io/ice) 平台的版本 * 增加右上角通知中心 * 增加一些实例页面以提供业务页面布局建议 -* 更换图表库 -* 多 tab 页结构 * 面包屑导航 * 树型表格组件 * 更多类型的编辑器 * socket 连接 * 浏览器版本提示 * 日志控制台 -* `1.1.0 完成` 抽离项目里的文档,集中存放在文档站点 -* `1.1.0 完成` 对主界面进行一次完善,调整整体布局和颜色 -* `1.1.0 完成` 切换主题功能 +* `1.1.4 已完成` 自定义滚动条 +* `1.1.4 已完成` 多 tab 页结构 +* `1.1.3 已完成` 更换图表库 +* `1.1.0 已完成` 抽离项目里的文档,集中存放在文档站点 +* `1.1.0 已完成` 对主界面进行一次完善,调整整体布局和颜色 +* `1.1.0 已完成` 切换主题功能 欢迎你为 D2Admin 的开发作出贡献(代码编写/文档翻译)。 @@ -100,6 +103,8 @@ D2Admin 仍然处于开发中,这里有一些暂时的计划: ``` ├─ build ├─ config +├─ deploy +├─ dist ├─ docs // 文档 ├─ src │ ├─ assets // 资源 @@ -112,13 +117,13 @@ D2Admin 仍然处于开发中,这里有一些暂时的计划: │ │ ├─ core // 核心组件 │ │ └─ demo // 示例组件 │ ├─ i18n // 多国语 +│ ├─ libs // 通用库 │ ├─ menu // 菜单 │ ├─ mock // 模拟数据 │ ├─ pages // 页面 │ ├─ plugin // 插件 │ ├─ router // 路由 │ ├─ store // vuex -│ ├─ utils // 通用函数 │ ├─ App.vue │ └─ main.js ├─ static // 静态资源 @@ -135,7 +140,6 @@ D2Admin 仍然处于开发中,这里有一些暂时的计划: ├─ design.sketch // 设计文件 ├─ index.html └─ package.json - ``` ## 获取代码 @@ -146,6 +150,10 @@ D2Admin 仍然处于开发中,这里有一些暂时的计划: * Fork 仓库到你的 github 然后克隆到本地,然后使用 master 分支继续你的开发。这种方式得到的是最新的代码,但是会有未完成的新功能。**不建议使用这种方式** +* 由于 github 访问较慢,推荐前往码云仓库下载 [gitee.com/fairyever/d2-admin](https://gitee.com/fairyever/d2-admin),码云上的仓库**在每次发布版本才会更新**,所以如果你选择此方法,请直接 fork 仓库并克隆到本地 + +> 码云的仓库由 github 同步,但是发行版和标签同步有一些问题,所以推荐直接 fork 仓库 + ## 使用 ``` @@ -178,5 +186,5 @@ npm run doc:dev ``` ::: tip -你可能会发现项目目录中有一个 deploy.sh 文件,这个文件是为了方便发布文档用的,通常你并不需要使用它 +你可能会发现项目目录中有一个 deploy 文件夹,这个文件是为了方便发布和提交代码用的,通常你并不需要使用它 ::: \ No newline at end of file