https://github.com/hideoo/npm-install-block

GitHub Block to display commands to install npm packages using multiple package managers in Markdown files in GitHub
https://github.com/hideoo/npm-install-block

blocks github github-blocks manager npm package

Last synced: over 1 year ago
JSON representation

GitHub Block to display commands to install npm packages using multiple package managers in Markdown files in GitHub

• Host: GitHub
• URL: https://github.com/hideoo/npm-install-block
• Owner: HiDeoo
• License: mit
• Created: 2023-02-17T09:59:21.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-04-25T12:42:37.000Z (about 3 years ago)
• Last Synced: 2025-02-28T05:47:59.409Z (over 1 year ago)
• Topics: blocks, github, github-blocks, manager, npm, package
• Language: TypeScript
• Homepage:
• Size: 84 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


  
npm-install-block ✍️

  
Display commands to install npm packages using multiple package managers





  

    

  

  

    

  

  




## Features

A [GitHub Block](https://blocks.githubnext.com) 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](https://docs.npmjs.com/cli)

- [yarn](https://yarnpkg.com)

- [pnpm](https://pnpm.io)

- [ni](https://github.com/antfu/ni)

- [bun](https://bun.sh)

> **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.](https://blocks.githubnext.com/HiDeoo/npm-install-block/blob/main/examples/README.md)

![Embedded in a README file.](https://user-images.githubusercontent.com/494699/220434780-86f4551d-2ccb-4b6f-b044-6d96dce09abb.png)

## License

Licensed under the MIT License, Copyright © HiDeoo.

See [LICENSE](https://github.com/HiDeoo/npm-install-block/blob/main/LICENSE) for more information.