docs: update getting-started (#1686)

Tencent · Dec 19, 2024 · f15425b · f15425b
1 parent b9c1d9d
commit f15425b
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/site/docs/getting-started.en-US.md b/site/docs/getting-started.en-US.md
@@ -139,6 +139,11 @@ module.exports = {
 > You can click on this [link](https://github.com/antfu/unplugin-vue-components/blob/main/src/core/resolvers/tdesign.ts#L4) for the configuration supported by `TDesignResolver`.
 
 
+## Editor Prompts
+
+After installing and registering TDesign, it can be used with plugins in editors such as VSCode to achieve the effect of prompting component names and APIs during development.
+
+Plugin `Volar` is recommended, after installing `Volar`, please add `node_modules/tdesign-mobile-vue/global.d.ts` to the `includes` property in the project's `tsconfig.json file`.
 
 ## Browser Support
 

diff --git a/site/docs/getting-started.md b/site/docs/getting-started.md
@@ -140,6 +140,11 @@ module.exports = {
 
 > `TDesignResolver` 支持的配置，可以点击此[链接](https://github.com/antfu/unplugin-vue-components/blob/main/src/core/resolvers/tdesign.ts#L4)。
 
+## 编辑器提示
+
+安装注册 TDesign 之后，在开发项目时，可以配合插件在VSCode等主流编辑器中达到提示组件名及API的效果。
+
+推荐安装 `Volar`，并在项目的 tsconfig.json 的 `includes` 属性中增加`node_modules/tdesign-mobile-vue/global.d.ts`，即可实现该效果。
 
 ## 浏览器兼容性