stdf/packages/create-stdf/README.md

简体中文

Since v0.2.2, you can choose to use stdf-icon or iconify for icons.

create-stdf

A CLI for creating new STDF projects. Just run...

pnpm create stdf@latest

npm create stdf@latest
# or
npm init stdf@latest
# or
npx create-stdf@latest

bun create stdf@latest

yarn create stdf@latest

...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:

pnpm create stdf my-app

npm create stdf@latest my-app

bun create stdf my-app

yarn create stdf my-app

If you want to use the SvelteKit & Tailwind & STDF template, run:

pnpm create stdf my-app --template skt
# or
pnpm create stdf my-app -t skt

npm create stdf@latest my-app --template skt
# or
npm create stdf@latest my-app -t skt

bun create stdf my-app --template skt
# or
bun create stdf my-app -t skt

yarn create stdf my-app --template skt
# or
yarn create stdf my-app -t skt

Options

Option	Type	Default	Description
-	string	-	The name of the project, you can direct input.
-t / --template	'sktt'\|'skt'\|'skut'\|'sku'	'sktt'	The template to use.
-l / --language	'en_US'\|'zh_CN'\|'zh_TW'\|'ja_JP'\|'ko_KR'\|'es_ES'\|'ru_RU'\|'fr_FR'\|'de_DE'\|'it_IT'	'en_US'	The language of the prompts.
-i / --icon-usage	'stdf-icon'\|'iconify'\|'both'\|'none'	'stdf-icon'	The icon usage method.

Template presets

Abbreviation	Template	Description
sktt	SvelteKit & Tailwind & TypeScript	Default
skt	SvelteKit & Tailwind	-
skut	SvelteKit & UnoCSS & TypeScript	Not adapted yet
sku	SvelteKit & UnoCSS	Not adapted yet

Language presets

Abbreviation	Language
en_US	English (US)
zh_CN	Chinese (Simplified)
zh_TW	Chinese (Traditional)
ja_JP	Japanese
ko_KR	Korean
es_ES	Spanish
ru_RU	Russian
fr_FR	French
de_DE	German
it_IT	Italian

Icon usage presets

Abbreviation	Description
stdf-icon	Use rollup-plugin-stdf-icon to manage icons.
iconify	Use iconify to manage icons.
both	Use both rollup-plugin-stdf-icon and iconify to manage icons.
none	Do not use any tool to manage icons.

For example:

pnpm create stdf my-app -l zh_CN

npm create stdf@latest my-app -l zh_CN

bun create stdf my-app -l zh_CN

yarn create stdf my-app -l zh_CN

License

This project is licensed under the MIT License.