From 2294202cf35438431740825d98473f63514de4f9 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E4=B8=87=E7=BA=AF?= <harrywan@webank.com>
Date: Tue, 2 Mar 2021 20:19:55 +0800
Subject: [PATCH] =?UTF-8?q?docs:=20=20=E6=8C=87=E5=8D=97-=E6=8F=92?=
 =?UTF-8?q?=E4=BB=B6?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 docs/.vuepress/configs/sidebar/zh.ts |  4 ++
 docs/zh/guide/env.md                 |  1 +
 docs/zh/guide/mock.md                |  1 +
 docs/zh/guide/plugin.md              | 66 ++++++++++++++++++++++++++++
 docs/zh/guide/route.md               | 22 +++++++---
 docs/zh/guide/template.md            |  1 +
 packages/fes-template/.fes.js        | 15 +------
 7 files changed, 89 insertions(+), 21 deletions(-)
 create mode 100644 docs/zh/guide/env.md
 create mode 100644 docs/zh/guide/mock.md
 create mode 100644 docs/zh/guide/plugin.md
 create mode 100644 docs/zh/guide/template.md

diff --git a/docs/.vuepress/configs/sidebar/zh.ts b/docs/.vuepress/configs/sidebar/zh.ts
index dcd618c7..4429ab85 100644
--- a/docs/.vuepress/configs/sidebar/zh.ts
+++ b/docs/.vuepress/configs/sidebar/zh.ts
@@ -16,6 +16,10 @@ export const zh: SidebarConfig = {
       children: [
         '/zh/guide/directory-structure.md', 
         '/zh/guide/route.md', 
+        '/zh/guide/plugin.md', 
+        '/zh/guide/template.md', 
+        '/zh/guide/mock.md', 
+        '/zh/guide/env.md', 
       ]
     },
     {
diff --git a/docs/zh/guide/env.md b/docs/zh/guide/env.md
new file mode 100644
index 00000000..e6948e3d
--- /dev/null
+++ b/docs/zh/guide/env.md
@@ -0,0 +1 @@
+# 环境变量
\ No newline at end of file
diff --git a/docs/zh/guide/mock.md b/docs/zh/guide/mock.md
new file mode 100644
index 00000000..b5e0efb3
--- /dev/null
+++ b/docs/zh/guide/mock.md
@@ -0,0 +1 @@
+# Mock 数据
\ No newline at end of file
diff --git a/docs/zh/guide/plugin.md b/docs/zh/guide/plugin.md
new file mode 100644
index 00000000..c2e703a2
--- /dev/null
+++ b/docs/zh/guide/plugin.md
@@ -0,0 +1,66 @@
+# 插件
+
+## 插件的 id 和 key
+每个插件都会对应一个 `id` 和一个 `key`，**`id` 是路径的简写，`key` 是进一步简化后用于配置的唯一值**。
+
+比如插件 `/node_modules/@webank/fes-plugin-foo/index.js`，通常来说，其 `id` 为 `@webank/fes-plugin-foo`，`key` 为 `foo`。
+
+## 启用插件
+插件有多种启用方式
+
+### package.json 依赖
+Fes.js 会自动检测 `dependencies` 和 `devDependencies` 里的 fes 插件，比如：
+```json
+{
+  "dependencies": {
+    "@webank/fes-plugin-request": "^2.0.0"
+  }
+}
+```
+那么 `@webank/fes-plugin-request` 会自动被注册，无需在配置里重复声明。
+
+### 配置
+在配置里可通过 `presets` 和 `plugins` 配置插件，比如：
+```js
+export default {
+    presets: ['./preset', 'foo/presets'],
+    plugins: ['./plugin'],
+}
+```
+通常用于几种情况：
+
+1. 项目相对路径的插件
+2. 非 npm 包入口文件的插件
+
+注意：
+- 请不要配置 npm 包的插件，否则会报重复注册的错误
+
+### 环境变量
+还可通过环境变量 `FES_PRESETS` 和 `FES_PLUGINS` 注册额外插件。
+
+比如：
+
+$ FES_PRESETS=/a/b/preset.js fes dev
+
+
+## 禁用插件
+
+通过配置插件的 `key` 为 `false`，比如：
+```js
+export default {
+    mock: false,
+}
+```
+会禁用 Fes.js 内置的 mock 插件及其功能。
+
+## 配置插件
+
+通过插件的 `key` 来配置插件，比如：
+```js
+export default {
+    mock: { 
+        prefix: '/v2'
+    }
+}
+```
+这里的 `mock` 是 `mock` 插件的 key。
\ No newline at end of file
diff --git a/docs/zh/guide/route.md b/docs/zh/guide/route.md
index 940c5b2b..d220b176 100644
--- a/docs/zh/guide/route.md
+++ b/docs/zh/guide/route.md
@@ -103,6 +103,11 @@ pages
 ]
 ```
 
+需要注意的是，满足以下任意规则的文件不会被注册为路由：
+- 不是 .vue 文件
+- components 目录中的文件
+
+
 ### 动态路由
 Fes.js 里约定以 `@` 开头的文件或文件夹映射为动态路由。
 比如：
@@ -200,14 +205,8 @@ const router = new VueRouter({
 ]
 ```
 
-### 忽略
-需要注意的是，满足以下任意规则的文件不会被注册为路由：
-- 不是 .vue 文件
-- components 目录中的文件
-
-
 ### 智能路由
-可以看到，编译后路由都会有count属性，这是我们根据精准匹配优先算法原则设计出路由排名算法，对匹配到的路由打分：
+可以看到，编译后路由都会有 `count` 属性，这是我们根据精准匹配优先算法原则设计出路由排名算法，对匹配到的路由打分：
 - 路由的路径每个子项得到4分
 - 子项为静态细分(`/list`)再加3分
 - 子项为动态细分（`/:orderId`）再加2分
@@ -217,6 +216,15 @@ const router = new VueRouter({
 当我们跳转路由时，如果URL匹配到多个路由，则选择分数最高的路由。
 
 ## 路由跳转
+
+### 声明式
+```vue
+<template>
+    <router-link to="/home">Home</router-link>
+</template>
+```
+
+### 命令式
 页面跳转 API 由 `router` 实例提供，查看 [Vue Rouer 文档](https://next.router.vuejs.org/zh/api/#router-%E6%96%B9%E6%B3%95)了解更多。
 
 ```js
diff --git a/docs/zh/guide/template.md b/docs/zh/guide/template.md
new file mode 100644
index 00000000..46e5c68e
--- /dev/null
+++ b/docs/zh/guide/template.md
@@ -0,0 +1 @@
+# HTML模板
\ No newline at end of file
diff --git a/packages/fes-template/.fes.js b/packages/fes-template/.fes.js
index 8e0fe175..4da201c7 100644
--- a/packages/fes-template/.fes.js
+++ b/packages/fes-template/.fes.js
@@ -24,20 +24,7 @@ export default {
             'changeOrigin': true, 
         },
     },
-    layout: {
-        title: "Fes.js",
-        footer: 'Created by MumbelFe',
-        multiTabs: false,
-        menus: [{
-            name: 'index'
-        }, {
-            name: 'onepiece'
-        }, {
-            name: 'store'
-        }, {
-            name: 'simpleList'
-        }]
-    },
+    layout: false,
     locale: {
         legacy: true
     },