docusaurus
docusaurus copied to clipboard
facebook
docs: add more package executers
Have you read the Contributing Guidelines on issues?
- [X] I have read the Contributing Guidelines on issues.
Description
In this page, the initialization of the project with typescript has the following command: npx create-docusaurus@latest my-website classic --typescript, it is using npx, we can add other package executors for yarn and pnpm.
Such as:
yarn: yarn dlx
pnpm: pnpm dlx.
Other pages with the same issue: https://docusaurus.io/docs/i18n/git#initialization https://docusaurus.io/blog/releases/3.0#query-string-data-attributes https://docusaurus.io/docs#fast-track https://docusaurus.io/docs/next/installation#scaffold-project-website
Self-service
- [X] I'd be willing to address this documentation request myself.
Yes, we could, although it's not a significant win since users can still use their preferred package manager afterward.
Also, this requires us to use tabs for package managers now, and I don't think the remark plugin we use supports npx to yarn/pnpm conversions
https://github.com/nebrelbug/npm-to-yarn
Submitted an issue for a new feautre to the plugin used.
Will work on this.
Thanks, we'll track that issue: https://github.com/nebrelbug/npm-to-yarn/issues/48
I'd prefer to work on this myself later. I'm not sure we want to present package manager tabs as a first encounter to new users. Sometimes having less choice is a feature, not a bug.
A choice implies an extra cognitive load so we should probably use this sparingly.
On their first encounter with Docusaurus, users not familiar with the Node.js ecosystem should rather not have to make any decision, and just execute commands we give them directly.