Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: optimize docs #1337

Merged
merged 2 commits into from
Jun 29, 2024
Merged

feat: optimize docs #1337

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bd30733
feat: optimize docs
kiner-tang Jun 29, 2024
56e6ee1
Merge branch 'master' into docs-opt
kiner-tang Jun 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Mako 目前通过 @umijs/mako 暴露 API 供 node 工具使用，以下为 @umij

## Usage

比如。
比如：

```ts
const { build } = require('@umijs/mako');
Expand All @@ -19,21 +19,21 @@ await build({

### root

- 类型：`String`
- 类型：`string`
- 默认值：`process.cwd()`

项目根目录。

### config

- 类型：`Object`
- 类型：`object`
- 默认值：`{}`

详见[配置](./config.md)。

### watch

- 类型：`Boolean`
- 类型：`string`
- 默认值：`false`

是否监听文件变化，开启后会启动文件监听服务，当文件变化时会自动重新编译。
4 changes: 2 additions & 2 deletions docs/config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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.

Expand Down