Skip to content

Commit 45aaafd

Browse files
chenjiahanchenjiahan
authored
docs(create-rstack): document template scripts (#307)
1 parent 6f072d1 commit 45aaafd

13 files changed

Lines changed: 116 additions & 307 deletions

File tree

‎packages/create-rstack/template-common/README.md‎

Lines changed: 10 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -8,25 +8,16 @@ Install the dependencies:
88
{{ packageManager }} install
99
```
1010

11-
## Get started
12-
13-
Start the development server:
14-
15-
```bash
16-
{{ packageManager }} run dev
17-
```
18-
19-
Build the app for production:
20-
21-
```bash
22-
{{ packageManager }} run build
23-
```
24-
25-
Preview the production build locally:
26-
27-
```bash
28-
{{ packageManager }} run preview
29-
```
11+
## Scripts
12+
13+
- `{{ packageManager }} run build`: Build the app for production.
14+
- `{{ packageManager }} run check`: Run static checks, including linting and formatting.
15+
- `{{ packageManager }} run dev`: Run the app dev server.
16+
- `{{ packageManager }} run format`: Format code.
17+
- `{{ packageManager }} run lint`: Lint code.
18+
- `{{ packageManager }} run preview`: Preview the app production build.
19+
- `{{ packageManager }} run test`: Run tests.
20+
- `{{ packageManager }} run test:watch`: Run tests in watch mode.
3021

3122
## Learn more
3223

‎packages/create-rstack/template-doc-i18n/README.md‎

Lines changed: 8 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -8,25 +8,14 @@ Install the dependencies:
88
{{ packageManager }} install
99
```
1010

11-
## Get started
12-
13-
Start the development server:
14-
15-
```bash
16-
{{ packageManager }} run dev
17-
```
18-
19-
Build the website for production:
20-
21-
```bash
22-
{{ packageManager }} run build
23-
```
24-
25-
Preview the production build locally:
26-
27-
```bash
28-
{{ packageManager }} run preview
29-
```
11+
## Scripts
12+
13+
- `{{ packageManager }} run build`: Build the documentation site for production.
14+
- `{{ packageManager }} run check`: Run static checks, including linting and formatting.
15+
- `{{ packageManager }} run dev`: Start the documentation dev server.
16+
- `{{ packageManager }} run format`: Format code.
17+
- `{{ packageManager }} run lint`: Lint code.
18+
- `{{ packageManager }} run preview`: Preview the production build locally.
3019

3120
## Learn more
3221

‎packages/create-rstack/template-doc/README.md‎

Lines changed: 8 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -8,25 +8,14 @@ Install the dependencies:
88
{{ packageManager }} install
99
```
1010

11-
## Get started
12-
13-
Start the development server:
14-
15-
```bash
16-
{{ packageManager }} run dev
17-
```
18-
19-
Build the website for production:
20-
21-
```bash
22-
{{ packageManager }} run build
23-
```
24-
25-
Preview the production build locally:
26-
27-
```bash
28-
{{ packageManager }} run preview
29-
```
11+
## Scripts
12+
13+
- `{{ packageManager }} run build`: Build the documentation site for production.
14+
- `{{ packageManager }} run check`: Run static checks, including linting and formatting.
15+
- `{{ packageManager }} run dev`: Start the documentation dev server.
16+
- `{{ packageManager }} run format`: Format code.
17+
- `{{ packageManager }} run lint`: Lint code.
18+
- `{{ packageManager }} run preview`: Preview the production build locally.
3019

3120
## Learn more
3221

‎packages/create-rstack/template-lib-node-ts/README.md‎

Lines changed: 9 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -8,31 +8,15 @@ Install the dependencies:
88
{{ packageManager }} install
99
```
1010

11-
## Get started
12-
13-
Build the library:
14-
15-
```bash
16-
{{ packageManager }} run build
17-
```
18-
19-
Build the library in watch mode:
20-
21-
```bash
22-
{{ packageManager }} run dev
23-
```
24-
25-
Run tests:
26-
27-
```bash
28-
{{ packageManager }} run test
29-
```
30-
31-
Run tests in watch mode:
32-
33-
```bash
34-
{{ packageManager }} run test:watch
35-
```
11+
## Scripts
12+
13+
- `{{ packageManager }} run build`: Build the library.
14+
- `{{ packageManager }} run check`: Run static checks, including linting and formatting.
15+
- `{{ packageManager }} run dev`: Build the library in watch mode.
16+
- `{{ packageManager }} run format`: Format code.
17+
- `{{ packageManager }} run lint`: Lint code.
18+
- `{{ packageManager }} run test`: Run tests.
19+
- `{{ packageManager }} run test:watch`: Run tests in watch mode.
3620

3721
## Learn more
3822

‎packages/create-rstack/template-lib-node/README.md‎

Lines changed: 9 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -8,31 +8,15 @@ Install the dependencies:
88
{{ packageManager }} install
99
```
1010

11-
## Get started
12-
13-
Build the library:
14-
15-
```bash
16-
{{ packageManager }} run build
17-
```
18-
19-
Build the library in watch mode:
20-
21-
```bash
22-
{{ packageManager }} run dev
23-
```
24-
25-
Run tests:
26-
27-
```bash
28-
{{ packageManager }} run test
29-
```
30-
31-
Run tests in watch mode:
32-
33-
```bash
34-
{{ packageManager }} run test:watch
35-
```
11+
## Scripts
12+
13+
- `{{ packageManager }} run build`: Build the library.
14+
- `{{ packageManager }} run check`: Run static checks, including linting and formatting.
15+
- `{{ packageManager }} run dev`: Build the library in watch mode.
16+
- `{{ packageManager }} run format`: Format code.
17+
- `{{ packageManager }} run lint`: Lint code.
18+
- `{{ packageManager }} run test`: Run tests.
19+
- `{{ packageManager }} run test:watch`: Run tests in watch mode.
3620

3721
## Learn more
3822

‎packages/create-rstack/template-lib-react-ts/README.md‎

Lines changed: 9 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -8,31 +8,15 @@ Install the dependencies:
88
{{ packageManager }} install
99
```
1010

11-
## Get started
12-
13-
Build the library:
14-
15-
```bash
16-
{{ packageManager }} run build
17-
```
18-
19-
Build the library in watch mode:
20-
21-
```bash
22-
{{ packageManager }} run dev
23-
```
24-
25-
Run tests:
26-
27-
```bash
28-
{{ packageManager }} run test
29-
```
30-
31-
Run tests in watch mode:
32-
33-
```bash
34-
{{ packageManager }} run test:watch
35-
```
11+
## Scripts
12+
13+
- `{{ packageManager }} run build`: Build the library.
14+
- `{{ packageManager }} run check`: Run static checks, including linting and formatting.
15+
- `{{ packageManager }} run dev`: Build the library in watch mode.
16+
- `{{ packageManager }} run format`: Format code.
17+
- `{{ packageManager }} run lint`: Lint code.
18+
- `{{ packageManager }} run test`: Run tests.
19+
- `{{ packageManager }} run test:watch`: Run tests in watch mode.
3620

3721
## Learn more
3822

‎packages/create-rstack/template-lib-react/README.md‎

Lines changed: 9 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -8,31 +8,15 @@ Install the dependencies:
88
{{ packageManager }} install
99
```
1010

11-
## Get started
12-
13-
Build the library:
14-
15-
```bash
16-
{{ packageManager }} run build
17-
```
18-
19-
Build the library in watch mode:
20-
21-
```bash
22-
{{ packageManager }} run dev
23-
```
24-
25-
Run tests:
26-
27-
```bash
28-
{{ packageManager }} run test
29-
```
30-
31-
Run tests in watch mode:
32-
33-
```bash
34-
{{ packageManager }} run test:watch
35-
```
11+
## Scripts
12+
13+
- `{{ packageManager }} run build`: Build the library.
14+
- `{{ packageManager }} run check`: Run static checks, including linting and formatting.
15+
- `{{ packageManager }} run dev`: Build the library in watch mode.
16+
- `{{ packageManager }} run format`: Format code.
17+
- `{{ packageManager }} run lint`: Lint code.
18+
- `{{ packageManager }} run test`: Run tests.
19+
- `{{ packageManager }} run test:watch`: Run tests in watch mode.
3620

3721
## Learn more
3822

‎packages/create-rstack/template-lib-solid-ts/README.md‎

Lines changed: 9 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -8,31 +8,15 @@ Install the dependencies:
88
{{ packageManager }} install
99
```
1010

11-
## Get started
12-
13-
Build the library:
14-
15-
```bash
16-
{{ packageManager }} run build
17-
```
18-
19-
Build the library in watch mode:
20-
21-
```bash
22-
{{ packageManager }} run dev
23-
```
24-
25-
Run tests:
26-
27-
```bash
28-
{{ packageManager }} run test
29-
```
30-
31-
Run tests in watch mode:
32-
33-
```bash
34-
{{ packageManager }} run test:watch
35-
```
11+
## Scripts
12+
13+
- `{{ packageManager }} run build`: Build the library.
14+
- `{{ packageManager }} run check`: Run static checks, including linting and formatting.
15+
- `{{ packageManager }} run dev`: Build the library in watch mode.
16+
- `{{ packageManager }} run format`: Format code.
17+
- `{{ packageManager }} run lint`: Lint code.
18+
- `{{ packageManager }} run test`: Run tests.
19+
- `{{ packageManager }} run test:watch`: Run tests in watch mode.
3620

3721
## Learn more
3822

‎packages/create-rstack/template-lib-solid/README.md‎

Lines changed: 9 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -8,31 +8,15 @@ Install the dependencies:
88
{{ packageManager }} install
99
```
1010

11-
## Get started
12-
13-
Build the library:
14-
15-
```bash
16-
{{ packageManager }} run build
17-
```
18-
19-
Build the library in watch mode:
20-
21-
```bash
22-
{{ packageManager }} run dev
23-
```
24-
25-
Run tests:
26-
27-
```bash
28-
{{ packageManager }} run test
29-
```
30-
31-
Run tests in watch mode:
32-
33-
```bash
34-
{{ packageManager }} run test:watch
35-
```
11+
## Scripts
12+
13+
- `{{ packageManager }} run build`: Build the library.
14+
- `{{ packageManager }} run check`: Run static checks, including linting and formatting.
15+
- `{{ packageManager }} run dev`: Build the library in watch mode.
16+
- `{{ packageManager }} run format`: Format code.
17+
- `{{ packageManager }} run lint`: Lint code.
18+
- `{{ packageManager }} run test`: Run tests.
19+
- `{{ packageManager }} run test:watch`: Run tests in watch mode.
3620

3721
## Learn more
3822

‎packages/create-rstack/template-lib-svelte-ts/README.md‎

Lines changed: 9 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -8,31 +8,15 @@ Install the dependencies:
88
{{ packageManager }} install
99
```
1010

11-
## Get started
12-
13-
Build the library:
14-
15-
```bash
16-
{{ packageManager }} run build
17-
```
18-
19-
Build the library in watch mode:
20-
21-
```bash
22-
{{ packageManager }} run dev
23-
```
24-
25-
Run tests:
26-
27-
```bash
28-
{{ packageManager }} run test
29-
```
30-
31-
Run tests in watch mode:
32-
33-
```bash
34-
{{ packageManager }} run test:watch
35-
```
11+
## Scripts
12+
13+
- `{{ packageManager }} run build`: Build the library.
14+
- `{{ packageManager }} run check`: Run static checks, including linting and formatting.
15+
- `{{ packageManager }} run dev`: Build the library in watch mode.
16+
- `{{ packageManager }} run format`: Format code.
17+
- `{{ packageManager }} run lint`: Lint code.
18+
- `{{ packageManager }} run test`: Run tests.
19+
- `{{ packageManager }} run test:watch`: Run tests in watch mode.
3620

3721
## Learn more
3822

0 commit comments

Comments
 (0)