Skip to content

ninjasort/plugin-links

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

plugin-links

Create markdown links from namespaced github repos.

Install

$ npm install plugin-links --save

Example

Example of Metalsmith Plugins

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

License

MIT

About

Create markdown links from namespaced github repos.

Resources

License

Stars

Watchers

Forks

Packages

No packages published