diff --git a/docs/api.md b/docs/api.md index 106f85337..266f7647c 100644 --- a/docs/api.md +++ b/docs/api.md @@ -4,7 +4,7 @@ Mako 目前通过 @umijs/mako 暴露 API 供 node 工具使用,以下为 @umij ## Usage -比如。 +比如: ```ts const { build } = require('@umijs/mako'); @@ -19,21 +19,21 @@ await build({ ### root -- 类型:`String` +- 类型:`string` - 默认值:`process.cwd()` 项目根目录。 ### config -- 类型:`Object` +- 类型:`object` - 默认值:`{}` 详见[配置](./config.md)。 ### watch -- 类型:`Boolean` +- 类型:`string` - 默认值:`false` 是否监听文件变化,开启后会启动文件监听服务,当文件变化时会自动重新编译。 diff --git a/docs/config.md b/docs/config.md index 3daedf544..2707b4850 100644 --- a/docs/config.md +++ b/docs/config.md @@ -261,7 +261,7 @@ Then, when the code encounters `import foo from "foo"`, it will be replaced with - Type: `boolean` - Default: `false` -Whether to fix flexbugs. +Whether to fix flexBugs. ### forkTsChecker @@ -369,7 +369,7 @@ Whether to enable `mdx` support. ### minify - Type: `boolean` -- Default: mode 为 development 时为 `false`,production 时为 `true` +- Default: mode will be `false` when mode is development, and `true` when mode is production Whether to minify the code.