Skip to content

Commit

Permalink
docs: optimize titles
Browse files Browse the repository at this point in the history
  • Loading branch information
tomgao365 committed Oct 25, 2024
1 parent a65bb3e commit f77be8f
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -224,14 +224,14 @@ const value = await acquireVsCodeApi().getState();
| webview | `boolean` \| `string` \| [WebviewOption](#WebviewOption) | `__getWebviewHtml__` | Inject html code |
| devtools | `boolean` | `true` | Inject script code for [react-devtools](https://github.com/facebook/react/tree/main/packages/react-devtools) or [vue-devtools](https://devtools.vuejs.org/guide/standalone) debugging |

**Notice**
#### Notice

The `recommended` option is used to set the default configuration and behavior, which can be used with almost zero configuration. The default is `true`. If you want to customize the configuration, set it to `false`. The following default prerequisites are to use the recommended [project structure](#directory-structure).

- The output directory is based on the `build.outDir` parameter of `vite`, and outputs `extension` and `src` to `dist/extension` and `dist/webview` respectively.
- Other behaviors to be implemented

**Webview**
#### Webview

Inject [@tomjs/vscode-extension-webview](https://github.com/tomjs/vscode-extension-webview) into vscode extension code and web client code, so that `webview` can support `HMR` during the development stage.

Expand All @@ -241,7 +241,7 @@ Inject [@tomjs/vscode-extension-webview](https://github.com/tomjs/vscode-extensi
- vite build
- extension: Inject `import __getWebviewHtml__ from '@tomjs/vite-plugin-vscode-inject';` above the file that calls the `__getWebviewHtml__` method If is string, will set inject method name. Default is `__getWebviewHtml__`.

**devtools**
#### devtools

During development, support standalone development tool applications for `react` and `vue`, enabled by default.

Expand Down
6 changes: 3 additions & 3 deletions README.zh_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -228,15 +228,15 @@ const value = await acquireVsCodeApi().getState();
| webview | `boolean` \| `string` \| [WebviewOption](#WebviewOption) | `__getWebviewHtml__` | 注入 html 代码 |
| devtools | `boolean` | `true` | 注入 script 代码用于 [react-devtools](https://github.com/facebook/react/tree/main/packages/react-devtools)[vue-devtools](https://devtools.vuejs.org/guide/standalone) 调试 |

**Notice**
#### Notice

`recommended` 选项用于设置默认配置和行为,几乎可以达到零配置使用,默认为 `true` 。如果你要自定义配置,请设置它为`false`。以下默认的前提条件是使用推荐的 [项目结构](#目录结构)

- 输出目录根据 `vite``build.outDir` 参数, 将 `extension``src` 分别输出到 `dist/extension``dist/webview`

- 其他待实现的行为

**Webview**
#### Webview

在 vscode 扩展代码和 web 客户端代码中注入 [@tomjs/vscode-extension-webview](https://github.com/tomjs/vscode-extension-webview),使 `webview` 在开发阶段能够支持 `HMR`

Expand All @@ -246,7 +246,7 @@ const value = await acquireVsCodeApi().getState();
- vite build
- extension: 在调用 `__getWebviewHtml__` 方法的文件上方注入 `import __getWebviewHtml__ from '@tomjs/vite-plugin-vscode-inject';` 如果为字符串,则设置注入方法名,默认为 `__getWebviewHtml__`

**devtools**
#### devtools

开发阶段,支持 `react``vue` 的独立开发工具应用,默认开启。

Expand Down

0 comments on commit f77be8f

Please sign in to comment.