blackteay/fes.js
1
0
Fork 0
mirror of https://github.com/WeBankFinTech/fes.js.git synced 2025-04-06 03:59:53 +08:00
Code Issues Projects Releases Wiki Activity

docs: 更正文档

Browse Source
This commit is contained in:
万纯 2021-03-08 20:49:35 +08:00
parent c52cf06aa7
commit 1838047624
6 changed files with 15 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/guide/env.md
View File

@ -8,10 +8,10 @@
比如： 比如：
```bash ```bash
# OS X, Linux # OS X, Linux
PORT=3000 umi dev PORT=3000 fes dev
# Windows (cmd.exe) # Windows (cmd.exe)
set PORT=3000 && umi dev set PORT=3000 && fes dev
``` ```
如果要同时考虑 OS X 和 Windows，可借助三方工具 [cross-env](https://github.com/kentcdodds/cross-env) 如果要同时考虑 OS X 和 Windows，可借助三方工具 [cross-env](https://github.com/kentcdodds/cross-env)
<CodeGroup> <CodeGroup>
@ -19,7 +19,7 @@ set PORT=3000 && umi dev
```bash ```bash
yarn add cross-env --dev yarn add cross-env --dev
cross-env PORT=3000 umi dev cross-env PORT=3000 fes dev
``` ```
</CodeGroupItem> </CodeGroupItem>
@ -27,7 +27,7 @@ cross-env PORT=3000 umi dev
```bash ```bash
npm i cross-env --save-dev npm i cross-env --save-dev
cross-env PORT=3000 umi dev cross-env PORT=3000 fes dev
``` ```
</CodeGroupItem> </CodeGroupItem>
@ -54,7 +54,7 @@ fes dev
举个 🌰 ： 举个 🌰 ：
```bash ```bash
FES_ENV=sit umi dev FES_ENV=sit fes dev
``` ```
如果存在 `.env.sit` 文件，则会将 `.env.sit` 的配置和 `.env` 做 `merge` 后形成最终配置。 如果存在 `.env.sit` 文件，则会将 `.env.sit` 的配置和 `.env` 做 `merge` 后形成最终配置。

17
docs/guide/runtime-config.md
View File

@ -127,23 +127,6 @@ render(oldRender: Function)
覆写 render。 覆写 render。
比如用于渲染之前做权限校验:
```js
import { history } from 'umi';
export function render(oldRender) {
fetch('/api/auth').then(auth => {
if (auth.isLogin) { oldRender() }
else {
history.push('/login');
oldRender()
}
});
}
```
### onRouterCreated ### onRouterCreated
onRouterCreated({router}) onRouterCreated({router})

4
docs/reference/api/README.md
View File

@ -15,9 +15,9 @@ import { someApi } from "@fesjs/fes"
主要在插件里面使用，项目代码中一般用不到。 主要在插件里面使用，项目代码中一般用不到。
::: :::
运行时插件接口，是 Umi 内置的跑在浏览器里的一套插件体系。 运行时插件接口，是 Fes.js 内置的跑在浏览器里的一套插件体系。
```js ```js
import { plugin, ApplyPluginsType } from 'umi'; import { plugin, ApplyPluginsType } from '@fesjs/fes';
// 注册插件 // 注册插件
plugin.register({ plugin.register({

10
docs/zh/guide/env.md
View File

@ -8,10 +8,10 @@
比如： 比如：
```bash ```bash
# OS X, Linux # OS X, Linux
PORT=3000 umi dev PORT=3000 fes dev
# Windows (cmd.exe) # Windows (cmd.exe)
set PORT=3000 && umi dev set PORT=3000 && fes dev
``` ```
如果要同时考虑 OS X 和 Windows，可借助三方工具 [cross-env](https://github.com/kentcdodds/cross-env) 如果要同时考虑 OS X 和 Windows，可借助三方工具 [cross-env](https://github.com/kentcdodds/cross-env)
<CodeGroup> <CodeGroup>
@ -19,7 +19,7 @@ set PORT=3000 && umi dev
```bash ```bash
yarn add cross-env --dev yarn add cross-env --dev
cross-env PORT=3000 umi dev cross-env PORT=3000 fes dev
``` ```
</CodeGroupItem> </CodeGroupItem>
@ -27,7 +27,7 @@ cross-env PORT=3000 umi dev
```bash ```bash
npm i cross-env --save-dev npm i cross-env --save-dev
cross-env PORT=3000 umi dev cross-env PORT=3000 fes dev
``` ```
</CodeGroupItem> </CodeGroupItem>
@ -54,7 +54,7 @@ fes dev
举个 🌰 ： 举个 🌰 ：
```bash ```bash
FES_ENV=sit umi dev FES_ENV=sit fes dev
``` ```
如果存在 `.env.sit` 文件，则会将 `.env.sit` 的配置和 `.env` 做 `merge` 后形成最终配置。 如果存在 `.env.sit` 文件，则会将 `.env.sit` 的配置和 `.env` 做 `merge` 后形成最终配置。

15
docs/zh/guide/runtime-config.md
View File

@ -127,20 +127,7 @@ render(oldRender: Function)
覆写 render。 覆写 render。
比如用于渲染之前做权限校验: 比如用于渲染之前做权限校验。
```js
import { history } from 'umi';
export function render(oldRender) {
fetch('/api/auth').then(auth => {
if (auth.isLogin) { oldRender() }
else {
history.push('/login');
oldRender()
}
});
}
```

4
docs/zh/reference/api/README.md
View File

@ -15,9 +15,9 @@ import { someApi } from "@fesjs/fes"
主要在插件里面使用，项目代码中一般用不到。 主要在插件里面使用，项目代码中一般用不到。
::: :::
运行时插件接口，是 Umi 内置的跑在浏览器里的一套插件体系。 运行时插件接口，是 Fes.js 内置的跑在浏览器里的一套插件体系。
```js ```js
import { plugin, ApplyPluginsType } from 'umi'; import { plugin, ApplyPluginsType } from '@fesjs/fes';
// 注册插件 // 注册插件
plugin.register({ plugin.register({