Skip to content

Commit

Permalink
docs: add dev.cliShortcuts configuration (#3660)
Browse files Browse the repository at this point in the history
  • Loading branch information
chenjiahan authored Oct 8, 2024
1 parent fe6b87f commit 0a1e8df
Show file tree
Hide file tree
Showing 2 changed files with 84 additions and 0 deletions.
42 changes: 42 additions & 0 deletions website/docs/en/config/dev/cli-shortcuts.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# dev.cliShortcuts

- **Type:** `boolean`
- **Default:** `true` when using Rsbuild CLI, `false` otherwise.
- **Version:** `>= 1.0.11`

Whether to enable CLI shortcuts.

## Example

- Enable:

```js
export default {
dev: {
cliShortcuts: true,
},
};
```

- Disable:

```js
export default {
dev: {
cliShortcuts: false,
},
};
```

## All Shortcuts

Press `h + Enter` to show all shortcuts:

```
Shortcuts:
c + enter clear console
o + enter open in browser
q + enter quit process
r + enter restart server
u + enter show urls
```
42 changes: 42 additions & 0 deletions website/docs/zh/config/dev/cli-shortcuts.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# dev.cliShortcuts

- **类型:** `boolean`
- **默认值:** 当使用 Rsbuild CLI 时默认为 `true`,否则为 `false`
- **版本:** `>= 1.0.11`

是否启用 CLI 快捷键。

## 示例

- 启用:

```js
export default {
dev: {
cliShortcuts: true,
},
};
```

- 禁用:

```js
export default {
dev: {
cliShortcuts: false,
},
};
```

## 所有快捷键

`h + Enter` 以显示所有快捷键:

```
Shortcuts:
c + enter clear console
o + enter open in browser
q + enter quit process
r + enter restart server
u + enter show urls
```

0 comments on commit 0a1e8df

Please sign in to comment.