Skip to content

docs(create-rstack): document template scripts #307

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chenjiahan merged 1 commit into from
Aug 11, 2026
Merged

docs(create-rstack): document template scripts #307

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 10 additions & 19 deletions packages/create-rstack/template-common/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,25 +8,16 @@ Install the dependencies:
{{ packageManager }} install
```

## Get started

Start the development server:

```bash
{{ packageManager }} run dev
```

Build the app for production:

```bash
{{ packageManager }} run build
```

Preview the production build locally:

```bash
{{ packageManager }} run preview
```
## Scripts

- `{{ packageManager }} run build`: Build the app for production.
- `{{ packageManager }} run check`: Run static checks, including linting and formatting.
- `{{ packageManager }} run dev`: Run the app dev server.
- `{{ packageManager }} run format`: Format code.
- `{{ packageManager }} run lint`: Lint code.
- `{{ packageManager }} run preview`: Preview the app production build.
- `{{ packageManager }} run test`: Run tests.
- `{{ packageManager }} run test:watch`: Run tests in watch mode.

## Learn more

Expand Down
27 changes: 8 additions & 19 deletions packages/create-rstack/template-doc-i18n/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,25 +8,14 @@ Install the dependencies:
{{ packageManager }} install
```

## Get started

Start the development server:

```bash
{{ packageManager }} run dev
```

Build the website for production:

```bash
{{ packageManager }} run build
```

Preview the production build locally:

```bash
{{ packageManager }} run preview
```
## Scripts

- `{{ packageManager }} run build`: Build the documentation site for production.
- `{{ packageManager }} run check`: Run static checks, including linting and formatting.
- `{{ packageManager }} run dev`: Start the documentation dev server.
- `{{ packageManager }} run format`: Format code.
- `{{ packageManager }} run lint`: Lint code.
- `{{ packageManager }} run preview`: Preview the production build locally.

## Learn more

Expand Down
27 changes: 8 additions & 19 deletions packages/create-rstack/template-doc/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,25 +8,14 @@ Install the dependencies:
{{ packageManager }} install
```

## Get started

Start the development server:

```bash
{{ packageManager }} run dev
```

Build the website for production:

```bash
{{ packageManager }} run build
```

Preview the production build locally:

```bash
{{ packageManager }} run preview
```
## Scripts

- `{{ packageManager }} run build`: Build the documentation site for production.
- `{{ packageManager }} run check`: Run static checks, including linting and formatting.
- `{{ packageManager }} run dev`: Start the documentation dev server.
- `{{ packageManager }} run format`: Format code.
- `{{ packageManager }} run lint`: Lint code.
- `{{ packageManager }} run preview`: Preview the production build locally.

## Learn more

Expand Down
34 changes: 9 additions & 25 deletions packages/create-rstack/template-lib-node-ts/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,31 +8,15 @@ Install the dependencies:
{{ packageManager }} install
```

## Get started

Build the library:

```bash
{{ packageManager }} run build
```

Build the library in watch mode:

```bash
{{ packageManager }} run dev
```

Run tests:

```bash
{{ packageManager }} run test
```

Run tests in watch mode:

```bash
{{ packageManager }} run test:watch
```
## Scripts

- `{{ packageManager }} run build`: Build the library.
- `{{ packageManager }} run check`: Run static checks, including linting and formatting.
- `{{ packageManager }} run dev`: Build the library in watch mode.
- `{{ packageManager }} run format`: Format code.
- `{{ packageManager }} run lint`: Lint code.
- `{{ packageManager }} run test`: Run tests.
- `{{ packageManager }} run test:watch`: Run tests in watch mode.

## Learn more

Expand Down
34 changes: 9 additions & 25 deletions packages/create-rstack/template-lib-node/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,31 +8,15 @@ Install the dependencies:
{{ packageManager }} install
```

## Get started

Build the library:

```bash
{{ packageManager }} run build
```

Build the library in watch mode:

```bash
{{ packageManager }} run dev
```

Run tests:

```bash
{{ packageManager }} run test
```

Run tests in watch mode:

```bash
{{ packageManager }} run test:watch
```
## Scripts

- `{{ packageManager }} run build`: Build the library.
- `{{ packageManager }} run check`: Run static checks, including linting and formatting.
- `{{ packageManager }} run dev`: Build the library in watch mode.
- `{{ packageManager }} run format`: Format code.
- `{{ packageManager }} run lint`: Lint code.
- `{{ packageManager }} run test`: Run tests.
- `{{ packageManager }} run test:watch`: Run tests in watch mode.

## Learn more

Expand Down
34 changes: 9 additions & 25 deletions packages/create-rstack/template-lib-react-ts/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,31 +8,15 @@ Install the dependencies:
{{ packageManager }} install
```

