更新文档

Former-commit-id: 5a21bb3f1bf70fd1de808cdbea2a5fad778de464 [formerly 8d0c336b550fb7ce4dc93617de29604aa2d8630a] [formerly 5a21bb3f1bf70fd1de808cdbea2a5fad778de464 [formerly 8d0c336b550fb7ce4dc93617de29604aa2d8630a] [formerly 5a21bb3f1bf70fd1de808cdbea2a5fad778de464 [formerly 8d0c336b550fb7ce4dc93617de29604aa2d8630a] [formerly 8d0c336b550fb7ce4dc93617de29604aa2d8630a [formerly 84c797de25880d4fb78a11153d40a9fee8ffb7ab [formerly 6447cbc7144f3bd67f53075115515cea34261ea7]]]]]
Former-commit-id: 13585782f3a24d86f55a80c7207004d7633d0132
Former-commit-id: 4f11637eabae257323e1c706e6312d19449578e4
Former-commit-id: 07bc3b216e7f962b87507297ce0bf88926cf98a0 [formerly 1183cb04a12bab6b4bd39164530c97f1f21f5ffc]
Former-commit-id: 7cdb9ea00d61b5cfc8a99b6cc6c89bc538838d4b
Former-commit-id: 5ea1e0cc90453b9ada0c73807b4a6a6e8b424803
Former-commit-id: a10b450a9fcbaefd2ea0f2afe9a0d7afadd56abc
Former-commit-id: 99dd38066b10369894cd457883b628e0f0a35881
Former-commit-id: dd129072093b5d80dc843fa282266bbaceafb8be

docs/.vuepress/config.js

@@ -67,8 +67,10 @@ function sideBarGuide (title) {
       collapsable: false,
       children: [
         '',
+        'getting-started',
         'question',
         'pr',
+        'plagiarize',
         'change-log'
       ]
     }
@@ -82,7 +84,8 @@ function sideBarPlugins () {
     'data-import',
     'i18n',
     'mock',
-    'vuex'
+    'vuex',
+    'util'
   ]
 }
 

docs/zh/guide/getting-started.md

@@ -0,0 +1,11 @@
+# 快速上手
+
+> 使用教程正在补充
+
+在上手之前，建议您先大致浏览以下章节，对整个系统有大致了解
+
+* 每个页面最基础的构成部分：[页面容器](../components/container.md)
+* 一些你会用到的全局数据和方法：[VUEX 实用工具](../plugins/vuex.md)
+* 一些你会用到的公用方法：[Util 实用工具](../plugins/util.md)
+
+如果你想了解更多 D2Admin 相关的教程和更新文章，可以参阅 [文章](../article/)

docs/zh/guide/plagiarize.md

