docs: adjust install and init commands

pull/3765/head
Divyansh Singh 3 months ago
parent 58324020c7
commit 54c46e7ceb

@ -71,8 +71,12 @@ $ npx vitepress init
$ pnpm vitepress init $ pnpm vitepress init
``` ```
```sh [yarn]
$ yarn vitepress init
```
```sh [bun] ```sh [bun]
$ bunx vitepress init $ bun vitepress init
``` ```
::: :::
@ -182,11 +186,15 @@ $ npx vitepress dev docs
``` ```
```sh [pnpm] ```sh [pnpm]
$ pnpm exec vitepress dev docs $ pnpm vitepress dev docs
```
```sh [yarn]
$ yarn vitepress dev docs
``` ```
```sh [bun] ```sh [bun]
$ bunx vitepress dev docs $ bun vitepress dev docs
``` ```
::: :::

@ -71,8 +71,12 @@ $ npx vitepress init
$ pnpm vitepress init $ pnpm vitepress init
``` ```
```sh [yarn]
$ yarn vitepress init
```
```sh [bun] ```sh [bun]
$ bunx vitepress init $ bun vitepress init
``` ```
::: :::
@ -182,11 +186,15 @@ $ npx vitepress dev docs
``` ```
```sh [pnpm] ```sh [pnpm]
$ pnpm exec vitepress dev docs $ pnpm vitepress dev docs
```
```sh [yarn]
$ yarn vitepress dev docs
``` ```
```sh [bun] ```sh [bun]
$ bunx vitepress dev docs $ bun vitepress dev docs
``` ```
::: :::

@ -71,8 +71,12 @@ $ npx vitepress init
$ pnpm vitepress init $ pnpm vitepress init
``` ```
```sh [yarn]
$ yarn vitepress init
```
```sh [bun] ```sh [bun]
$ bunx vitepress init $ bun vitepress init
``` ```
::: :::
@ -182,11 +186,15 @@ $ npx vitepress dev docs
``` ```
```sh [pnpm] ```sh [pnpm]
$ pnpm exec vitepress dev docs $ pnpm vitepress dev docs
```
```sh [yarn]
$ yarn vitepress dev docs
``` ```
```sh [bun] ```sh [bun]
$ bunx vitepress dev docs $ bun vitepress dev docs
``` ```
::: :::

@ -71,8 +71,12 @@ $ npx vitepress init
$ pnpm vitepress init $ pnpm vitepress init
``` ```
```sh [yarn]
$ yarn vitepress init
```
```sh [bun] ```sh [bun]
$ bunx vitepress init $ bun vitepress init
``` ```
::: :::
@ -182,11 +186,15 @@ $ npx vitepress dev docs
``` ```
```sh [pnpm] ```sh [pnpm]
$ pnpm exec vitepress dev docs $ pnpm vitepress dev docs
```
```sh [yarn]
$ yarn vitepress dev docs
``` ```
```sh [bun] ```sh [bun]
$ bunx vitepress dev docs $ bun vitepress dev docs
``` ```
::: :::

@ -30,9 +30,6 @@ export interface ScaffoldOptions {
const getPackageManger = () => { const getPackageManger = () => {
const name = process.env?.npm_config_user_agent || 'npm' const name = process.env?.npm_config_user_agent || 'npm'
if (name === 'npm') {
return 'npm'
}
return name.split('/')[0] return name.split('/')[0]
} }
@ -211,9 +208,9 @@ export function scaffold({
`${getPackageManger()} run docs:dev` `${getPackageManger()} run docs:dev`
)} and start writing.${tip}` )} and start writing.${tip}`
} else { } else {
const execCommand = getPackageManger() === 'bun' ? 'bunx' : 'npx' const pm = getPackageManger()
return `You're all set! Now run ${cyan( return `You're all set! Now run ${cyan(
`${execCommand} vitepress dev${dir}` `${pm === 'npm' ? 'npx' : pm} vitepress dev${dir}`
)} and start writing.${tip}` )} and start writing.${tip}`
} }
} }

Loading…
Cancel
Save