docs: 优化文档

This commit is contained in:
wanchun 2021-03-07 19:04:05 +08:00
parent 0b700847f2
commit 456d2c567c
8 changed files with 43 additions and 7 deletions

View File

@ -54,7 +54,7 @@ export default {
devServer: { port: 8080 }
};
```
::: tip
::: warning
`.fes.local.js` 是本地验证使用的临时配置,仅在 `fes dev` 时有效,请将其添加到 `.gitignore`,务必不要提交到 `git` 仓库中。
:::

View File

@ -58,8 +58,11 @@ mock 数据的配置文件。
### src 目录
#### .fes 目录
临时文件目录,比如入口文件、路由等,都会被临时生成到这里。不要提交 `.fes` 目录到 `git` 仓库,他们会在 `fes dev``fes build` 时被删除并重新生成。
临时文件目录,比如入口文件、路由等,都会被临时生成到这里。
:::warning
不要提交 `.fes` 目录到 `git` 仓库,他们会在 `fes dev``fes build` 时被删除并重新生成。
:::
#### pages 目录
所有路由组件存放在这里。

View File

@ -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
指定当前的环境,不同环境各自的配置文件。

View File

@ -158,3 +158,6 @@ export function onRouterCreated({ router }) {
});
}
```
## 更多配置项
Fes.js 允许插件注册运行时配置,如果你使用插件,肯定会在插件里找到更多运行时的配置项。

View File

@ -54,7 +54,7 @@ export default {
devServer: { port: 8080 }
};
```
::: tip
::: warning
`.fes.local.js` 是本地验证使用的临时配置,仅在 `fes dev` 时有效,请将其添加到 `.gitignore`,务必不要提交到 `git` 仓库中。
:::

View File

@ -58,10 +58,13 @@ mock 数据的配置文件。
### src 目录
#### .fes 目录
临时文件目录,比如入口文件、路由等,都会被临时生成到这里。不要提交 `.fes` 目录到 `git` 仓库,他们会在 `fes dev``fes build` 时被删除并重新生成。
临时文件目录,比如入口文件、路由等,都会被临时生成到这里。
:::warning
不要提交 `.fes` 目录到 `git` 仓库,他们会在 `fes dev``fes build` 时被删除并重新生成。
:::
#### pages 目录
所有路由组件存放在这里。
所有路由组件文件存放在这里。
#### app.js
运行时配置文件,可以在这里扩展运行时的能力,比如修改路由等。

View File

@ -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
指定当前的环境,不同环境各自的配置文件。

View File

@ -158,3 +158,6 @@ export function onRouterCreated({ router }) {
});
}
```
## 更多配置项
Fes.js 允许插件注册运行时配置,如果你使用插件,肯定会在插件里找到更多运行时的配置项。