chore: change api document

tomjs · Jul 1, 2024 · fa0a47c · fa0a47c
1 parent 230213b
commit fa0a47c
Show file tree

Hide file tree

Showing 7 changed files with 15 additions and 7 deletions.
diff --git a/README.zh_CN.md b/README.zh_CN.md
@@ -8,7 +8,7 @@
 
 | 包名 | 版本 | node |
 | --- | --- | --- |
-| [@tomjs/vscode-dev](./packages/vscode-dev/README.md) | [![npm](https://img.shields.io/npm/v/@tomjs/vscode-dev)](https://www.npmjs.com/package/@tomjs/vscode-dev) | ![node-current (scoped)](https://img.shields.io/node/v/@tomjs/vscode-dev) |
 | [@tomjs/vscode](./packages/vscode/README.md) | [![npm](https://img.shields.io/npm/v/@tomjs/vscode)](https://www.npmjs.com/package/@tomjs/vscode) | ![node-current (scoped)](https://img.shields.io/node/v/@tomjs/vscode) |
+| [@tomjs/vscode-dev](./packages/vscode-dev/README.md) | [![npm](https://img.shields.io/npm/v/@tomjs/vscode-dev)](https://www.npmjs.com/package/@tomjs/vscode-dev) | ![node-current (scoped)](https://img.shields.io/node/v/@tomjs/vscode-dev) |
 | [@tomjs/vscode-types](./packages/vscode-dev/README.md) | [![npm](https://img.shields.io/npm/v/@tomjs/vscode-types)](https://www.npmjs.com/package/@tomjs/vscode-types) | ![node-current (scoped)](https://img.shields.io/node/v/@tomjs/vscode-types) |
 | [@tomjs/vscode-webview](./packages/vscode-dev/README.md) | [![npm](https://img.shields.io/npm/v/@tomjs/vscode-webview)](https://www.npmjs.com/package/@tomjs/vscode-webview) | ![node-current (scoped)](https://img.shields.io/node/v/@tomjs/vscode-webview) |
diff --git a/packages/vscode-types/README.md b/packages/vscode-types/README.md
@@ -1,6 +1,6 @@
 # @tomjs/vscode-types
 
-[![npm](https://img.shields.io/npm/v/@tomjs/vscode-types)](https://www.npmjs.com/package/@tomjs/vscode-types) ![node-current (scoped)](https://img.shields.io/node/v/@tomjs/vscode-types) ![NPM](https://img.shields.io/npm/l/@tomjs/vscode-types)
+[![npm](https://img.shields.io/npm/v/@tomjs/vscode-types)](https://www.npmjs.com/package/@tomjs/vscode-types) ![node-current (scoped)](https://img.shields.io/node/v/@tomjs/vscode-types) ![NPM](https://img.shields.io/npm/l/@tomjs/vscode-types) [![Docs](https://raw.githubusercontent.com/tomjs/assets/main/npm/api.svg)](https://www.unpkg.com/browse/@tomjs/vscode-types/dist/index.d.ts)
 
 **English** | [中文](./README.zh_CN.md)
 
@@ -18,3 +18,7 @@ yarn add @tomjs/vscode-types -D
 # npm
 npm add @tomjs/vscode-types -D
 ```
+
+## Documentation
+
+- [index.d.ts](https://www.unpkg.com/browse/@tomjs/vscode-types/dist/index.d.ts) provided by [unpkg.com](https://www.unpkg.com).
diff --git a/packages/vscode-types/README.zh_CN.md b/packages/vscode-types/README.zh_CN.md
@@ -1,6 +1,6 @@
 # @tomjs/vscode-types
 
-[![npm](https://img.shields.io/npm/v/@tomjs/vscode-types)](https://www.npmjs.com/package/@tomjs/vscode-types) ![node-current (scoped)](https://img.shields.io/node/v/@tomjs/vscode-types) ![NPM](https://img.shields.io/npm/l/@tomjs/vscode-types)
+[![npm](https://img.shields.io/npm/v/@tomjs/vscode-types)](https://www.npmjs.com/package/@tomjs/vscode-types) ![node-current (scoped)](https://img.shields.io/node/v/@tomjs/vscode-types) ![NPM](https://img.shields.io/npm/l/@tomjs/vscode-types) [![Docs](https://raw.githubusercontent.com/tomjs/assets/main/npm/api.svg)](https://www.unpkg.com/browse/@tomjs/vscode-types/dist/index.d.ts)
 
 [English](./README.md) | **中文**
 
@@ -18,3 +18,7 @@ yarn add @tomjs/vscode-types -D
 # npm
 npm add @tomjs/vscode-types -D
 ```
+
+## 文档
+
+- [unpkg.com](https://www.unpkg.com/) 提供的 [index.d.ts](https://www.unpkg.com/browse/@tomjs/vscode-types/dist/index.d.ts).
diff --git a/packages/vscode-webview/README.md b/packages/vscode-webview/README.md
@@ -1,6 +1,6 @@
 # @tomjs/vscode-webview
 
-[![npm](https://img.shields.io/npm/v/@tomjs/vscode-webview)](https://www.npmjs.com/package/@tomjs/vscode-webview) ![node-current (scoped)](https://img.shields.io/node/v/@tomjs/vscode-webview) ![NPM](https://img.shields.io/npm/l/@tomjs/vscode-webview)
+[![npm](https://img.shields.io/npm/v/@tomjs/vscode-webview)](https://www.npmjs.com/package/@tomjs/vscode-webview) ![node-current (scoped)](https://img.shields.io/node/v/@tomjs/vscode-webview) ![NPM](https://img.shields.io/npm/l/@tomjs/vscode-webview) [![Docs](https://raw.githubusercontent.com/tomjs/assets/main/npm/api.svg)](https://www.unpkg.com/browse/@tomjs/vscode-webview/dist/index.d.ts)
 
 **English** | [中文](./README.zh_CN.md)
 

diff --git a/packages/vscode-webview/README.zh_CN.md b/packages/vscode-webview/README.zh_CN.md
@@ -1,6 +1,6 @@
 # @tomjs/vscode-webview
 
-[![npm](https://img.shields.io/npm/v/@tomjs/vscode-webview)](https://www.npmjs.com/package/@tomjs/vscode-webview) ![node-current (scoped)](https://img.shields.io/node/v/@tomjs/vscode-webview) ![NPM](https://img.shields.io/npm/l/@tomjs/vscode-webview)
+[![npm](https://img.shields.io/npm/v/@tomjs/vscode-webview)](https://www.npmjs.com/package/@tomjs/vscode-webview) ![node-current (scoped)](https://img.shields.io/node/v/@tomjs/vscode-webview) ![NPM](https://img.shields.io/npm/l/@tomjs/vscode-webview) [![Docs](https://raw.githubusercontent.com/tomjs/assets/main/npm/api.svg)](https://www.unpkg.com/browse/@tomjs/vscode-webview/dist/index.d.ts)
 
 [English](./README.md) | **中文**
 

diff --git a/packages/vscode/README.md b/packages/vscode/README.md
@@ -1,6 +1,6 @@
 # @tomjs/vscode
 
-[![npm](https://img.shields.io/npm/v/@tomjs/vscode)](https://www.npmjs.com/package/@tomjs/vscode) ![node-current (scoped)](https://img.shields.io/node/v/@tomjs/vscode) ![NPM](https://img.shields.io/npm/l/@tomjs/vscode)
+[![npm](https://img.shields.io/npm/v/@tomjs/vscode)](https://www.npmjs.com/package/@tomjs/vscode) ![node-current (scoped)](https://img.shields.io/node/v/@tomjs/vscode) ![NPM](https://img.shields.io/npm/l/@tomjs/vscode) [![Docs](https://raw.githubusercontent.com/tomjs/assets/main/npm/api.svg)](https://www.unpkg.com/browse/@tomjs/vscode/dist/index.d.ts)
 
 **English** | [中文](./README.zh_CN.md)
 

diff --git a/packages/vscode/README.zh_CN.md b/packages/vscode/README.zh_CN.md
@@ -1,6 +1,6 @@
 # @tomjs/vscode
 
-[![npm](https://img.shields.io/npm/v/@tomjs/vscode)](https://www.npmjs.com/package/@tomjs/vscode) ![node-current (scoped)](https://img.shields.io/node/v/@tomjs/vscode) ![NPM](https://img.shields.io/npm/l/@tomjs/vscode) [![Docs](https://www.paka.dev/badges/v0/cute.svg)](https://www.paka.dev/npm/@tomjs/vscode)
+[![npm](https://img.shields.io/npm/v/@tomjs/vscode)](https://www.npmjs.com/package/@tomjs/vscode) ![node-current (scoped)](https://img.shields.io/node/v/@tomjs/vscode) ![NPM](https://img.shields.io/npm/l/@tomjs/vscode) [![Docs](https://raw.githubusercontent.com/tomjs/assets/main/npm/api.svg)](https://www.unpkg.com/browse/@tomjs/vscode/dist/index.d.ts)
 
 [English](./README.md) | **中文**