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

📝 Documentation: Add an npm2yarn equivalent for installation instructions in docs site #151

Open
2 tasks done
JoshuaKGoldberg opened this issue Mar 8, 2023 · 0 comments
Labels
area: documentation Improvements or additions to docs 📝 status: accepting prs Please, send a pull request to resolve this! 🙏 type: feature New enhancement or request 🚀

Comments

@JoshuaKGoldberg
Copy link
Owner

JoshuaKGoldberg commented Mar 8, 2023

Bug Report Checklist

Overview

The three code blocks under Installation on the docs site are a lot of vertical space:

Screenshot of the three code blocks for installing in npm, yarn, and pnpm on the docs site

It'd be nice to use something like the popular @docusaurus/remark-plugin-npm2yarn to turn that into a single tabbed area. Accepting PRs!

Additional Info

An example of the npm2yarn plugin in the wild is on https://typescript-eslint.io/getting-started/#step-1-installation:

Screenshot of https://typescript-eslint.io/getting-started/#step-1-installation showing the npm and yarn installation tabs

...though npm2yarn, as its name suggests, doesn't seem to support pnpm in that tab example. Maybe a new package needs to be made? Or a configuration option added somewhere?

I haven't found any TypeDoc plugin that does this (though admittedly I haven't looked very hard). I think finding an existing plugin would be the best solution, or if one doesn't exist creating it. That way other folks can benefit from this!

@JoshuaKGoldberg JoshuaKGoldberg added area: documentation Improvements or additions to docs 📝 status: accepting prs Please, send a pull request to resolve this! 🙏 type: feature New enhancement or request 🚀 labels Mar 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: documentation Improvements or additions to docs 📝 status: accepting prs Please, send a pull request to resolve this! 🙏 type: feature New enhancement or request 🚀
Projects
None yet
Development

No branches or pull requests

1 participant