-
-
Notifications
You must be signed in to change notification settings - Fork 2.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
.md only: npm init astro --> npm create astro #4760
Conversation
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.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we recommend @latest
too? Since npm create
always prefers the cache (for some reason). e.g. npm create astro@latest -- --template with-mdx
(The docs seem to follow this too)
Co-authored-by: Bjorn Lu <bjorn@bjornlu.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great! Thanks for making the change.
Thank you for catching that! 😅 |
Changes
For consistency with withastro/docs#360. Docs always use
npm create astro
(nevernpm 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:
packages/create-astro/CHANGELOG.md
-- skipped because changelog.packages/create-astro/test/create-astro.test.js.skipped
-- skipped, old test file disabled in Feat: [create astro] add directory prompt #3168.Q: should I run
pnpm exec changeset
for minor changes only touching *.md files? I would guess no.Testing
n/a, no code changes.
Docs
n/a, changes make README.md files consistent with docs, see above.