@@ -0,0 +1,37 @@
+# 借鉴者和抄袭者
+
+以下开源项目中存在 D2Admin 代码
+
+* 借鉴：少量复制代码，并明确放置 D2Admin 项目链接
+
+* 抄袭：大量复制
+
+**D2Admin 是作者从2018年1月就开始开发的心血，抄袭是很不道德的行为，如果你也发现了其它框架采用了本项目的代码和设计，欢迎联系我**
+
+::: tip
+图片右键在新标签页打开查看大图
+:::
+
+## nx-admin [ 抄袭 ]
+
+[https://github.com/mgbq/nx-admin](https://github.com/mgbq/nx-admin)
+
+| D2Admin | nx-admin |
+| --- | --- |
+| ![](http://fairyever.qiniudn.com/20180727103812.png?imageMogr2/auto-orient/thumbnail/1480x/blur/1x0/quality/100\|imageslim) | ![](http://fairyever.qiniudn.com/20180727103329.png?imageMogr2/auto-orient/thumbnail/1480x/blur/1x0/quality/100\|imageslim) |
+| ![](http://fairyever.qiniudn.com/20180727103923.png?imageMogr2/auto-orient/thumbnail/1480x/blur/1x0/quality/100\|imageslim) | ![](http://fairyever.qiniudn.com/20180727103931.png?imageMogr2/auto-orient/thumbnail/1480x/blur/1x0/quality/100\|imageslim) |
+| ![](http://fairyever.qiniudn.com/20180727104208.png?imageMogr2/auto-orient/thumbnail/1480x/blur/1x0/quality/100\|imageslim) | ![](http://fairyever.qiniudn.com/20180727104213.png?imageMogr2/auto-orient/thumbnail/1480x/blur/1x0/quality/100\|imageslim) |
+| ![](http://fairyever.qiniudn.com/20180727104225.png?imageMogr2/auto-orient/thumbnail/1480x/blur/1x0/quality/100\|imageslim) | ![](http://fairyever.qiniudn.com/20180727104232.png?imageMogr2/auto-orient/thumbnail/1480x/blur/1x0/quality/100\|imageslim) |
+| ![](http://fairyever.qiniudn.com/20180727104240.png?imageMogr2/auto-orient/thumbnail/1480x/blur/1x0/quality/100\|imageslim) | ![](http://fairyever.qiniudn.com/20180727104245.png?imageMogr2/auto-orient/thumbnail/1480x/blur/1x0/quality/100\|imageslim) |
+
+## avue [ 借鉴 ]
+
+[https://github.com/nmxiaowei/avue](https://github.com/nmxiaowei/avue)
+
+| D2Admin | avue |
+| --- | --- |
+| ![](http://fairyever.qiniudn.com/20180727104910.png?imageMogr2/auto-orient/thumbnail/1480x/blur/1x0/quality/100\|imageslim) | ![](http://fairyever.qiniudn.com/20180727104922.png?imageMogr2/auto-orient/thumbnail/1480x/blur/1x0/quality/100\|imageslim) |
+
+此页面对于借鉴者也算宣传，如果你少量使用并且标明出处，欢迎你。
+
+对于抄袭者，如果厚颜无耻，也可以当做是宣传。

docs/zh/plugins/util.md

@@ -0,0 +1,183 @@
+# Util 实用工具
+
+D2Admin 的 util 模块位置：`d2-admin/src/libs/util.js`
+
+下面列举您在开发中很有可能会用到的 util 模块方法。这并不是模块的全部内容，如果您有兴趣可以亲自浏览模块代码。
+
+## util.cookies.set
+
+**介绍：**
+
+存储 cookie 值
+
+**参数**
+
+| 参数名 | 介绍 | 必选 | 值类型 | 可选值 | 默认值 |
+| --- | --- | --- | --- | --- | --- |
+| name | 名称 | 必选 | String |  |  |
+| value | 值 | 必选 | String |  |  |
+| setting | 设置 | 必选 | Object | [js-cookie](https://github.com/js-cookie/js-cookie#readme) | `{ expires: 1 }` |
+
+**使用示例：**
+
+``` js
+util.cookies.set({
+  name: 'name',
+  value: 'value',
+  setting: {
+    expires: 365
+  }
+})
+```
+
+**为什么不直接使用 cookie：**
+
+util.cookies 内部使用 js-cookie 进行操作，并且在 cookie 名称上多做了一层逻辑封装，例如
+
+``` js
+util.cookies.set({
+  name: 'name',
+  value: 'value',
+  setting: {
+    expires: 365
+  }
+})
+```
+
+实际存储的 cookie 是
+
+`d2admin-${version}-name` : `value`
+
+使用
+
+``` js
+util.cookies.get('name')
+```
+
+实际取的也是 `d2admin-${version}-name`
+
+最后你的 cookie 信息实际上可能类似这样（举例）：
+
+* `d2admin-1.1.5-name` : `FairyEver`
+* `d2admin-1.1.5-uuid` : `h8dsafy98du9f6yadsyf`
+* `d2admin-1.1.5-token` : `dys87f89dsafy89adsh`
+
+这样做的好处是可以保证如果您的 D2Admin 升级到了新版本，打开时使用的数据一定是重新初始化的，而您在使用 cookie 时无论赋值还是取值，都觉察不出这层包装
+
+::: tip
+不止 cookie 这样，db 的存储逻辑也会自动根据版本区分
+:::
+
+## util.cookies.get
+
+**介绍：**
+
+拿到 cookie 值
+
+**参数**
+
+| 参数名 | 介绍 | 必选 | 值类型 | 可选值 | 默认值 |
+| --- | --- | --- | --- | --- | --- |
+| name | 名称 | 必选 | String |  |  |
+
+**使用示例：**
+
+``` js
+const data = util.cookies.get('name')
+```
+
+## util.cookies.getAll
+
+**介绍：**
+
+拿到 cookie 全部的值
+
+**参数**
+
+无
+
+**使用示例：**
+
+``` js
+const data = util.cookies.getAll()
+```
+
+## util.cookies.remove
+
+**介绍：**
+
+删除 cookie
+
+**参数**
+
+| 参数名 | 介绍 | 必选 | 值类型 | 可选值 | 默认值 |
+| --- | --- | --- | --- | --- | --- |
+| name | 名称 | 必选 | String |  |  |
+
+**使用示例：**
+
+``` js
+util.cookies.remove('name')
+```
+
+## util.title
+
+**介绍：**
+
+更新标题
+
+**参数**
+
+| 参数名 | 介绍 | 必选 | 值类型 | 可选值 | 默认值 |
+| --- | --- | --- | --- | --- | --- |
+| titleText | title 名称 | 必选 | String |  |  |
+
+**使用示例：**
+
+``` js
+util.title('NewTitle')
+```
+
+结果：**`${process.env.VUE_APP_TITLE}` | NewTitle**
+
+::: tip
+`process.env.VUE_APP_TITLE` 在 `d2-admin/.env` 和 `d2-admin/.env.development` 中设置
+:::
+
+## util.ua
+
+**介绍：**
+
+获取所有的 UA 信息
+
+**参数**
+
+无
+
+**使用示例：**
+
+``` js
+const ua = util.ua()
+```
+
+结果示例
+
+``` js
+{
+  browser: {
+    name: "Chrome",
+    version: "67.0.3396.99",
+    major: "67"
+  },
+  engine: {
+    name: "WebKit",
+    version: "537.36"
+  },
+  os: {
+    name: "Mac OS",
+    version: "10.13.4"
+  },
+  device: {},
+  cpu: {}
+}
+```