Przeglądaj źródła

[create]publish v0.2.3

dufu1991 1 rok temu
rodzic
commit
b75607f7bc

+ 63 - 21
packages/create-stdf/README.md

@@ -1,16 +1,21 @@
 [简体中文](https://github.com/any-tdf/stdf/blob/main/packages/create-stdf/README_CN.md)
 
+> Since v0.2.2, you can choose to use `stdf-icon` or `iconify` for icons.
+
 # create-stdf
 
 A CLI for creating new [STDF](https://stdf.design) projects. Just run...
 
 <!-- :::code-groups -->
 <!-- pnpm -->
+
 ```sh
 pnpm create stdf
 ```
+
 <!-- :: -->
 <!-- npm -->
+
 ```sh
 npm create stdf@latest
 # or
@@ -18,92 +23,121 @@ npm init stdf@latest
 # or
 npx create-stdf@latest
 ```
+
 <!-- :: -->
 <!-- bun -->
+
 ```sh
 bun create stdf
 ```
+
 <!-- :: -->
 <!-- yarn -->
+
 ```sh
 yarn create stdf
 ```
+
 <!-- ::: -->
 
 ...and follow the prompts.
 
-You can also directly specify the project name and the template you want to use via additional command line options. For example, to create a new project named `my-app` using the **SvelteKit + Tailwind + TypeScript + STDF** template, run:
+You can also directly specify the project name and the template you want to use via additional command line options. For example, to create a new project named `my-app` using the **SvelteKit & Tailwind & TypeScript & STDF & stdf-icon** template, run:
 
 <!-- :::code-groups -->
 <!-- pnpm -->
+
 ```sh
 pnpm create stdf my-app
 ```
+
 <!-- :: -->
 <!-- npm -->
+
 ```sh
 npm create stdf@latest my-app
 ```
+
 <!-- :: -->
 <!-- bun -->
+
 ```sh
 bun create stdf my-app
 ```
+
 <!-- :: -->
 <!-- yarn -->
+
 ```sh
 yarn create stdf my-app
 ```
+
 <!-- ::: -->
 
-If you want to use the **SvelteKit + Tailwind + STDF** template, run:
+If you want to use the **SvelteKit & Tailwind & STDF & stdf-icon** template, run:
 
 <!-- :::code-groups -->
 <!-- pnpm -->
+
 ```sh
-pnpm create stdf my-app --template skt
+pnpm create stdf my-app --template skts
 # or
-pnpm create stdf my-app -t skt
+pnpm create stdf my-app -t skts
 ```
+
 <!-- :: -->
 <!-- npm -->
+
 ```sh
-npm create stdf@latest my-app --template skt
+npm create stdf@latest my-app --template skts
 # or
-npm create stdf@latest my-app -t skt
+npm create stdf@latest my-app -t skts
 ```
+
 <!-- :: -->
 <!-- bun -->
+
 ```sh
-bun create stdf my-app --template skt
+bun create stdf my-app --template skts
 # or
-bun create stdf my-app -t skt
+bun create stdf my-app -t skts
 ```
+
 <!-- :: -->
 <!-- yarn -->
+
 ```sh
-yarn create stdf my-app --template skt
+yarn create stdf my-app --template skts
 # or
-yarn create stdf my-app -t skt
+yarn create stdf my-app -t skts
 ```
+
 <!-- ::: -->
 
 Template presets include:
 
-| Abbreviation | Template                                 | Description     |
-| ------------ | ---------------------------------------- | --------------- |
-| sktt         | SvelteKit + Tailwind + TypeScript + STDF | Default         |
-| skt          | SvelteKit + Tailwind + STDF              | -               |
-| skut         | SvelteKit + UnoCSS + TypeScript + STDF   | Not adapted yet |
-| sku          | SvelteKit + UnoCSS + STDF                | Not adapted yet |
+| Abbreviation | Template                                                | Description     |
+| ------------ | ------------------------------------------------------- | --------------- |
+| sktts        | SvelteKit & Tailwind & TypeScript & stdf-icon           | Default         |
+| skts         | SvelteKit & Tailwind & stdf-icon                        | -               |
+| sktti        | SvelteKit & Tailwind & TypeScript & iconify             | -               |
+| skti         | SvelteKit & Tailwind & iconify                          | -               |
+| skttsi       | SvelteKit & Tailwind & TypeScript & stdf-icon & iconify | -               |
+| sktsi        | SvelteKit & Tailwind & stdf-icon & iconify              | -               |
+| skuts        | SvelteKit & UnoCSS & TypeScript & stdf-icon             | Not adapted yet |
+| skus         | SvelteKit & UnoCSS & stdf-icon                          | Not adapted yet |
+| skuti        | SvelteKit & UnoCSS & TypeScript & iconify               | Not adapted yet |
+| skui         | SvelteKit & UnoCSS & iconify                            | Not adapted yet |
+| skutsi       | SvelteKit & UnoCSS & TypeScript & stdf-icon & iconify   | Not adapted yet |
+| skusi        | SvelteKit & UnoCSS & stdf-icon & iconify                | Not adapted yet |
 
 # Options
 
-| Option          | Type   | Default | Description                                                                 |
-| --------------- | ------ | ------- | --------------------------------------------------------------------------- |
-| -               | string | -       | The name of the project, you can direct input.                              |
-| -t / --template | string | sktt    | The template to use. Available templates are: `skt`, `sku`, `sktt`, `skut`. |
-| -l / --language | string | en_US   | The language of the prompts.                                                |
+| Option          | Type   | Default | Description                                    |
+| --------------- | ------ | ------- | ---------------------------------------------- |
+| -               | string | -       | The name of the project, you can direct input. |
+| -t / --template | string | sktts   | The template to use.                           |
+| -l / --language | string | en_US   | The language of the prompts.                   |
 
 # Supported Languages
 
@@ -124,24 +158,32 @@ For example:
 
 <!-- :::code-groups -->
 <!-- pnpm -->
+
 ```sh
 pnpm create stdf my-app -l zh_CN
 ```
+
 <!-- :: -->
 <!-- npm -->
+
 ```sh
 npm create stdf@latest my-app -l zh_CN
 ```
+
 <!-- :: -->
 <!-- bun -->
+
 ```sh
 bun create stdf my-app -l zh_CN
 ```
+
 <!-- :: -->
 <!-- yarn -->
+
 ```sh
 yarn create stdf my-app -l zh_CN
 ```
+
 <!-- ::: -->
 
 # License

+ 59 - 17
packages/create-stdf/README_CN.md

@@ -1,16 +1,21 @@
 [English](https://github.com/any-tdf/stdf/blob/main/packages/create-stdf/README.md)
 
+> v0.2.2 之后支持选择图标使用方式,使用 `stdf-icon` 或 `iconify`。
+
 # create-stdf
 
 一个用于创建新的 [STDF](https://stdf.design) 项目的命令行工具。只需运行以下命令...
 
 <!-- :::code-groups -->
 <!-- pnpm -->
+
 ```sh
 pnpm create stdf
 ```
+
 <!-- :: -->
 <!-- npm -->
+
 ```sh
 npm create stdf@latest
 # 或
@@ -18,91 +23,120 @@ npm init stdf@latest
 # 或
 npx create-stdf@latest
 ```
+
 <!-- :: -->
 <!-- bun -->
+
 ```sh
 bun create stdf
 ```
+
 <!-- :: -->
 <!-- yarn -->
+
 ```sh
 yarn create stdf
 ```
+
 <!-- ::: -->
 
 ...然后按照提示进行操作。
 
-你也可以通过额外的命令行选项直接指定项目名称和要使用的模板。例如,如果要使用 **SvelteKit + Tailwind + TypeScript + STDF** 模板创建一个名为 `my-app` 的新项目,请运行:
+你也可以通过额外的命令行选项直接指定项目名称和要使用的模板。例如,如果要使用 **SvelteKit & Tailwind & TypeScript & STDF & stdf-icon** 模板创建一个名为 `my-app` 的新项目,请运行:
 
 <!-- :::code-groups -->
 <!-- pnpm -->
+
 ```sh
 pnpm create stdf my-app
 ```
+
 <!-- :: -->
 <!-- npm -->
+
 ```sh
 npm create stdf@latest my-app
 ```
+
 <!-- :: -->
 <!-- bun -->
+
 ```sh
 bun create stdf my-app
 ```
+
 <!-- :: -->
 <!-- yarn -->
+
 ```sh
 yarn create stdf my-app
 ```
+
 <!-- ::: -->
 
-如果要使用 **SvelteKit + Tailwind + STDF** 模板,请运行:
+如果要使用 **SvelteKit & Tailwind & STDF & stdf-icon** 模板,请运行:
 
 <!-- :::code-groups -->
 <!-- pnpm -->
+
 ```sh
-pnpm create stdf my-app --template skt
+pnpm create stdf my-app --template skts
 # 或
-pnpm create stdf my-app -t skt
+pnpm create stdf my-app -t skts
 ```
+
 <!-- :: -->
 <!-- npm -->
+
 ```sh
-npm create stdf@latest my-app --template skt
+npm create stdf@latest my-app --template skts
 # 或
-npm create stdf@latest my-app -t skt
+npm create stdf@latest my-app -t skts
 ```
+
 <!-- :: -->
 <!-- bun -->
+
 ```sh
-bun create stdf my-app --template skt
+bun create stdf my-app --template skts
 # 或
-bun create stdf my-app -t skt
+bun create stdf my-app -t skts
 ```
+
 <!-- :: -->
 <!-- yarn -->
+
 ```sh
-yarn create stdf my-app --template skt
+yarn create stdf my-app --template skts
 # 或
-yarn create stdf my-app -t skt
+yarn create stdf my-app -t skts
 ```
+
 <!-- ::: -->
 
 模板预设包括:
 
-| 简写 | 模板                                     | 描述     |
-| ---- | ---------------------------------------- | -------- |
-| sktt | SvelteKit + Tailwind + TypeScript + STDF | 默认     |
-| skt  | SvelteKit + Tailwind + STDF              | -        |
-| skut | SvelteKit + UnoCSS + TypeScript + STDF   | 尚未适配 |
-| sku  | SvelteKit + UnoCSS + STDF                | 尚未适配 |
+| 简写   | 模板                                                    | 描述     |
+| ------ | ------------------------------------------------------- | -------- |
+| sktts  | SvelteKit & Tailwind & TypeScript & stdf-icon           | 默认     |
+| skts   | SvelteKit & Tailwind & stdf-icon                        | -        |
+| sktti  | SvelteKit & Tailwind & TypeScript & iconify             | -        |
+| skti   | SvelteKit & Tailwind & iconify                          | -        |
+| skttsi | SvelteKit & Tailwind & TypeScript & stdf-icon & iconify | -        |
+| sktsi  | SvelteKit & Tailwind & stdf-icon & iconify              | -        |
+| skuts  | SvelteKit & UnoCSS & TypeScript & stdf-icon             | 暂未适配 |
+| skus   | SvelteKit & UnoCSS & stdf-icon                          | 暂未适配 |
+| skuti  | SvelteKit & UnoCSS & TypeScript & iconify               | 暂未适配 |
+| skui   | SvelteKit & UnoCSS & iconify                            | 暂未适配 |
+| skutsi | SvelteKit & UnoCSS & TypeScript & stdf-icon & iconify   | 暂未适配 |
+| skusi  | SvelteKit & UnoCSS & stdf-icon & iconify                | 暂未适配 |
 
 # 命令选项
 
 | 命令            | 类型   | 默认  | 描述                                                       |
 | --------------- | ------ | ----- | ---------------------------------------------------------- |
 | -               | string | -     | 项目名称,可以直接输入。                                   |
-| -t / --template | string | sktt  | 要使用的模板。可用的模板有:`skt`、`sku`、`sktt`、`skut`。 |
+| -t / --template | string | sktts | 要使用的模板。 |
 | -l / --language | string | en_US | 提示语言。                                                 |
 
 # 支持的语言
@@ -124,24 +158,32 @@ yarn create stdf my-app -t skt
 
 <!-- :::code-groups -->
 <!-- pnpm -->
+
 ```sh
 pnpm create stdf my-app -l zh_CN
 ```
+
 <!-- :: -->
 <!-- npm -->
+
 ```sh
 npm create stdf@latest my-app -l zh_CN
 ```
+
 <!-- :: -->
 <!-- bun -->
+
 ```sh
 bun create stdf my-app -l zh_CN
 ```
+
 <!-- :: -->
 <!-- yarn -->
+
 ```sh
 yarn create stdf my-app -l zh_CN
 ```
+
 <!-- ::: -->
 
 # 许可证

+ 1 - 1
packages/create-stdf/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "create-stdf",
-	"version": "0.2.2",
+	"version": "0.2.3",
 	"description": "A CLI for creating new STDF projects",
 	"bin": {
 		"create-stdf": "index.js"