Skip to content

Commit cb2cd72

Browse files
authored
add aliases for electron:dev, electron:start, and docsite:start tasks (#1651)
1 parent 0890475 commit cb2cd72

File tree

3 files changed

+10
-4
lines changed

3 files changed

+10
-4
lines changed

BUILD.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -112,15 +112,15 @@ All the methods below will install Node and Go dependencies when they run the fi
112112
Run the following command to build the app and run it via Vite's development server (this enables Hot Module Reloading):
113113

114114
```sh
115-
task electron:dev
115+
task dev
116116
```
117117

118118
### Standalone
119119

120120
Run the following command to build the app and run it standalone, without the development server. This will not reload on change:
121121

122122
```sh
123-
task electron:start
123+
task start
124124
```
125125

126126
### Packaged

Taskfile.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ tasks:
1919
electron:dev:
2020
desc: Run the Electron application via the Vite dev server (enables hot reloading).
2121
cmd: yarn dev
22+
aliases:
23+
- dev
2224
deps:
2325
- yarn
2426
- docsite:build:embedded
@@ -30,6 +32,8 @@ tasks:
3032
electron:start:
3133
desc: Run the Electron application directly.
3234
cmd: yarn start
35+
aliases:
36+
- start
3337
deps:
3438
- yarn
3539
- docsite:build:embedded
@@ -56,6 +60,8 @@ tasks:
5660
desc: Start the docsite dev server.
5761
cmd: yarn start
5862
dir: docs
63+
aliases:
64+
- docsite
5965
deps:
6066
- yarn
6167

docs/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,15 @@ yarn
1313
### Local Development
1414

1515
```sh
16-
yarn start
16+
task docsite
1717
```
1818

1919
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
2020

2121
### Build
2222

2323
```sh
24-
yarn build
24+
task docsite:build:<embedded,public>
2525
```
2626

2727
This command generates static content into the `build` directory and can be served using any static contents hosting service.

0 commit comments

Comments
 (0)