Update npm init astro instructions to npm create astro@latest
#360
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
✅ Deploy Preview for astro-docs-2 ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
10e98f5 to
416980b
Compare
bholmesdev
commented
Apr 20, 2022
Comment on lines
-22
to
-29
| # Mit NPM | ||
| npm init astro | ||
| # Mit npm | ||
| npm create astro@latest | ||
|
|
||
| # Yarn | ||
| # yarn | ||
| yarn create astro | ||
|
|
||
| # Pnpm | ||
| pnpm create astro |
There was a problem hiding this comment.
npm and pnpm prefer to be all lowercase. Changed yarn's casing for consistency as well
bholmesdev
commented
Apr 20, 2022
| @@ -433,19 +433,19 @@ If you don't have an existing Astro site, you can create one by running: | |||
|
|
|||
| ```bash | |||
| # Make a new project directory, and navigate directly into it | |||
| $ mkdir my-astro-project && cd $_ | |||
There was a problem hiding this comment.
Remove $ for better copy-paste-ability!
|
45 files changed... 😅 |
mrienstra
pushed a commit
to mrienstra/astro
that referenced
this pull request
Sep 14, 2022
For consistency with withastro/docs#360. Docs always use `npm create astro` (never `npm init astro`), README.md files in this repo should do the same. Search: `\b(npm|yarn|pnpm) init astro\b` Replace: `$1 create astro` Except for two instances: 1. `packages/create-astro/CHANGELOG.md` -- skipped because changelog. 2. `packages/create-astro/test/create-astro.test.js.skipped` -- skipped, old test disabled in withastro#3168.
natemoo-re
pushed a commit
to withastro/astro
that referenced
this pull request
Sep 16, 2022
* .md only: npm init astro --> npm create astro For consistency with withastro/docs#360. Docs always use `npm create astro` (never `npm init astro`), README.md files in this repo should do the same. Search: `\b(npm|yarn|pnpm) init astro\b` Replace: `$1 create astro` Except for two instances: 1. `packages/create-astro/CHANGELOG.md` -- skipped because changelog. 2. `packages/create-astro/test/create-astro.test.js.skipped` -- skipped, old test disabled in #3168. * docs: add `@latest` to `npm create astro` Co-authored-by: Bjorn Lu <bjorn@bjornlu.com> Co-authored-by: Michael Rienstra <michael@goodmoney.com>
natemoo-re
pushed a commit
to natemoo-re/astro-template-minimal
that referenced
this pull request
Sep 30, 2022
* .md only: npm init astro --> npm create astro For consistency with withastro/docs#360. Docs always use `npm create astro` (never `npm init astro`), README.md files in this repo should do the same. Search: `\b(npm|yarn|pnpm) init astro\b` Replace: `$1 create astro` Except for two instances: 1. `packages/create-astro/CHANGELOG.md` -- skipped because changelog. 2. `packages/create-astro/test/create-astro.test.js.skipped` -- skipped, old test disabled in withastro/astro#3168. * docs: add `@latest` to `npm create astro` Co-authored-by: Bjorn Lu <bjorn@bjornlu.com> Co-authored-by: Michael Rienstra <michael@goodmoney.com>
mimed95
pushed a commit
to mimed95/mimed95.github.io
that referenced
this pull request
Apr 5, 2024
* .md only: npm init astro --> npm create astro For consistency with withastro/docs#360. Docs always use `npm create astro` (never `npm init astro`), README.md files in this repo should do the same. Search: `\b(npm|yarn|pnpm) init astro\b` Replace: `$1 create astro` Except for two instances: 1. `packages/create-astro/CHANGELOG.md` -- skipped because changelog. 2. `packages/create-astro/test/create-astro.test.js.skipped` -- skipped, old test disabled in withastro/astro#3168. * docs: add `@latest` to `npm create astro` Co-authored-by: Bjorn Lu <bjorn@bjornlu.com> Co-authored-by: Michael Rienstra <michael@goodmoney.com>
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.
What changed
npm init astrowithnpm create astro@latestpnpm createandyarn createinstructions where applicableMotivation
Users were getting cached versions of
create-astrowhen running without the@latestflag. Using Vite's docs as a guide, we're replacing all uses ofnpm init astrowithnpm create astro@latestacross the docs.Why
createinstead ofinit? You can runyarn createandpnpm create, but the same isn't true for "init." This should help with having consistent instructions across package managers.