Răsfoiți Sursa

[doc]更新文档,移除克隆STDF仓库时切换到next分支的步骤,并修正相关链接至主分支。同时,简化了调试和构建的说明,确保文档内容准确且易于理解。

dufu1991 1 an în urmă
părinte
comite
9a6553e09d

+ 8 - 12
docs/mds/guide/contribution.md

@@ -26,16 +26,15 @@
 - [Prettier - Code formatter](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) 或者 [WebStorm 集成](https://www.jetbrains.com/help/webstorm/prettier.html):代码格式化插件。
 - [Prettier - Code formatter](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) 或者 [WebStorm 集成](https://www.jetbrains.com/help/webstorm/prettier.html):代码格式化插件。
 
 
 按照下面的步骤操作,即可在本地快速启动 STDF Demo。
 按照下面的步骤操作,即可在本地快速启动 STDF Demo。
-<!-- main -> next -->
+
 > 由于 Demo 依赖的 rollup-plugin-stdf-icon 包是本地构建的,所以请先构建一下这个包。
 > 由于 Demo 依赖的 rollup-plugin-stdf-icon 包是本地构建的,所以请先构建一下这个包。
 
 
 <!-- :::code-groups -->
 <!-- :::code-groups -->
 <!-- pnpm -->
 <!-- pnpm -->
 ```sh
 ```sh
-## 1. 克隆 STDF 仓库并进入,切换到 next 分支
+## 1. 克隆 STDF 仓库并进入
 git clone git@github.com:any-tdf/stdf.git
 git clone git@github.com:any-tdf/stdf.git
 cd stdf
 cd stdf
-git checkout next
 
 
 ## 2. 构建 rollup-plugin-stdf-icon 包
 ## 2. 构建 rollup-plugin-stdf-icon 包
 cd packages/rollup-plugin-stdf-icon
 cd packages/rollup-plugin-stdf-icon
@@ -54,10 +53,9 @@ pnpm dev
 <!-- :: -->
 <!-- :: -->
 <!-- npm -->
 <!-- npm -->
 ```sh
 ```sh
-## 1. 克隆 STDF 仓库并进入,切换到 next 分支
+## 1. 克隆 STDF 仓库并进入
 git clone git@github.com:any-tdf/stdf.git
 git clone git@github.com:any-tdf/stdf.git
 cd stdf
 cd stdf
-git checkout next
 
 
 ## 2. 构建 rollup-plugin-stdf-icon 包
 ## 2. 构建 rollup-plugin-stdf-icon 包
 cd packages/rollup-plugin-stdf-icon
 cd packages/rollup-plugin-stdf-icon
@@ -76,17 +74,16 @@ npm run dev
 <!-- :: -->
 <!-- :: -->
 <!-- bun -->
 <!-- bun -->
 ```sh
 ```sh
-## 1. 克隆 STDF 仓库并进入,切换到 next 分支
+## 1. 克隆 STDF 仓库并进入
 git clone git@github.com:any-tdf/stdf.git
 git clone git@github.com:any-tdf/stdf.git
 cd stdf
 cd stdf
-git checkout next
 
 
 ## 2. 构建 rollup-plugin-stdf-icon 包
 ## 2. 构建 rollup-plugin-stdf-icon 包
 cd packages/rollup-plugin-stdf-icon
 cd packages/rollup-plugin-stdf-icon
 ## 安装依赖
 ## 安装依赖
 bun i
 bun i
 ## 构建包
 ## 构建包
-bun build
+bun run build
 
 
 ## 3. 调试 STDF
 ## 3. 调试 STDF
 cd packages/stdf
 cd packages/stdf
@@ -98,10 +95,9 @@ bun dev
 <!-- :: -->
 <!-- :: -->
 <!-- yarn -->
 <!-- yarn -->
 ```sh
 ```sh
-## 1. 克隆 STDF 仓库并进入,切换到 next 分支
+## 1. 克隆 STDF 仓库并进入
 git clone git@github.com:any-tdf/stdf.git
 git clone git@github.com:any-tdf/stdf.git
 cd stdf
 cd stdf
-git checkout next
 
 
 ## 2. 构建 rollup-plugin-stdf-icon 包
 ## 2. 构建 rollup-plugin-stdf-icon 包
 cd packages/rollup-plugin-stdf-icon
 cd packages/rollup-plugin-stdf-icon
@@ -123,7 +119,7 @@ yarn dev
 
 
 可对 `packages/stdf/src/lib/components` 目录下组件源码进行修改并实时查看修改效果。注意,VS Code 与 WebStorm 都支持在调用组件时直接跳转到组件源码。
 可对 `packages/stdf/src/lib/components` 目录下组件源码进行修改并实时查看修改效果。注意,VS Code 与 WebStorm 都支持在调用组件时直接跳转到组件源码。
 
 
-如果不想本地开发,可以选择使用 StackBlitz 在线简单调试。直接打开 [NextSTDF Demo](https://stackblitz.com/github/any-tdf/next-demo-stdf) 即可开始在线调试。
+如果不想本地开发,可以选择使用 StackBlitz 在线简单调试。直接打开 [STDF Demo](https://stackblitz.com/github/any-tdf/demo-stdf) 即可开始在线调试。
 
 
 ## 提交 PR
 ## 提交 PR
 
 
@@ -137,7 +133,7 @@ yarn dev
 - 请先 fork 一份 [STDF](https://github.com/any-tdf/stdf) 代码到自己的仓库,如果已经 fork 过,请同步主仓库的最新代码。
 - 请先 fork 一份 [STDF](https://github.com/any-tdf/stdf) 代码到自己的仓库,如果已经 fork 过,请同步主仓库的最新代码。
 - 克隆你的仓库至本地。
 - 克隆你的仓库至本地。
 - 修改组件源码并验证通过。
 - 修改组件源码并验证通过。
-- 「可选」补充此次修改的中英文档中,文档位于 `docs/mds/components` 目录下。根据具体修改内容可能需要修改 api、FAQ、guide、version 等文档。对 version 的修改请增加 tag,具体参考 [STDF Version tag](https://github.com/any-tdf/stdf/blob/next/docs/mds/components/button/version.md?plain=1)。
+- 「可选」补充此次修改的中英文档中,文档位于 `docs/mds/components` 目录下。根据具体修改内容可能需要修改 api、FAQ、guide、version 等文档。对 version 的修改请增加 tag,具体参考 [STDF Version tag](https://github.com/any-tdf/stdf/blob/main/docs/mds/components/button/version.md?plain=1)。
 - 到仓库 `packages/stdf` 目录,执行 `pnpm i` 或 `npm i` 或 `bun i` 安装依赖。
 - 到仓库 `packages/stdf` 目录,执行 `pnpm i` 或 `npm i` 或 `bun i` 安装依赖。
 - 提交修改内容至你的仓库,然后提 Pull Request 到主仓库。
 - 提交修改内容至你的仓库,然后提 Pull Request 到主仓库。
 - Pull Request 会在 Review 通过后被合并到主仓库,后续发布新版。
 - Pull Request 会在 Review 通过后被合并到主仓库,后续发布新版。

+ 9 - 13
docs/mds/guide/contribution_en.md

@@ -26,16 +26,15 @@ Recommended installations:
 - [Prettier - Code formatter](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) or [WebStorm Integration](https://www.jetbrains.com/help/webstorm/prettier.html): Code formatting plugin.
 - [Prettier - Code formatter](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) or [WebStorm Integration](https://www.jetbrains.com/help/webstorm/prettier.html): Code formatting plugin.
 
 
 Follow the steps below to quickly start STDF Demo locally.
 Follow the steps below to quickly start STDF Demo locally.
-<!-- main -> next -->
+
 > Because the rollup-plugin-stdf-icon package that the Demo depends on is built locally, please build this package first.
 > Because the rollup-plugin-stdf-icon package that the Demo depends on is built locally, please build this package first.
 
 
 <!-- :::code-groups -->
 <!-- :::code-groups -->
 <!-- pnpm -->
 <!-- pnpm -->
 ```sh
 ```sh
-## 1. Clone the STDF repository and switch to the next branch
+## 1. Clone the STDF repository
 git clone git@github.com:any-tdf/stdf.git
 git clone git@github.com:any-tdf/stdf.git
 cd stdf
 cd stdf
-git checkout next
 
 
 ## 2. Build the rollup-plugin-stdf-icon package
 ## 2. Build the rollup-plugin-stdf-icon package
 cd packages/rollup-plugin-stdf-icon
 cd packages/rollup-plugin-stdf-icon
@@ -54,10 +53,9 @@ pnpm dev
 <!-- :: -->
 <!-- :: -->
 <!-- npm -->
 <!-- npm -->
 ```sh
 ```sh
-## 1. Clone the STDF repository and switch to the next branch
+## 1. Clone the STDF repository
 git clone git@github.com:any-tdf/stdf.git
 git clone git@github.com:any-tdf/stdf.git
 cd stdf
 cd stdf
-git checkout next
 
 
 ## 2. Build the rollup-plugin-stdf-icon package
 ## 2. Build the rollup-plugin-stdf-icon package
 cd packages/rollup-plugin-stdf-icon
 cd packages/rollup-plugin-stdf-icon
@@ -66,7 +64,7 @@ npm i
 ## Build package
 ## Build package
 npm run build
 npm run build
 
 
-## 3. 调试 STDF
+## 3. Debug STDF
 cd packages/stdf
 cd packages/stdf
 ## Install dependencies
 ## Install dependencies
 npm i
 npm i
@@ -76,17 +74,16 @@ npm run dev
 <!-- :: -->
 <!-- :: -->
 <!-- bun -->
 <!-- bun -->
 ```sh
 ```sh
-## 1. Clone the STDF repository and switch to the next branch
+## 1. Clone the STDF repository
 git clone git@github.com:any-tdf/stdf.git
 git clone git@github.com:any-tdf/stdf.git
 cd stdf
 cd stdf
-git checkout next
 
 
 ## 2. Build the rollup-plugin-stdf-icon package
 ## 2. Build the rollup-plugin-stdf-icon package
 cd packages/rollup-plugin-stdf-icon
 cd packages/rollup-plugin-stdf-icon
 ## Install dependencies
 ## Install dependencies
 bun i
 bun i
 ## Build package
 ## Build package
-bun build
+bun run build
 
 
 ## 3. Debug STDF
 ## 3. Debug STDF
 cd packages/stdf
 cd packages/stdf
@@ -98,10 +95,9 @@ bun dev
 <!-- :: -->
 <!-- :: -->
 <!-- yarn -->
 <!-- yarn -->
 ```sh
 ```sh
-## 1. Clone the STDF repository and switch to the next branch
+## 1. Clone the STDF repository
 git clone git@github.com:any-tdf/stdf.git
 git clone git@github.com:any-tdf/stdf.git
 cd stdf
 cd stdf
-git checkout next
 
 
 ## 2. Build the rollup-plugin-stdf-icon package
 ## 2. Build the rollup-plugin-stdf-icon package
 cd packages/rollup-plugin-stdf-icon
 cd packages/rollup-plugin-stdf-icon
@@ -123,7 +119,7 @@ After starting successfully, you can view the effect in the browser by opening `
 
 
 You can modify the component source code in the `packages/stdf/src/lib/components` directory and view the modification effect in real time. Note that VS Code and WebStorm both support jumping to the component source code when calling the component.
 You can modify the component source code in the `packages/stdf/src/lib/components` directory and view the modification effect in real time. Note that VS Code and WebStorm both support jumping to the component source code when calling the component.
 
 
-If you don't want to develop locally, you can choose to use StackBlitz for online simple debugging. Simply open [NextSTDF Demo](https://stackblitz.com/github/any-tdf/next-demo-stdf) to start online debugging.
+If you don't want to develop locally, you can choose to use StackBlitz for online simple debugging. Simply open [STDF Demo](https://stackblitz.com/github/any-tdf/demo-stdf) to start online debugging.
 
 
 ## Submit PR
 ## Submit PR
 
 
@@ -137,7 +133,7 @@ If you are submitting your first Pull Request on GitHub, you can read the follow
 - Please first fork a [STDF](https://github.com/any-tdf/stdf) repository to your own repository, if you have already forked it, please sync the latest code from the main repository.
 - Please first fork a [STDF](https://github.com/any-tdf/stdf) repository to your own repository, if you have already forked it, please sync the latest code from the main repository.
 - Clone your repository to your local machine.
 - Clone your repository to your local machine.
 - Modify the component source code and verify it.
 - Modify the component source code and verify it.
-- (Optional) Supplement the Chinese and English documentation of this modification, the documentation is located in the `docs/mds/components` directory. Depending on the specific modification content, you may need to modify the api, FAQ, guide, version, etc. documents. For the modification of the version, please add the tag, refer to [STDF Version tag](https://github.com/any-tdf/stdf/blob/next/docs/mds/components/button/version.md?plain=1).
+- (Optional) Supplement the Chinese and English documentation of this modification, the documentation is located in the `docs/mds/components` directory. Depending on the specific modification content, you may need to modify the api, FAQ, guide, version, etc. documents. For the modification of the version, please add the tag, refer to [STDF Version tag](https://github.com/any-tdf/stdf/blob/main/docs/mds/components/button/version.md?plain=1).
 - Go to the `packages/stdf` directory, execute `pnpm i` or `npm i` or `bun i` to install dependencies.
 - Go to the `packages/stdf` directory, execute `pnpm i` or `npm i` or `bun i` to install dependencies.
 - Submit the modified content to your repository, then submit a Pull Request to the main repository.
 - Submit the modified content to your repository, then submit a Pull Request to the main repository.
 - Pull Request will be merged into the main repository after being reviewed, and a new version will be released.
 - Pull Request will be merged into the main repository after being reviewed, and a new version will be released.

+ 3 - 3
docs/mds/guide/internation.md

@@ -90,14 +90,14 @@ STDF 组件使用 Svelte 的 [Context](https://svelte.dev/docs/svelte/context) 
 > 多语言文件由机器翻译,如果有不准确的地方,请提交 PR 进行修正。
 > 多语言文件由机器翻译,如果有不准确的地方,请提交 PR 进行修正。
 
 
 ## 增加语言包
 ## 增加语言包
-<!-- main -> next -->
-如果找不到你需要的语言包,欢迎你在 [中文语言包](https://github.com/any-tdf/stdf/blob/next/packages/stdf/src/lib/lang/zh_CN.ts) 或 [英文语言包](https://github.com/any-tdf/stdf/blob/next/packages/stdf/src/lib/lang/en_US.ts) 的基础上创建一个新的语言包,并发一个 Pull Request。[语言对照表](http://www.lingoes.net/en/translator/langcode.htm)
+
+如果找不到你需要的语言包,欢迎你在 [中文语言包](https://github.com/any-tdf/stdf/blob/main/packages/stdf/src/lib/lang/zh_CN.ts) 或 [英文语言包](https://github.com/any-tdf/stdf/blob/main/packages/stdf/src/lib/lang/en_US.ts) 的基础上创建一个新的语言包,并发一个 Pull Request。[语言对照表](http://www.lingoes.net/en/translator/langcode.htm)
 
 
 基本步骤如下:
 基本步骤如下:
 
 
 - 请先 fork 一份 [STDF](https://github.com/any-tdf/stdf) 代码到自己的仓库,如果已经 fork 过,请同步主仓库的最新代码。
 - 请先 fork 一份 [STDF](https://github.com/any-tdf/stdf) 代码到自己的仓库,如果已经 fork 过,请同步主仓库的最新代码。
 - 克隆你的仓库至本地。
 - 克隆你的仓库至本地。
 - 在 `packages/stdf/src/lib/lang` 文件夹中增加语言包。
 - 在 `packages/stdf/src/lib/lang` 文件夹中增加语言包。
-- (可选)更新文档,在 docs/mds/guide 文件夹更新 [internation.md](https://github.com/any-tdf/stdf/edit/next/docs/mds/guide/internation.md) 和 [internation_en.md](https://github.com/any-tdf/stdf/edit/next/docs/mds/guide/internation_en.md) 文件,请在语言列表中按照 lang 的字母顺序更新。
+- (可选)更新文档,在 docs/mds/guide 文件夹更新 [internation.md](https://github.com/any-tdf/stdf/edit/main/docs/mds/guide/internation.md) 和 [internation_en.md](https://github.com/any-tdf/stdf/edit/main/docs/mds/guide/internation_en.md) 文件,请在语言列表中按照 lang 的字母顺序更新。
 - 提交修改内容至你的仓库,然后提 Pull Request 到主仓库。
 - 提交修改内容至你的仓库,然后提 Pull Request 到主仓库。
 - Pull Request 会在 Review 通过后被合并到主仓库,并发布新版本至 npm。
 - Pull Request 会在 Review 通过后被合并到主仓库,并发布新版本至 npm。

+ 3 - 3
docs/mds/guide/internation_en.md

@@ -90,14 +90,14 @@ Currently supported languages:
 > The multilingual files are translated by machine. If there are any inaccuracies, please submit a PR for correction.
 > The multilingual files are translated by machine. If there are any inaccuracies, please submit a PR for correction.
 
 
 ## Adding a Language Pack
 ## Adding a Language Pack
-<!-- main -> next -->
-If you cannot find the language pack you need, you are welcome to create a new language pack based on the [Chinese language pack](https://github.com/any-tdf/stdf/blob/next/packages/stdf/src/lib/lang/zh_CN.ts) or [English language pack](https://github.com/any-tdf/stdf/blob/next/packages/stdf/src/lib/lang/en_US.ts) and submit it as a Pull Request. [Language code table](http://www.lingoes.net/en/translator/langcode.htm)
+
+If you cannot find the language pack you need, you are welcome to create a new language pack based on the [Chinese language pack](https://github.com/any-tdf/stdf/blob/main/packages/stdf/src/lib/lang/zh_CN.ts) or [English language pack](https://github.com/any-tdf/stdf/blob/main/packages/stdf/src/lib/lang/en_US.ts) and submit it as a Pull Request. [Language code table](http://www.lingoes.net/en/translator/langcode.htm)
 
 
 The basic steps are as follows:
 The basic steps are as follows:
 
 
 - Please fork the [STDF](https://github.com/any-tdf/stdf) code to your own repository. If you have already forked it, please sync the latest code from the main repository.
 - Please fork the [STDF](https://github.com/any-tdf/stdf) code to your own repository. If you have already forked it, please sync the latest code from the main repository.
 - Clone your repository to your local machine.
 - Clone your repository to your local machine.
 - Add language packs in the `packages/stdf/src/lib/lang` folder.
 - Add language packs in the `packages/stdf/src/lib/lang` folder.
-- (Optional) Update the documentation. Update the [internation.md](https://github.com/any-tdf/stdf/edit/next/docs/mds/guide/internation.md) and [internation_en.md](https://github.com/any-tdf/stdf/edit/next/docs/mds/guide/internation_en.md) files in the docs/mds/guide folder. Please update them in alphabetical order according to the lang list.
+- (Optional) Update the documentation. Update the [internation.md](https://github.com/any-tdf/stdf/edit/main/docs/mds/guide/internation.md) and [internation_en.md](https://github.com/any-tdf/stdf/edit/main/docs/mds/guide/internation_en.md) files in the docs/mds/guide folder. Please update them in alphabetical order according to the lang list.
 - Commit the modifications to your repository and then submit a Pull Request to the main repository.
 - Commit the modifications to your repository and then submit a Pull Request to the main repository.
 - Once the Pull Request is approved during the review process, it will be merged into the main repository and a new version will be released on npm.
 - Once the Pull Request is approved during the review process, it will be merged into the main repository and a new version will be released on npm.

+ 0 - 2
docs/mds/guide/quickStart.md

@@ -55,8 +55,6 @@ yarn dlx sv create
 ```
 ```
 <!-- ::: -->
 <!-- ::: -->
 
 
-按照提示创建工程。
-
 2.2 安装 Tailwind CSS 与 Vite 插件。
 2.2 安装 Tailwind CSS 与 Vite 插件。
 
 
 参考 [Tailwind CSS 文档](https://tailwindcss.com/docs/guides/vite#svelte) 配置 Tailwind CSS。
 参考 [Tailwind CSS 文档](https://tailwindcss.com/docs/guides/vite#svelte) 配置 Tailwind CSS。

+ 0 - 2
docs/mds/guide/quickStart_en.md

@@ -55,8 +55,6 @@ yarn dlx sv create
 ```
 ```
 <!-- ::: -->
 <!-- ::: -->
 
 
-Follow the prompts to create the project.
-
 2.2 Install Tailwind CSS and Vite plugins.
 2.2 Install Tailwind CSS and Vite plugins.
 
 
 Refer to the [Tailwind CSS documentation](https://tailwindcss.com/docs/guides/vite#svelte) to configure Tailwind CSS.
 Refer to the [Tailwind CSS documentation](https://tailwindcss.com/docs/guides/vite#svelte) to configure Tailwind CSS.

+ 0 - 2
docs/mds/guide/theme.md

@@ -5,8 +5,6 @@
 使用 Tailwind CSS 的暗模式配置,请在项目入口 CSS 文件中做如下 `@custom-variant` 配置,参考 [Dark Mode](https://tailwindcss.com/docs/dark-mode)。
 使用 Tailwind CSS 的暗模式配置,请在项目入口 CSS 文件中做如下 `@custom-variant` 配置,参考 [Dark Mode](https://tailwindcss.com/docs/dark-mode)。
 
 
 ```css
 ```css
-@import 'tailwindcss';
-
 @custom-variant dark (&:where(.dark, .dark *))
 @custom-variant dark (&:where(.dark, .dark *))
 ```
 ```
 
 

+ 0 - 2
docs/mds/guide/theme_en.md

@@ -5,8 +5,6 @@
 Use the Tailwind CSS dark mode configuration, please make the following `@custom-variant` configuration in the project entry CSS file, reference [Dark Mode](https://tailwindcss.com/docs/dark-mode).
 Use the Tailwind CSS dark mode configuration, please make the following `@custom-variant` configuration in the project entry CSS file, reference [Dark Mode](https://tailwindcss.com/docs/dark-mode).
 
 
 ```css
 ```css
-@import 'tailwindcss';
-
 @custom-variant dark (&:where(.dark, .dark *))
 @custom-variant dark (&:where(.dark, .dark *))
 ```
 ```