Skip to content

Commit cb5afa2

Browse files
authored
docs: add Vite+ to Quickstart and CLI (#542)
Adds Vite+ to the "Create an app" setup commands and the "Binary Invocation" section of the CLI docs. Also converts the "Run locally" code on the quickstart page to a code group to match the "Create an app" code group ## Notes The icon is a _tiny_ hack. The string `vite+` renders the `vite` icon since non-alphabetical characters are ignored when determining the icon. I have [a PR with `vscode-icons`](vscode-icons/vscode-icons#4425) to add the Vite+ icon there, which will bubble up into Vitepress via `@iconify-json/simple-icons`. I'm happy to submit a follow-up PR once that's live. ## Demo <img width="3024" height="1718" alt="image" src="https://github.com/user-attachments/assets/42df2704-d3c1-4fee-a702-657cbf06cc38" />
1 parent d031dea commit cb5afa2

2 files changed

Lines changed: 27 additions & 2 deletions

File tree

‎docs/guide/quickstart.md‎

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,11 @@ bun add -D void
3232
bunx void init
3333
```
3434

35+
```sh [vite+]
36+
vp add -D void
37+
vpx void init
38+
```
39+
3540
:::
3641

3742
Choose your UI framework, a starter, and a deployment target. Vite+ is the default build tool. D1 is a good first database: it runs locally without a separate database server. Choose Cloudflare to deploy to your own account, or skip deployment setup for now.
@@ -42,10 +47,30 @@ With pnpm, `pnpm create void my-app` also creates the project directory and conf
4247

4348
## Run locally
4449

45-
```sh
50+
::: code-group
51+
52+
```sh [npm]
4653
npm run dev
4754
```
4855

56+
```sh [pnpm]
57+
pnpm run dev
58+
```
59+
60+
```sh [yarn]
61+
yarn run dev
62+
```
63+
64+
```sh [bun]
65+
bun run dev
66+
```
67+
68+
```sh [vite+]
69+
vpr dev
70+
```
71+
72+
:::
73+
4974
Open `http://localhost:5173`. In a Pages starter, `pages/` contains your UI and companion `.server.ts` files contain its server loaders and actions. Loaders return data to page components as typed props.
5075

5176
## Call a server route

‎docs/reference/cli.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ Use this page as a command reference. If you are setting up a project for the fi
7979

8080
## Binary Invocation {#binary-invocation}
8181

82-
The docs use `void` for brevity. Outside package scripts, run it with your package manager: `npx void`, `pnpm void`, `yarn void`, or `bunx void`.
82+
The docs use `void` for brevity. Outside package scripts, run it with your package manager: `npx void`, `pnpm void`, `yarn void`, `bunx void`, or `vpx void`.
8383

8484
Alternatively, you can add `./node_modules/.bin` to your `PATH` so that you can invoke `void` directly when you are in the root directory of your app.
8585

0 commit comments

Comments
 (0)