## Get started

Build the library:

```bash
{{ packageManager }} run build
```

Build the library in watch mode:

```bash
{{ packageManager }} run dev
```

Run tests:

```bash
{{ packageManager }} run test
```

Run tests in watch mode:

```bash
{{ packageManager }} run test:watch
```
## Scripts

- `{{ packageManager }} run build`: Build the library.
- `{{ packageManager }} run check`: Run static checks, including linting and formatting.
- `{{ packageManager }} run dev`: Build the library in watch mode.
- `{{ packageManager }} run format`: Format code.
- `{{ packageManager }} run lint`: Lint code.
- `{{ packageManager }} run test`: Run tests.
- `{{ packageManager }} run test:watch`: Run tests in watch mode.

## Learn more

Expand Down
34 changes: 9 additions & 25 deletions packages/create-rstack/template-lib-react/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,31 +8,15 @@ Install the dependencies:
{{ packageManager }} install
```

## Get started

Build the library:

```bash
{{ packageManager }} run build
```

Build the library in watch mode:

```bash
{{ packageManager }} run dev
```

Run tests:

```bash
{{ packageManager }} run test
```

Run tests in watch mode:

```bash
{{ packageManager }} run test:watch
```
## Scripts

- `{{ packageManager }} run build`: Build the library.
- `{{ packageManager }} run check`: Run static checks, including linting and formatting.
- `{{ packageManager }} run dev`: Build the library in watch mode.
- `{{ packageManager }} run format`: Format code.
- `{{ packageManager }} run lint`: Lint code.
- `{{ packageManager }} run test`: Run tests.
- `{{ packageManager }} run test:watch`: Run tests in watch mode.

## Learn more

Expand Down
34 changes: 9 additions & 25 deletions packages/create-rstack/template-lib-solid-ts/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,31 +8,15 @@ Install the dependencies:
{{ packageManager }} install
```

## Get started

Build the library:

```bash
{{ packageManager }} run build
```

Build the library in watch mode:

```bash
{{ packageManager }} run dev
```

Run tests:

```bash
{{ packageManager }} run test
```

Run tests in watch mode:

```bash
{{ packageManager }} run test:watch
```
## Scripts

- `{{ packageManager }} run build`: Build the library.
- `{{ packageManager }} run check`: Run static checks, including linting and formatting.
- `{{ packageManager }} run dev`: Build the library in watch mode.
- `{{ packageManager }} run format`: Format code.
- `{{ packageManager }} run lint`: Lint code.
- `{{ packageManager }} run test`: Run tests.
- `{{ packageManager }} run test:watch`: Run tests in watch mode.

## Learn more

Expand Down
34 changes: 9 additions & 25 deletions packages/create-rstack/template-lib-solid/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,31 +8,15 @@ Install the dependencies:
{{ packageManager }} install
```

## Get started

Build the library:

```bash
{{ packageManager }} run build
```

Build the library in watch mode:

```bash
{{ packageManager }} run dev
```

Run tests:

```bash
{{ packageManager }} run test
```

Run tests in watch mode:

```bash
{{ packageManager }} run test:watch
```
## Scripts

- `{{ packageManager }} run build`: Build the library.
- `{{ packageManager }} run check`: Run static checks, including linting and formatting.
- `{{ packageManager }} run dev`: Build the library in watch mode.
- `{{ packageManager }} run format`: Format code.
- `{{ packageManager }} run lint`: Lint code.
- `{{ packageManager }} run test`: Run tests.
- `{{ packageManager }} run test:watch`: Run tests in watch mode.

## Learn more

Expand Down
34 changes: 9 additions & 25 deletions packages/create-rstack/template-lib-svelte-ts/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,31 +8,15 @@ Install the dependencies:
{{ packageManager }} install
```

## Get started

Build the library:

```bash
{{ packageManager }} run build
```

Build the library in watch mode:

```bash
{{ packageManager }} run dev
```

Run tests:

```bash
{{ packageManager }} run test
```

Run tests in watch mode:

```bash
{{ packageManager }} run test:watch
```
## Scripts

- `{{ packageManager }} run build`: Build the library.
- `{{ packageManager }} run check`: Run static checks, including linting and formatting.
- `{{ packageManager }} run dev`: Build the library in watch mode.
- `{{ packageManager }} run format`: Format code.
- `{{ packageManager }} run lint`: Lint code.
- `{{ packageManager }} run test`: Run tests.
- `{{ packageManager }} run test:watch`: Run tests in watch mode.

## Learn more

Expand Down
Loading