Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hughsk/atom-require-opener

Atom plugin for opening the currently selected require's page on npm
https://github.com/hughsk/atom-require-opener

Last synced: 7 days ago
JSON representation

Atom plugin for opening the currently selected require's page on npm

Awesome Lists containing this project

README

        

# atom-require-opener
![](http://img.shields.io/badge/stability-stable-green.svg?style=flat)

Atom plugin for selecting one or more require statements and
opening up their documentation on nodejs.org/GitHub/npm or
opening their target files.

![atom-require-opener](http://i.imgur.com/OcKso1Z.gif)

## Usage

Open the Command Palette, and run one of the following commands:

* Require Opener: Open Selection on Npm
* Require Opener: Open Selection on Github
* Require Opener: Open Selection in Atom
* Require Opener: Open Selection's README

Node.js core modules will be opened on nodejs.org's API
documentation for the two former cases, and ignored in
the latter case.

## Keybindings

To add your own keybindings for this package, simply open your
keymap file and include something along the following lines:

``` coffee
'atom-workspace':
'cmd-ctrl-shift-alt-g': 'require-opener:open-selections-on-npm'
'cmd-ctrl-shift-alt-n': 'require-opener:open-selections-on-github'
'cmd-ctrl-shift-alt-o': 'require-opener:open-selections-in-atom'
'cmd-ctrl-shift-alt-r': 'require-opener:open-selections-readmes'
```

## License

MIT. See [LICENSE.md](http://github.com/hughsk/atom-require-opener/blob/master/LICENSE.md) for details.