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

docs: expand installation.md #2071

Merged
merged 1 commit into from
Dec 15, 2023
Merged

docs: expand installation.md #2071

merged 1 commit into from
Dec 15, 2023

Conversation

skirtles-code
Copy link
Contributor

@skirtles-code skirtles-code commented Dec 6, 2023

There were a few preliminaries that I felt were missing from the Installation page. I'm not sure how many people actually read that page, but at least the extra information will be explicitly stated for anyone who does.

I imagine this page will undergo significant changes when the docs are rewritten next year, but I thought it was worth making these additions now.

  1. I've explicitly noted that VueRouter is exposed as a global object when using the global build.
  2. I've added installation instructions for pnpm, alongside npm and yarn. To keep things concise, this is wrapped in a VitePress code group, similar to how commands like these are presented in the Vite docs.
  3. I've tried to encourage newcomers to use create-vue instead.
  4. I've added a note about how to access Vue Router via ES modules. I know this seems super obvious to anyone with JS experience, but the early docs examples are currently using the CDN approach and we get a steady stream of confused people on Vue Land who don't seem to understand the relationship between the global and ESM builds.

Copy link

netlify bot commented Dec 6, 2023

Deploy Preview for vue-router ready!

Name Link
🔨 Latest commit bb6eef9
🔍 Latest deploy log https://app.netlify.com/sites/vue-router/deploys/6570b3c5ccb9c4000877d1e8
😎 Deploy Preview https://deploy-preview-2071--vue-router.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Member

@posva posva left a comment

Choose a reason for hiding this comment

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

Thanks a lot!

@posva posva merged commit 57d8727 into vuejs:main Dec 15, 2023
4 checks passed
@posva posva mentioned this pull request Dec 15, 2023
niceplugin added a commit to niceplugin/Vuejs-Router-KO that referenced this pull request Dec 16, 2023
niceplugin added a commit to niceplugin/Vuejs-Router-KO that referenced this pull request Dec 16, 2023
* docs: update custom transition example (vuejs#2069)

* docs: mention useRouter for programmatic navigation (vuejs#2070)

* docs: mp banner

* docs: expand installation.md (vuejs#2071)

* fix Custom Containers
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