diff --git a/CHANGELOG.md b/CHANGELOG.md index 5f25f52..9d2701c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,15 @@ # Release Notes +## 0.0.13(2024-09-05) + +- feat: Supports theme synchronization between webview and vscode. +- feat: Sensitive information warning Linter. +- feat: Added the ability to obtain SDK installation information. +- feat: Document enhancement - API documentation can be opened through the API in hover code. +- feat: Supports searching and highlighting webview content. +- fix: Optimize document layout. +- fix: Update cloud product categories. + ## 0.0.12(2024-07-05) - Fix Request User-Agent. diff --git a/README.md b/README.md index 8a38712..46c9410 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,13 @@ English | [简体中文](./README.zh_CN.md) - **Code Snippets:** You can use the code snippets to quickly generate the code. -- **Profiles Management :** Manage your Alibaba Cloud profiles. +- **Profiles Management:** Manage your Alibaba Cloud profiles. + +- **Document Enhancement:** Extension provides a document enhancement function, you can write SDK code, through the hover code to see the description of OpenAPI information and more related example links, to get more code example reference, or directly open the document for reference. + +- **Sensitive Information Linter:** Extension provides sensitive information detection, during the code writing process, the extension will automatically detect AK information, and prompt you to use the AK in a more secure way. + +- **Quickly Search the Contents of the Document:** You can quickly search the contents of the document by using `ctrl+f` or `cmd+f`. - More features are under development, please stay tuned. @@ -63,17 +69,27 @@ Or use the keyboard shortcuts `ctrl+cmd+l` to search the API and select Insert s ![code snippets](https://img.alicdn.com/imgextra/i3/O1CN01dmGwmX1ZyVHozyKx4_!!6000000003263-1-tps-842-468.gif) -### Document enhancement +### Profiles Management + +Add and switch your Alibaba Cloud profiles. + +![](https://img.alicdn.com/imgextra/i1/O1CN01NN667S1skk7vLbhr1_!!6000000005805-0-tps-2912-1596.jpg) + +### Document Enhancement When writing SDK code, you can get more code sample references by viewing the OpenAPI description information and additional related sample links through the code documentation. -![Document enhancement](https://img.alicdn.com/imgextra/i4/O1CN01jedn431D1Uk8MEhM3_!!6000000000156-0-tps-2562-654.jpg) +![Document enhancement](https://gw.alicdn.com/imgextra/i2/O1CN01ymjnpo1l2aeq8D3lQ_!!6000000004761-0-tps-1496-646.jpg) -### Profiles Management +## Sensitive Information Warning Linter -Add and switch your Alibaba Cloud profiles. +![](https://gw.alicdn.com/imgextra/i4/O1CN01u787jO241C9LmbQ57_!!6000000007330-0-tps-1970-848.jpg) -![](https://img.alicdn.com/imgextra/i1/O1CN01NN667S1skk7vLbhr1_!!6000000005805-0-tps-2912-1596.jpg) +## Quickly Search the Contents of the Document + +Use `ctrl+f` or `cmd+f` to quickly search for the contents of the document. + +![](https://gw.alicdn.com/imgextra/i2/O1CN01YmSwSz1Rn2VcqQILP_!!6000000002155-0-tps-2514-2098.jpg) ## Feedback diff --git a/README.zh_CN.md b/README.zh_CN.md index 43c7e33..d9168b2 100644 --- a/README.zh_CN.md +++ b/README.zh_CN.md @@ -24,6 +24,12 @@ Alibaba Cloud API Toolkit 是一个轻量化的阿里云 API 工具,支持在 - **profiles 管理:** 管理你的阿里云 profiles。 +- **文档增强:** 插件提供了文档增强功能,你可以在编写 SDK 代码时,通过 hover 代码看到 OpenAPI 的描述信息以及更多相关示例链接,来获得更多代码示例参考, 或直接打开文档进行查阅。 + +- **敏感信息检测:** 插件提供了敏感信息检测功能,在代码编写过程中,插件会自动检测 AK 信息,并提示你用更安全的方式使用 AK。 + +- **快速搜索文档中的内容:** 你可以通过 `ctrl+f`或`cmd+f` 快速搜索文档中的内容。 + - 更多功能正在开发中,敬请期待... ## 插件 UI 导览 @@ -64,17 +70,27 @@ Alibaba Cloud API Toolkit 是一个轻量化的阿里云 API 工具,支持在 ![code snippets](https://img.alicdn.com/imgextra/i3/O1CN01dmGwmX1ZyVHozyKx4_!!6000000003263-1-tps-842-468.gif) +### Profiles 管理 + +新增和切换你的阿里云 profiles。 + +![](https://img.alicdn.com/imgextra/i1/O1CN01NN667S1skk7vLbhr1_!!6000000005805-0-tps-2912-1596.jpg) + ### 文档增强 你能够在编写 SDK 代码时,通过代码文档看到 OpenAPI 的描述信息以及更多相关示例链接,来获得更多代码示例参考。 -![Document enhancement](https://img.alicdn.com/imgextra/i4/O1CN01jedn431D1Uk8MEhM3_!!6000000000156-0-tps-2562-654.jpg) +![Document enhancement](https://gw.alicdn.com/imgextra/i2/O1CN01ymjnpo1l2aeq8D3lQ_!!6000000004761-0-tps-1496-646.jpg) -### Profiles 管理 +## 敏感信息检测 -新增和切换你的阿里云 profiles。 +![](https://gw.alicdn.com/imgextra/i4/O1CN01u787jO241C9LmbQ57_!!6000000007330-0-tps-1970-848.jpg) -![](https://img.alicdn.com/imgextra/i1/O1CN01NN667S1skk7vLbhr1_!!6000000005805-0-tps-2912-1596.jpg) +## 快速搜索文档中的内容 + +你可以通过 `ctrl+f` 或 `cmd+f` 快速搜索文档中的内容。 + +![](https://gw.alicdn.com/imgextra/i2/O1CN01YmSwSz1Rn2VcqQILP_!!6000000002155-0-tps-2514-2098.jpg) ## 反馈 diff --git a/package.json b/package.json index f31dc91..bd10f4d 100644 --- a/package.json +++ b/package.json @@ -3,7 +3,7 @@ "displayName": "Alibaba Cloud API Toolkit", "description": "The Alibaba Cloud API Toolkit for VSCode makes it easier to access Alibaba Cloud services.", "author": "Alibaba Cloud SDK Team", - "version": "0.0.12", + "version": "0.0.13", "private": true, "publisher": "alibabacloud-openapi", "license": "Apache-2.0",