docs: add commands in code groups to enhance clarity and ease of use #17396
+60
−6
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added three code groups to enhance clarity and easy of use: 1. Added commands (used to scaffold inside an existing directory) in a code group. 2. Updated commands (used to specify a project name and template) in a code group. 3. Added commands (used to scaffold with a template inside an existing directory) in a code group.
|
|
bluwy
requested changes
Jun 10, 2024
Comment on lines
+98
to
116
| ::: code-group | ||
|
|
||
| ```bash [NPM] | ||
| # npm 7+, extra double-dash is needed: | ||
| npm create vite@latest my-vue-app -- --template vue | ||
| ``` | ||
|
|
||
| # yarn | ||
| ```bash [Yarn] | ||
| yarn create vite my-vue-app --template vue | ||
| ``` | ||
|
|
||
| # pnpm | ||
| ```bash [PNPM] | ||
| pnpm create vite my-vue-app --template vue | ||
| ``` | ||
|
|
||
| # bun | ||
| ```bash [Bun] | ||
| bun create vite my-vue-app --template vue | ||
| ``` | ||
|
|
There was a problem hiding this comment.
Can we keep this change only and revert the rest? I don't think the others need to be added/changed.
There was a problem hiding this comment.
Okay. That sounds good. If I see a need for any further changes, I will make a new PR.
vite (
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
The guide is missing copiable commands for: 1. Scaffolding Vite inside an existing directory, and 2. Scaffolding Vite inside an existing directory along with a template. I have added the commands neatly in code groups to reduce confusion, improve presentation, and enhance clarity.
Added commands (used to scaffold inside an existing directory) in a code group.
Updated commands (used to specify a project name and template) in a code group.
Added commands (used to scaffold with a template inside an existing directory) in a code group.