https://github.com/ninjasort/plugin-links

Create markdown links from namespaced github repos.
https://github.com/ninjasort/plugin-links

Last synced: 1 day ago
JSON representation

Create markdown links from namespaced github repos.

• Host: GitHub
• URL: https://github.com/ninjasort/plugin-links
• Owner: ninjasort
• License: mit
• Created: 2015-11-02T22:06:26.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2015-11-03T17:18:52.000Z (about 9 years ago)
• Last Synced: 2024-04-15T16:17:07.708Z (9 months ago)
• Language: JavaScript
• Size: 141 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# plugin-links

> Create markdown links from namespaced github repos.

## Install

```sh

$ npm install plugin-links --save

```

## Example

[Example of Metalsmith Plugins](https://github.com/cameronjroe/plugin-links/blob/master/PLUGINS.md)

## Usage

```js

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

```sh

$ npm test

```

## License

[MIT](https://github.com/cameronjroe/plugin-links/blob/master/LICENSE)