From ae964c3442eae711c6bed6a832b4ea24c6389710 Mon Sep 17 00:00:00 2001
From: toesbieya <1647775459@qq.com>
Date: Tue, 1 Dec 2020 20:47:03 +0800
Subject: [PATCH] =?UTF-8?q?=E6=96=87=E6=A1=A3=E6=9B=B4=E6=96=B0?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 docs/frontend/README.md               |  4 +++-
 docs/frontend/global-methods/guide.md | 18 ++++++++----------
 2 files changed, 11 insertions(+), 11 deletions(-)

diff --git a/docs/frontend/README.md b/docs/frontend/README.md
index e6d6b40..1967984 100644
--- a/docs/frontend/README.md
+++ b/docs/frontend/README.md
@@ -41,7 +41,7 @@
 │   ├── component              # 公用组件
 │   ├── config
 │   │   │── index.js           # 基础配置项
-│   ├── directive              # 自定义指令集合
+│   ├── directive              # 全局指令
 │   ├── filter                 # 自定义过滤器集合
 │   ├── globalMethod           # 全局方法，已挂载到Vue原型上，使用this.$xx调用
 │   ├── layout                 # 布局文件夹，包含了导航栏、侧边栏、多页签、全局页脚
@@ -56,6 +56,8 @@
 │   ├── store                  # vuex配置
 │   ├── util                   # 工具类
 │   ├── view                   # 路由页面集合
+│   │   │── _app               # 系统页面，如登录注册、404等
+│   │   └── _common            # 公用页面
 │   ├── App.vue
 │   └── main.js
 ```
diff --git a/docs/frontend/global-methods/guide.md b/docs/frontend/global-methods/guide.md
index 6804d19..ec9e54d 100644
--- a/docs/frontend/global-methods/guide.md
+++ b/docs/frontend/global-methods/guide.md
@@ -4,16 +4,12 @@
 
 ### 使用：
 
-- 在 `@/mixins/guide/data` 下创建导航步骤，例如 `test.js`。
-
-- 在需要导航的路由页面里引入 `@/mixins/guide`，并混入 `mixins: [guide.test]`
-
 ```js
 //配置导航
 this.$guide.config(config)
 
 //开始一个导航
-this.$guide(start,steps,[,beforeExist])
+this.$guide(steps,index[,beforeExist])
 
 //退出导航
 this.$guide.exit()
@@ -32,11 +28,12 @@ this.$guide.exit()
 }
 ```
 
-### $guide(start,steps,[,beforeExist])
-
-- `start` : `number / string`，从第几个步骤开始，`number` 型从0开始，`string` 型可以为 `'first'` 或 `'last'`。
+### $guide(steps,index[,beforeExist])
 
 - `step` : `array`，导航步骤数组，所有可配置项如下：
+
+- `index` : `number / string`，从第几个步骤开始，`number` 时从0开始，`string` 时可以为 `'first'` 或 `'last'`，默认为0。
+
 ```js
 {
     ...config,
@@ -46,11 +43,12 @@ this.$guide.exit()
     forceShowNextBtn: boolean, 是否强制显示下一步按钮
     onPrevious: function, 跳转到上一个导航步骤前触发，返回false或Promise.reject()来阻止跳转
     onNext: function, 跳转到下一个导航步骤前触发，返回false或Promise.reject()来阻止跳转
+    onHighlighted: function，当前导航步骤高亮完成后触发
 }
 ```
 
 - `beforeExist` : `function`，退出导航前触发，回调参数是一个 `boolean`，表示当前是否是最后一个步骤，返回 `false` 或 `Promise.reject()` 来阻止退出。
 
-### $guide.exit()
+### $guide.exit(force)
 
-退出导航，会触发 `beforeExist` 钩子
+- `force` : `boolean`，`true` 时会强制退出，忽略所有钩子，否则会触发 `beforeExist`