Skip to content

Commit 45ccca5

Browse files
committed
feat(site): mention create-sveltex
1 parent 51df846 commit 45ccca5

File tree

1 file changed

+28
-2
lines changed

1 file changed

+28
-2
lines changed

docs/src/docs/getting-started.md

+28-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,32 @@
11

22
# Getting Started
33

4-
## Installation
4+
## Creating a new project
5+
6+
You can use the [`create-sveltex`] package to create a new project using
7+
SvelTeX:
8+
9+
::: code-group
10+
```sh [pnpm]
11+
pnpm dlx create-sveltex
12+
```
13+
```sh [bun]
14+
bunx create-sveltex
15+
```
16+
```sh [npm]
17+
npx create-sveltex
18+
```
19+
```sh [yarn]
20+
yarn dlx create-sveltex
21+
```
22+
:::
23+
24+
...and follow the prompts.
25+
26+
27+
## Adding to an existing project
28+
29+
### Installation
530

631
To install SvelTeX, run the following command in your project's root directory
732
(wherever your `package.json` is located):
@@ -21,7 +46,7 @@ yarn add -D @nvl/sveltex
2146
```
2247
:::
2348

24-
## Setup
49+
### Setup
2550

2651
SvelTeX has one main export, `sveltex`. This is an asynchronous function that
2752
takes two arguments:
@@ -91,6 +116,7 @@ If you prefer, you can also just use the `sveltex` function directly in your
91116
`svelte.config.js`. Just remember to `await` it.
92117

93118

119+
[`create-sveltex`]: https://www.npmjs.com/package/create-sveltex
94120
[`markdownBackend`]: markdown
95121
[`codeBackend`]: code
96122
[`mathBackend`]: math

0 commit comments

Comments
 (0)