Skip to content

Commit

Permalink
docs: PNPM as default package manager (#2027)
Browse files Browse the repository at this point in the history
  • Loading branch information
kermanx authored Jan 29, 2025
1 parent 69a0760 commit e871f43
Show file tree
Hide file tree
Showing 6 changed files with 34 additions and 27 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ packages
parser/ - parser for Slidev's extended Markdown format
create-app/ - scripts and template for `npm init slidev`
create-theme/ - scripts and template for `npm init slidev-theme`
theme-*/ - official themes
vscode/ - the VSCode extension
```

## Code Style
Expand Down
16 changes: 8 additions & 8 deletions docs/features/remote-access.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ You can run your presentation with remote access by using the `--remote` flag:

::: code-group

```bash [npm]
npm run dev -- --remote
```bash [pnpm]
pnpm dev --remote
# i.e. slidev --remote
```

```bash [pnpm]
pnpm dev -- --remote
```bash [npm]
npm run dev -- --remote
# i.e. slidev --remote
```

Expand All @@ -41,13 +41,13 @@ You can open a [Cloudflare Quick Tunnels](https://developers.cloudflare.com/clou

::: code-group

```bash [npm]
npm run dev -- --remote --tunnel
```bash [pnpm]
pnpm dev -- --remote --tunnel
# i.e. slidev --remote --tunnel
```

```bash [pnpm]
pnpm dev -- --remote --tunnel
```bash [npm]
npm run dev -- --remote --tunnel
# i.e. slidev --remote --tunnel
```

Expand Down
8 changes: 4 additions & 4 deletions docs/guide/exporting.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,14 +26,14 @@ Exporting to PDF, PPTX, or PNG relies on [Playwright](https://playwright.dev) fo

::: code-group

```bash [npm]
$ npm i -D playwright-chromium
```

```bash [pnpm]
$ pnpm add -D playwright-chromium
```

```bash [npm]
$ npm i -D playwright-chromium
```

```bash [yarn]
$ yarn add -D playwright-chromium
```
Expand Down
23 changes: 15 additions & 8 deletions docs/guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,14 +46,21 @@ Run the following command to create a new Slidev project locally:

::: code-group

```bash [npm]
npm init slidev@latest
```

```bash [pnpm]
# If you haven't installed pnpm
npm i -g pnpm

pnpm create slidev
```

```bash [npm]
# Not recommended -
# NPM will download the packages each time you create a new project,
# which is slow and takes up a lot of space

npm init slidev@latest
```

```bash [yarn]
yarn create slidev
```
Expand All @@ -68,14 +75,14 @@ If you prefer to have a single Markdown file as your slides, you can install the

::: code-group

```bash [npm]
npm i -g @slidev/cli
```

```bash [pnpm]
pnpm i -g @slidev/cli
```

```bash [npm]
npm i -g @slidev/cli
```

```bash [yarn]
yarn global add @slidev/cli
```
Expand Down
8 changes: 4 additions & 4 deletions docs/guide/write-theme.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@ To get started, we recommend you use our generator for scaffolding your first th

::: code-group

```bash [npm]
$ npm init slidev-theme@latest
```

```bash [pnpm]
$ pnpm create slidev-theme
```

```bash [npm]
$ npm init slidev-theme@latest
```

```bash [yarn]
$ yarn create slidev-theme
```
Expand Down
4 changes: 2 additions & 2 deletions packages/create-app/template/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

To start the slide show:

- `npm install`
- `npm run dev`
- `pnpm install`
- `pnpm dev`
- visit <http://localhost:3030>

Edit the [slides.md](./slides.md) to see the changes.
Expand Down

0 comments on commit e871f43

Please sign in to comment.