Skip to content

Commit 70255d6

Browse files
authored
docs: improve add docs (#787)
1 parent 165f56c commit 70255d6

File tree

5 files changed

+28
-11
lines changed

5 files changed

+28
-11
lines changed

documentation/docs/20-commands/20-sv-add.md

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,27 @@ You can select multiple space-separated add-ons from [the list below](#Official-
1818

1919
## Options
2020

21-
- `-C`, `--cwd` — path to the root of your Svelte(Kit) project
22-
- `--no-git-check` — even if some files are dirty, no prompt will be shown
23-
- `--install` — installs dependencies with a specified package manager
24-
- `--no-install` — prevents installing dependencies
21+
### `-C`, `--cwd`
22+
23+
Path to the root of your Svelte(Kit) project.
24+
25+
### `--no-git-check`
26+
27+
Even if some files are dirty, no prompt will be shown
28+
29+
### `--install <package-manager>`
30+
31+
Installs dependencies with a specified package manager:
32+
33+
- `npm`
34+
- `pnpm`
35+
- `yarn`
36+
- `bun`
37+
- `deno`
38+
39+
### `--no-install`
40+
41+
Prevents installing dependencies
2542

2643
## Official add-ons
2744

documentation/docs/30-add-ons/05-drizzle.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Which database variant to use:
2828
- `sqlite` — file-based database not requiring a database server
2929

3030
```sh
31-
npx sv add drizzle=database:postgresql
31+
npx sv add drizzle="database:postgresql"
3232
```
3333

3434
### client
@@ -40,7 +40,7 @@ The SQL client to use, depends on `database`:
4040
- For `sqlite`: `better-sqlite3`, `libsql`, `turso`
4141

4242
```sh
43-
npx sv add drizzle=database:postgresql+client:postgres.js
43+
npx sv add drizzle="database:postgresql+client:postgres.js"
4444
```
4545

4646
Drizzle is compatible with well over a dozen database drivers. We just offer a few of the most common ones here for simplicity, but if you'd like to use another one you can choose one as a placeholder and swap it out for another after setup by choosing from [Drizzle's full list of compatible drivers](https://orm.drizzle.team/docs/connect-overview#next-steps).
@@ -50,5 +50,5 @@ Drizzle is compatible with well over a dozen database drivers. We just offer a f
5050
Whether to add Docker Compose configuration. Only available for [`database`](#Options-database) `postgresql` or `mysql`
5151

5252
```sh
53-
npx sv add drizzle=database:postgresql+client:postgres.js+docker:yes
53+
npx sv add drizzle="database:postgresql+client:postgres.js+docker:yes"
5454
```

documentation/docs/30-add-ons/15-lucia.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,5 +22,5 @@ npx sv add lucia
2222
Whether to include demo registration and login pages.
2323

2424
```sh
25-
npx sv add lucia=demo:yes
25+
npx sv add lucia="demo:yes"
2626
```

documentation/docs/30-add-ons/17-mcp.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,13 @@ npx sv add mcp
2121
The IDE you want to use like `'claude-code'`, `'cursor'`, `'gemini'`, `'opencode'`, `'vscode'`, `'other'`.
2222

2323
```sh
24-
npx sv add mcp=ide:cursor,vscode
24+
npx sv add mcp="ide:cursor,vscode"
2525
```
2626

2727
### setup
2828

2929
The setup you want to use.
3030

3131
```sh
32-
npx sv add mcp=setup:local
32+
npx sv add mcp="setup:local"
3333
```

documentation/docs/30-add-ons/45-sveltekit-adapter.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,5 +28,5 @@ Which SvelteKit adapter to use:
2828
- `netlify`[`@sveltejs/adapter-netlify`](/docs/kit/adapter-netlify) allows you to deploy to Netlify
2929

3030
```sh
31-
npx sv add sveltekit-adapter=adapter:node
31+
npx sv add sveltekit-adapter="adapter:node"
3232
```

0 commit comments

Comments
 (0)