From 456d2c567c6cbf9b07eeaf1d9e1ccee4876a0743 Mon Sep 17 00:00:00 2001 From: wanchun <445436867@qq.com> Date: Sun, 7 Mar 2021 19:04:05 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E4=BC=98=E5=8C=96=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/guide/config.md | 2 +- docs/guide/directory-structure.md | 5 ++++- docs/guide/env.md | 14 +++++++++++++- docs/guide/runtime-config.md | 3 +++ docs/zh/guide/config.md | 2 +- docs/zh/guide/directory-structure.md | 7 +++++-- docs/zh/guide/env.md | 14 +++++++++++++- docs/zh/guide/runtime-config.md | 3 +++ 8 files changed, 43 insertions(+), 7 deletions(-) diff --git a/docs/guide/config.md b/docs/guide/config.md index f6d8912d..dc32939c 100644 --- a/docs/guide/config.md +++ b/docs/guide/config.md @@ -54,7 +54,7 @@ export default { devServer: { port: 8080 } }; ``` -::: tip +::: warning `.fes.local.js` 是本地验证使用的临时配置，仅在 `fes dev` 时有效，请将其添加到 `.gitignore`，务必不要提交到 `git` 仓库中。 ::: diff --git a/docs/guide/directory-structure.md b/docs/guide/directory-structure.md index f34546d7..6593f105 100644 --- a/docs/guide/directory-structure.md +++ b/docs/guide/directory-structure.md @@ -58,8 +58,11 @@ mock 数据的配置文件。 ### src 目录 #### .fes 目录 -临时文件目录，比如入口文件、路由等，都会被临时生成到这里。不要提交 `.fes` 目录到 `git` 仓库，他们会在 `fes dev` 和 `fes build` 时被删除并重新生成。 +临时文件目录，比如入口文件、路由等，都会被临时生成到这里。 +:::warning +不要提交 `.fes` 目录到 `git` 仓库，他们会在 `fes dev` 和 `fes build` 时被删除并重新生成。 +::: #### pages 目录 所有路由组件存放在这里。 diff --git a/docs/guide/env.md b/docs/guide/env.md index 8dfa1ec6..04c928ad 100644 --- a/docs/guide/env.md +++ b/docs/guide/env.md @@ -1,4 +1,6 @@ # 环境变量 +在构建或者代码在端上运行中需要一些跟区分于环境的变量，用于配置构建流程或者运行时过程，这时候我们可以配置环境变量。 + ## 设置环境变量 @@ -64,8 +66,18 @@ FES_ENV=sit umi dev 如果两份配置中存在相同的项，则优先级高的会覆盖优先级低的。 ::: +## 运行时环境变量 +运行时环境变量需要以 `FES_APP_` 开头，比如在 `.env` 中配置： +``` +FES_APP_KEY=11111 +``` +在代码中使用： +```js +console.log(process.env.FES_APP_KEY) +// 输出 11111 +``` -## 环境变量列表 +## 编译时环境变量列表 ### FES_ENV 指定当前的环境，不同环境各自的配置文件。 diff --git a/docs/guide/runtime-config.md b/docs/guide/runtime-config.md index 5c9dc2d0..aa773ebb 100644 --- a/docs/guide/runtime-config.md +++ b/docs/guide/runtime-config.md @@ -158,3 +158,6 @@ export function onRouterCreated({ router }) { }); } ``` + +## 更多配置项 +Fes.js 允许插件注册运行时配置，如果你使用插件，肯定会在插件里找到更多运行时的配置项。 \ No newline at end of file diff --git a/docs/zh/guide/config.md b/docs/zh/guide/config.md index f6d8912d..dc32939c 100644 --- a/docs/zh/guide/config.md +++ b/docs/zh/guide/config.md @@ -54,7 +54,7 @@ export default { devServer: { port: 8080 } }; ``` -::: tip +::: warning `.fes.local.js` 是本地验证使用的临时配置，仅在 `fes dev` 时有效，请将其添加到 `.gitignore`，务必不要提交到 `git` 仓库中。 ::: diff --git a/docs/zh/guide/directory-structure.md b/docs/zh/guide/directory-structure.md index f34546d7..684e5878 100644 --- a/docs/zh/guide/directory-structure.md +++ b/docs/zh/guide/directory-structure.md @@ -58,10 +58,13 @@ mock 数据的配置文件。 ### src 目录 #### .fes 目录 -临时文件目录，比如入口文件、路由等，都会被临时生成到这里。不要提交 `.fes` 目录到 `git` 仓库，他们会在 `fes dev` 和 `fes build` 时被删除并重新生成。 +临时文件目录，比如入口文件、路由等，都会被临时生成到这里。 +:::warning +不要提交 `.fes` 目录到 `git` 仓库，他们会在 `fes dev` 和 `fes build` 时被删除并重新生成。 +::: #### pages 目录 -所有路由组件存放在这里。 +所有路由组件文件存放在这里。 #### app.js 运行时配置文件，可以在这里扩展运行时的能力，比如修改路由等。 \ No newline at end of file diff --git a/docs/zh/guide/env.md b/docs/zh/guide/env.md index 8dfa1ec6..04c928ad 100644 --- a/docs/zh/guide/env.md +++ b/docs/zh/guide/env.md @@ -1,4 +1,6 @@ # 环境变量 +在构建或者代码在端上运行中需要一些跟区分于环境的变量，用于配置构建流程或者运行时过程，这时候我们可以配置环境变量。 + ## 设置环境变量 @@ -64,8 +66,18 @@ FES_ENV=sit umi dev 如果两份配置中存在相同的项，则优先级高的会覆盖优先级低的。 ::: +## 运行时环境变量 +运行时环境变量需要以 `FES_APP_` 开头，比如在 `.env` 中配置： +``` +FES_APP_KEY=11111 +``` +在代码中使用： +```js +console.log(process.env.FES_APP_KEY) +// 输出 11111 +``` -## 环境变量列表 +## 编译时环境变量列表 ### FES_ENV 指定当前的环境，不同环境各自的配置文件。 diff --git a/docs/zh/guide/runtime-config.md b/docs/zh/guide/runtime-config.md index 5c9dc2d0..aa773ebb 100644 --- a/docs/zh/guide/runtime-config.md +++ b/docs/zh/guide/runtime-config.md @@ -158,3 +158,6 @@ export function onRouterCreated({ router }) { }); } ``` + +## 更多配置项 +Fes.js 允许插件注册运行时配置，如果你使用插件，肯定会在插件里找到更多运行时的配置项。 \ No newline at end of file