Awesome
helper-reflinks
Async template helper for generating a list of markdown reference links.
Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your :heart: and support.
Install
Install with npm:
$ npm install --save helper-reflinks
Usage
const reflinks = require('helper-reflinks');
Since this is an async helper, it can only registered with engines that support async helpers:
templates
Register the helper for use with templates
const templates = require('templates');
const app = templates();
app.asyncHelper('reflinks', reflinks());
assemble
To register the helper for use with assemble ^0.6.0:
const assemble = require('assemble');
const app = assemble();
app.asyncHelper('reflinks', reflinks());
verb
Register the helper for use with verb:
const verb = require('verb');
const app = verb();
app.asyncHelper('reflinks', reflinks());
app.task('default', function() {
app.src('.verb*.md')
.pipe(app.dest('./'));
});
About
<details> <summary><strong>Contributing</strong></summary>Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
</details> <details> <summary><strong>Running Tests</strong></summary>Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
$ npm install && npm test
</details>
<details>
<summary><strong>Building docs</strong></summary>
(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)
To generate the readme, run the following command:
$ npm install -g verbose/verb#dev verb-generate-readme && verb
</details>
Related projects
You might also be interested in these projects:
- handlebars-helpers: More than 130 Handlebars helpers in ~20 categories. Helpers can be used with Assemble, Generate… more | homepage
- helper-related: Template helper for generating a list of links to the homepages of related GitHub/npm projects. | homepage
- template-helpers: Generic JavaScript helpers that can be used with any template engine. Handlebars, Lo-Dash, Underscore, or… more | homepage
Contributors
Commits | Contributor |
---|---|
102 | jonschlinkert |
7 | stefanwalther |
Author
Jon Schlinkert
License
Copyright © 2018, Jon Schlinkert. Released under the MIT License.
This file was generated by verb-generate-readme, v0.6.0, on May 29, 2018.