JSPM – helper-related@0.1.0

Package Exports

helper-related

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (helper-related) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Template helper for generating a list of related projects on a github repo.

Install with npm

npm i helper-related --save

Usage

This is an async helper that will only work with Template, Assemble, or Verb.

Register the helper

app.helper('related', require('helper-related'));

Use in templates

{%= related(['remarkable', 'micromatch']) %}

Results in a list that looks something like:

* [remarkable](https://github.com/jonschlinkert/remarkable): Markdown parser, done right. 100% Commonmark support, extensions, syntax plugins, high speed - all in one.
* [micromatch](https://github.com/jonschlinkert/micromatch): Glob matching for javascript/node.js. A faster alternative to minimatch (10-45x faster on avg), with all the features you're used to using in your Grunt and gulp tasks.

If the array gets long, you can format it like this if you want:

{%= related([
  'git-branch', 
  'git-repo-name', 
  'git-user-email', 
  'git-user-name', 
  'git-username', 
  'github-repo-url'
]) %}

Run tests

Install dev dependencies:

npm i -d && npm test

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue

Author

Jon Schlinkert

License

This file was generated by verb-cli on February 27, 2015.