Skip to content
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

Update vite-plugin-docs getting-started with crxjs install step #960

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

swkidd
Copy link

@swkidd swkidd commented Dec 20, 2024

Ticket

#955
#952

What

Add

npm install --save-dev @crxjs/vite-plugin

as an install step for react, vanilla-js and vue

Copy link

changeset-bot bot commented Dec 20, 2024

🦋 Changeset detected

Latest commit: 9b57aa3

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
vite-plugin-docs Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link

vercel bot commented Dec 20, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
vite-plugin-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 23, 2024 2:17am

@swkidd
Copy link
Author

swkidd commented Dec 20, 2024

Should npm install --save-dev @crxjs/vite-plugin@beta be used instead? If so I guess the docs need to be updated to reflect that 'type: module' needs to be added a project'spackage.json file for it run correctly. It mentions this in the vue docs but not react or vanilla js

Copy link
Contributor

@jacksteamdev jacksteamdev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@swkidd I agree about adding @beta to the install commands, I've popped those changes in as suggestions.

updated to reflect that 'type: module' needs to be added a project'spackage.json file for it run correctly

That would be great!

@swkidd
Copy link
Author

swkidd commented Dec 23, 2024

@jacksteamdev I've updated the PR with the package.json "type": "module" tip

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants