README
plugin-links
Create markdown links from namespaced github repos.
Install
$ npm install plugin-links --save
Example
Usage
import PluginLinks from 'plugin-links';
let pluginLinks = new PluginLinks({
prefix: 'metalsmith',
fileName: 'PLUGINS',
pages: 1
});
pluginLinks.create().then((string) => {
// PLUGINS.md created
console.log(string) // - [prefix-plugin](http://github.com/plugin/plugin-name)
});
Options
- prefix {string} - namespace to search on github (required)
- fileName {string} - name of markdown file to be created (optional)
- pages {number} - amount of pages to search on github (optional)
Testing
$ npm test