Skip to content

Commit

Permalink
Update documents
Browse files Browse the repository at this point in the history
  • Loading branch information
dufu1991 committed Jul 26, 2023
1 parent 085608d commit e49f6ec
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 8 deletions.
20 changes: 16 additions & 4 deletions doc/guide/quickStart.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,21 @@ import { Button } from 'stdf';

## 😓 无工程

### 搭建工程
### 使用 create-stdf

可以尝试使用 `create-stdf` 快速创建工程。(beta 版本,可能存在问题)

```bash
pnpm create stdf@latest
# or
npm create stdf@latest
# or
npm init stdf@latest
# or
npx create-stdf@latest
```

### 自行搭建工程

此处用 Vite 示例创建工程,参考 [Vite 文档](https://cn.vitejs.dev/guide/#scaffolding-your-first-vite-project)

Expand All @@ -35,9 +49,7 @@ npm create vite@latest

按照提示操作创建工程。

### 配置 Tailwind CSS

参考 [Tailwind CSS 文档](https://tailwindcss.com/docs/guides/vite)
参考 [Tailwind CSS 文档](https://tailwindcss.com/docs/guides/vite) 配置 Tailwind CSS。

1. 安装 Tailwind CSS 和其他依赖,然后生成 `tailwind.config.js``postcss.config.js` 文件。

Expand Down
20 changes: 16 additions & 4 deletions doc/guide/quickStart_en.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,21 @@ import { Button } from 'stdf';

## 😓 No works

### Construction project
### Use create-stdf

You can try using `create-stdf` to quickly create a project. (beta version, may have issues)

```bash
pnpm create stdf@latest
# or
npm create stdf@latest
# or
npm init stdf@latest
# or
npx create-stdf@latest
```

### Build your own project

Use the Vite example to create the project here. See [Vite documentation](https://vitejs.dev/guide/#scaffolding-your-first-vite-project).

Expand All @@ -35,9 +49,7 @@ npm create vite@latest

Follow the prompts to create a project.

### Configuration Tailwind CSS

See [Tailwind CSS documentation](https://tailwindcss.com/docs/guides/vite)
Configuration Tailwind CSS. See [Tailwind CSS documentation](https://tailwindcss.com/docs/guides/vite)

1. Install Tailwind CSS and other dependencies, then generate tailwind.config.js and postcss.config.js files.

Expand Down

0 comments on commit e49f6ec

Please sign in to comment.