stdf/packages/create-stdf

简体中文

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: create a new project named my-app using the SvelteKit & Tailwind & TypeScript & STDF template, run:

pnpm create stdf@latest my-app

npm create stdf@latest my-app

bun create stdf@latest my-app

yarn create stdf@latest my-app

Prompt language is Simplified Chinese, use SvelteKit & Tailwind & STDF template, use Iconify to manage icons, create a new project named my-app, run:

pnpm create stdf@latest my-app --template skt --language zh_CN --icon-usage iconify
# or
pnpm create stdf@latest my-app --t skt --l zh_CN --i iconify

npm create stdf@latest my-app --template skt --language zh_CN --icon-usage iconify
# or
npm create stdf@latest my-app --t skt --l zh_CN --i iconify

bun create stdf@latest my-app --template skt --language zh_CN --icon-usage iconify
# or
bun create stdf@latest my-app --t skt --l zh_CN --i iconify

yarn create stdf@latest my-app --template skt --language zh_CN --icon-usage iconify
# or
yarn create stdf@latest my-app --t skt --l zh_CN --i iconify

Options

Option	Default	Description
-	-	The name of the project, you can direct input.
--t / --template	sktt	The template to use.
--l / --language	en_US	The language of the prompts.
--i / --icon-usage	stdf-icon	The icon usage method.

Template presets

Abbreviation	Template	Description
sktt	SvelteKit & Tailwind & TypeScript	Default
skt	SvelteKit & Tailwind	-
vstt	Vite & Svelte & Tailwind & TypeScript	-
vst	Vite & Svelte & Tailwind	-
skut	SvelteKit & UnoCSS & TypeScript	Not adapted yet
sku	SvelteKit & UnoCSS	Not adapted yet
vsut	Vite & Svelte & UnoCSS	Not adapted yet
vsu	Vite & Svelte & 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.

License

This project is licensed under the MIT License.