diff --git a/docs/zh/README.md b/docs/zh/README.md index 50bd2b84..4c77bbbb 100644 --- a/docs/zh/README.md +++ b/docs/zh/README.md @@ -16,8 +16,15 @@ footer: MIT Licensed | Copyright © 2018-present FairyEver ``` // 安装依赖 npm i + // 运行 npm run dev + // 打包 npm run build -``` \ No newline at end of file + +// 本地文档调试 +npm run doc:dev +``` + +> 如果上述步骤出现错误,请将您的 node 版本升级 >8,如果有其它疑问请参考[常见问题](/zh/guide/q-a.html) \ No newline at end of file diff --git a/docs/zh/guide/README.md b/docs/zh/guide/README.md index 12bc06de..2074cf67 100644 --- a/docs/zh/guide/README.md +++ b/docs/zh/guide/README.md @@ -1,6 +1,6 @@ # 介绍 -d2-admin(以下简称 d2admin)是一个开源的管理系统前端集成方案 +D2Admin 是一个开源的管理系统前端集成方案 [Github仓库](https://github.com/FairyEver/d2-admin) - [预览地址](http://d2admin.fairyever.com/) @@ -10,12 +10,12 @@ d2-admin(以下简称 d2admin)是一个开源的管理系统前端集成方 ::: tip -因为现在集成了很多的插件和组件,首次加载会占用较多的时间,虽然已经做了首屏加载动画,还是建议您在发布的时候一定要删除没有用到的代码。比如项目没有用到图表,最好将集成的图表库以及封装的图表组件删除。 +因为现在集成了很多的插件和组件,首次加载会占用很多的时间,虽然已经做了首屏加载动画,但还是建议您在发布之前一定要删除没有用到的代码,比如项目没有用到图表、示例、插件组件。 ::: -## 前端兴趣交流群 +## 小组 -欢迎加入我们的讨论 +D2Admin 是完全开源免费的管理系统集成方案,由 [FairyEver](https://github.com/FairyEver) 在工作之余完全由兴趣驱动完成,如果你也一样喜欢前端开发,欢迎加入我们的讨论,群内可以`提问答疑`,`分享学习资料`或者随便扯淡 @@ -28,12 +28,13 @@ d2-admin(以下简称 d2admin)是一个开源的管理系统前端集成方 * 登陆和注销 * 根据路由自动生成菜单 * 可折叠侧边栏 +* 方便的菜单设置 * 多国语言支持 * 富文本编辑器 * Markdown 编辑器 * 全屏功能 * [Fontawesome](https://fontawesome.com/) 图标库 -* [Fontawesome](https://fontawesome.com/) 图标选择器(组件) +* 图标选择器(组件) * 自动引入下载的 SVG 图标 * 前端假数据支持( mock ) * 集成 [G2](http://g2.alipay.com/) 图表 @@ -41,34 +42,40 @@ d2-admin(以下简称 d2admin)是一个开源的管理系统前端集成方 * 简化剪贴板操作 * 简化Cookie操作 * 时间日期计算工具 -* 导入 Excel ( xlsx 格式 + CSV 格式 ) -* 数据导出 Excel ( xlsx 格式 + CSV 格式 ) +* 导入 Excel ( xlsx 格式 + csv 格式 ) +* 数据导出 Excel ( xlsx 格式 + csv 格式 ) * 数据导出文本 * 数字动画 * 可拖拽调整大小的切分布局 * 可拖拽调整大小和位置的网格布局 -* 提供三种页面容器组件(正常卡片,隐形容器,填满页面) +* 提供三种方便的页面容器组件(正常卡片,隐形容器,填满页面) * 代码高亮显示 -* 加载并解析 markdown 文件 +* 加载并解析(或者直接指定资源) markdown 文件 * GitHub 样式的 markdown 显示组件 * markdown 内代码高亮 * 为 markdown 扩展了百度云链接解析和优化显示 +* 右键菜单组件 +* 自定义滚动条和滚动控制 +* 内置4种主题 +* 公用样式抽离,方便的主题定制 +* 支持百万级数据量的表格组件 ## TODO -d2admin 仍然处于开发中,这里有一些计划: +D2Admin 仍然处于开发中,这里有一些计划: -* 抽离项目里的文档,集中存放在文档站点 -* 对主界面进行一次完善,调整整体布局和颜色 -* 切换主题功能 -* 使用自定义滚动条 +* `1.1.0 完成` 抽离项目里的文档,集中存放在文档站点 +* `1.1.0 完成` 对主界面进行一次完善,调整整体布局和颜色 +* `1.1.0 完成` 切换主题功能 +* `1.1.0 完成` 使用自定义滚动条 * 分离出简化版本 * 推出基于 [ice](https://alibaba.github.io/ice) 平台的版本 * 增加右上角通知中心 * 增加一些实例页面以提供业务页面布局建议 * 更换图表库 +* 树型表格组件 -欢迎你为 d2admin 的开发作出贡献。 +欢迎你为 D2Admin 的开发作出贡献(代码编写/文档翻译)。 ## 目录结构 @@ -123,7 +130,7 @@ d2admin 仍然处于开发中,这里有一些计划: 首先下载模板 [d2-admin/releases](https://github.com/FairyEver/d2-admin/releases) ::: tip -不要直接克隆本项目,请选择已经发行的版本,尤其不要使用 dev 分支 +不要直接克隆本项目,请选择上面已经发行的版本,如果克隆仓库,你将会得到不完全的代码。尤其不要使用 dev 分支 ::: 安装依赖