diff --git a/README.md b/README.md index cd91e1a4..87edb039 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,23 @@ [![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-) -VS Code API is a set of JavaScript APIs that you can invoke in your Visual Studio Code extension. This site lists all VS Code APIs available to extension authors. +VS Code API 是一系列你可以在 Visual Studio Code 扩展中调用的 JavaScript API。这个站点列出了扩展开发者可以使用的所有 VS Code API。原网站没有中文翻译且不方便阅读,所有有了该网站。 -This listing is compiled from the [vscode.d.ts](https://github.com/youngjuning/vscode-api/blob/main/vscode.d.ts) file from the VS Code repository. +API 列表使用 Typedoc 从 [vscode.d.ts](https://github.com/youngjuning/vscode-api/blob/main/vscode.d.ts) 文件编译而来,如果 [vscode.d.ts 源文件](https://github.com/microsoft/vscode/blob/main/src/vs/vscode.d.ts) 有更新,我们会及时同步,当前对应 commit 为 [2974a01](https://github.com/microsoft/vscode/commit/2974a014fd33f4a109aad6ed0f3e46fe93bfc794#diff-f127724f8c5dbf0c8371ad0a100f8a9bc0a398b6b8ec29aa6cd7f265bd01a096)。 + +## 开发 + +### 安装依赖 + +```sh +$ yarn install +``` + +### 调试 + +```sh +$ yarn dev +``` ## Contributors ✨