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: add more package executers #10355

Open
2 tasks done
Jay-Karia opened this issue Jul 30, 2024 · 5 comments
Open
2 tasks done

docs: add more package executers #10355

Jay-Karia opened this issue Jul 30, 2024 · 5 comments
Labels
documentation The issue is related to the documentation of Docusaurus

Comments

@Jay-Karia
Copy link

Have you 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

  • I'd be willing to address this documentation request myself.
@Jay-Karia Jay-Karia added documentation The issue is related to the documentation of Docusaurus status: needs triage This issue has not been triaged by maintainers labels Jul 30, 2024
@slorber slorber removed the status: needs triage This issue has not been triaged by maintainers label Aug 1, 2024
@slorber
Copy link
Collaborator

slorber commented Aug 1, 2024

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

@Jay-Karia
Copy link
Author

Submitted an issue for a new feautre to the plugin used.

Will work on this.

@slorber
Copy link
Collaborator

slorber commented Aug 1, 2024

Thanks, we'll track that issue: nebrelbug/npm-to-yarn#48

@dibyajyoti-mandal
Copy link

May i work on this issue?

@slorber
Copy link
Collaborator

slorber commented Oct 1, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation The issue is related to the documentation of Docusaurus
Projects
None yet
Development

No branches or pull requests

3 participants