Skip to content

Commit

Permalink
fix docs (#255)
Browse files Browse the repository at this point in the history
  • Loading branch information
Rich-Harris authored Oct 30, 2024
1 parent 39cee31 commit 71b424c
Showing 1 changed file with 12 additions and 11 deletions.
23 changes: 12 additions & 11 deletions documentation/docs/20-commands/10-sv-create.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: sv create
---

`sv create` sets up a new SvelteKit project, with options to [setup additional functionality](sv-add#Official-integrations).
`sv create` sets up a new SvelteKit project, with options to [setup additional functionality](sv-add#Official-add-ons).

## Usage

Expand All @@ -12,16 +12,6 @@ npx sv create [options] [path]

## Options

<!-- TODO this flag should probably just be '--types', and the options should be 'ts' or 'jsdoc' -->

### `--check-types <option>`

Whether and how to add typechecking to the project:

- `typescript` — default to `.ts` files and use `lang="ts"` for `.svelte` components
- `checkjs` — use [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html) for types
- `none` — no typechecking. Not recommended!

### `--template <name>`

Which project template to use:
Expand All @@ -30,6 +20,17 @@ Which project template to use:
- `demo` — showcase app with a word guessing game that works without JavaScript
- `library` — template for a Svelte library, set up with `svelte-package`

### `--types <option>`

Whether and how to add typechecking to the project:

- `ts` — default to `.ts` files and use `lang="ts"` for `.svelte` components
- `jsdoc` — use [JSDoc syntax](https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html) for types

### `--no-types`

Prevent typechecking from being added. Not recommended!

### `--no-integrations`

<!-- TODO should be renamed to `--no-addons` -->
Expand Down

0 comments on commit 71b424c

Please sign in to comment.