Jelajahi Sumber

Update documents

dufu1991 3 tahun lalu
induk
melakukan
50e95af8ca

+ 1 - 1
doc/guide/future.md

@@ -1,7 +1,7 @@
 ## 新增 💪
 
 - [x] 开发一款 Vite/Rollup 插件,支持将指定目录下的所有 svg 合并为 SVG symbol。
-- [ ] 开发一款 VS Code 插件,支持光标悬浮显示 STDF 组件 API 等功能。
+- [x] 开发一款 VS Code 插件,支持光标悬浮显示 STDF 组件 API 等功能。
 - [x] 开发一款模板脚手架,支持按照配置初始使用 STDF 的工程,初步考虑支持 Vite、SvelteKit。
 - [ ] 按照 Tailwind CSS 变量规则,实现自定义主题色。
 - [ ] 新增 NumKeyboard-数字键盘组件,一般用于输入数字。

+ 1 - 1
doc/guide/future_en.md

@@ -1,7 +1,7 @@
 ## New Features 💪
 
 - [x] Develop a Vite/Rollup plugin that supports merging all SVGs in a specified directory into an SVG symbol.
-- [ ] Develop a VS Code plugin that supports displaying STDF component API and other functions when hovering over the cursor.
+- [x] Develop a VS Code plugin that supports displaying STDF component API and other functions when hovering over the cursor.
 - [x] Develop a template scaffold that supports initializing STDF projects according to configuration. Initial support for Vite and SvelteKit.
 - [ ] Implement custom theme colors according to Tailwind CSS variable rules.
 - [ ] Add NumKeyboard component, which is generally used for entering numbers.

+ 5 - 0
doc/guide/milestone.md

@@ -1,3 +1,8 @@
+## 2023-08-24
+
+完成 STDF 配套的模板脚手架 [create-stdf](https://www.npmjs.com/package/create-stdf),Vite/Rollup 插件 [rollup-plugin-stdf-icon
+](https://www.npmjs.com/package/rollup-plugin-stdf-icon),VS Code 插件 [stdf-vscode-extension](https://marketplace.visualstudio.com/items?itemName=STDF.stdf-vscode-extension)。
+
 ## 2023-07-23
 
 适配 Svelte 4 也兼容 Svelte 3(v0.2.0)。

+ 4 - 0
doc/guide/milestone_en.md

@@ -1,3 +1,7 @@
+## 2023-08-24
+
+Completed the template scaffolding tool [create-stdf](https://www.npmjs.com/package/create-stdf), Vite/Rollup plugin [rollup-plugin-stdf-icon](https://www.npmjs.com/package/rollup-plugin-stdf-icon), and VS Code plugin [stdf-vscode-extension](https://marketplace.visualstudio.com/items?itemName=STDF.stdf-vscode-extension) for STDF.
+
 ## 2023-07-23
 
 Adapted for Svelte 4 while remaining compatible with Svelte 3 (v0.2.0).

+ 21 - 0
doc/guide/vscode.md

@@ -0,0 +1,21 @@
+## VS Code 插件
+
+### 介绍
+
+STDF 提供了一个 VS Code 插件 [stdf-vscode-extension](https://marketplace.visualstudio.com/items?itemName=STDF.stdf-vscode-extension),用于在使用 [STDF](https://stdf.design) 开发时提供一些便利。
+
+### 安装
+
+在 VS Code 插件中搜索 `stdf-vscode-extension` 点击安装,或到 VS Code 插件市场安装 [stdf-vscode-extension](https://marketplace.visualstudio.com/items?itemName=STDF.stdf-vscode-extension)。
+
+### 功能
+
+#### 光标悬浮于 STDF 组件名称上时,显示该组件的API。
+
+![TIP](https://stdf.design/assets/vscode/tip.png)
+
+### 配置
+
+默认显示的 API 为简体中文,可到 VS Code 的设置页开启英文 API。
+
+![SETTING](https://stdf.design/assets/vscode/setting.png)

+ 21 - 0
doc/guide/vscode_en.md

@@ -0,0 +1,21 @@
+## VS Code Plugin
+
+### Introduction
+
+STDF provides a VS Code plugin called [stdf-vscode-extension](https://marketplace.visualstudio.com/items?itemName=STDF.stdf-vscode-extension), which provides convenience when developing with [STDF](https://stdf.design).
+
+### Installation
+
+Search for `stdf-vscode-extension` in the VS Code plugin marketplace and click install, or install [stdf-vscode-extension](https://marketplace.visualstudio.com/items?itemName=STDF.stdf-vscode-extension) from the VS Code plugin marketplace.
+
+### Features
+
+#### When hovering over the name of an STDF component, the API of that component is displayed.
+
+![TIP](https://stdf.design/assets/vscode/tip.png)
+
+### Configuration
+
+By default, the API is displayed in Simplified Chinese. You can switch to English API by going to the settings page in VS Code.
+
+![SETTING](https://stdf.design/assets/vscode/setting.png)

+ 1 - 1
packages/vscode-extension/README.md

@@ -6,7 +6,7 @@ A VS Code extension that provides convenience when developing with [STDF](https:
 
 # Installation
 
-Search for `stdf-vscode-extension` in the VS Code extensions marketplace and click install, or install [stdf-vscode-extension](https://marketplace.visualstudio.com/items?itemName=STDF.stdf-vscode-extension&ssr=false#overview) from the marketplace.
+Search for `stdf-vscode-extension` in the VS Code extensions marketplace and click install, or install [stdf-vscode-extension](https://marketplace.visualstudio.com/items?itemName=STDF.stdf-vscode-extension) from the marketplace.
 
 # Features
 

+ 1 - 1
packages/vscode-extension/README_CN.md

@@ -6,7 +6,7 @@
 
 # 安装
 
-在 VS Code 插件中搜索 `stdf-vscode-extension` 点击安装,或到 VS Code 插件市场安装 [stdf-vscode-extension](https://marketplace.visualstudio.com/items?itemName=STDF.stdf-vscode-extension&ssr=false#overview)。
+在 VS Code 插件中搜索 `stdf-vscode-extension` 点击安装,或到 VS Code 插件市场安装 [stdf-vscode-extension](https://marketplace.visualstudio.com/items?itemName=STDF.stdf-vscode-extension)。
 
 # 功能