npm-install-block ✍️

Display commands to install npm packages using multiple package managers

Features

A GitHub Block to embed the command to install npm packages using multiple package managers in Markdown files based on the name field from a package.json file.

The following package managers are supported:

• npm
• yarn
• pnpm
• ni
• bun

Warning

GitHub Blocks is currently an experimental technical preview and may change at any time.

Planned Features

GitHub Blocks is still in early development and same goes for this GitHub Block. The following features are eventually planned:

• Support for installing development dependencies.
• Support for specifying arbitrary package manager commands.
• A copy button to copy the command to the clipboard.
• Peer dependency support with respect of the peerDependenciesMeta field.
• Theme support (the GitHub Blocks UI does not yet support themes).

Limitations

It is currently not possible to customize the options, e.g. indicating that the package should be installed as a development dependency, of the GitHub Block directly from Markdown but some sort of "instance" state allowing this kind of customization is on the roadmap.

Example

• Embedded in a README file.

License

Licensed under the MIT License, Copyright © HiDeoo.

See LICENSE for more information.