# helper-reflinks
> Async template helper for generating a list of markdown reference links.
Latest version **4.0.0** (published 2018-05-30) · MIT license · 0 weekly downloads
## Install
```sh
npm install helper-reflinks
pnpm add helper-reflinks
yarn add helper-reflinks
bun add helper-reflinks
```
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 4.0.0 |
| Published | 2018-05-30 |
| First published | 2014-11-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8 |
| Dependencies | 2 |
| Unpacked size | 8.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Jon Schlinkert |
| Maintainers | jonschlinkert |
| Keywords | compile, docs, documentation, format, generate, generator, helper, helpers, link, links, markdown, md, ref, reference, reflink, reflinks, render, template, templates, verb |
## Links
- npm: https://www.npmjs.com/package/helper-reflinks
- Repository: https://github.com/helpers/helper-reflinks
- Issues: https://github.com/helpers/helper-reflinks/issues
- npm.io page: https://npm.io/package/helper-reflinks
## Dependencies (2)
- [reflinks](https://npm.io/package/reflinks.md) ^0.3.6
- [arr-union](https://npm.io/package/arr-union.md) ^3.1.0
## Alternatives
- [@mdxeditor/editor](https://npm.io/package/@mdxeditor/editor.md) — 962.4K weekly downloads
- [mmdb-lib](https://npm.io/package/mmdb-lib.md) — 680.9K weekly downloads
- [playcanvas](https://npm.io/package/playcanvas.md) — 36.2K weekly downloads
- [@glw907/cairn-cms](https://npm.io/package/@glw907/cairn-cms.md) — 967 weekly downloads
- [markdown-to-confluence](https://npm.io/package/markdown-to-confluence.md) — 103 weekly downloads
## Recent versions
- 4.0.0 (latest) — 2018-05-30
- 3.2.1 — 2016-07-13
- 3.2.0 — 2016-04-27
- 3.1.6 — 2016-04-13
- 3.1.5 — 2016-04-11
- 3.1.4 — 2016-03-17
- 3.1.3 — 2016-02-25
- 3.1.2 — 2016-02-15
- 3.1.1 — 2016-02-15
- 3.1.0 — 2016-02-12
- 3.0.3 — 2016-02-06
- 3.0.2 — 2016-02-02
- 3.0.1 — 2015-12-14
- 3.0.0 — 2015-12-14
- 2.2.1 — 2015-12-01
- … 19 more at https://npm.io/package/helper-reflinks/versions
## README
# helper-reflinks [](https://www.npmjs.com/package/helper-reflinks) [](https://npmjs.org/package/helper-reflinks) [](https://npmjs.org/package/helper-reflinks) [](https://travis-ci.org/helpers/helper-reflinks)
> Async template helper for generating a list of markdown reference links.
Please consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.
## Install
Install with [npm](https://www.npmjs.com/):
```sh
$ npm install --save helper-reflinks
```
## Usage
```js
const reflinks = require('helper-reflinks');
```
Since this is an async helper, it can only registered with engines that support async helpers:
* [assemble](#assemble)
* [templates](#templates)
* [verb](#verb)
### templates
Register the helper for use with [templates](https://github.com/jonschlinkert/templates)
```js
const templates = require('templates');
const app = templates();
app.asyncHelper('reflinks', reflinks());
```
### assemble
To register the helper for use with [assemble](https://github.com/assemble/assemble) ^0.6.0:
```js
const assemble = require('assemble');
const app = assemble();
app.asyncHelper('reflinks', reflinks());
```
### verb
Register the helper for use with [verb](https://github.com/verbose/verb):
```js
const verb = require('verb');
const app = verb();
app.asyncHelper('reflinks', reflinks());
app.task('default', function() {
app.src('.verb*.md')
.pipe(app.dest('./'));
});
```
## About
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
Running Tests
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:
```sh
$ npm install && npm test
```
Building docs
_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
To generate the readme, run the following command:
```sh
$ npm install -g verbose/verb#dev verb-generate-readme && verb
```
### Related projects
You might also be interested in these projects:
* [handlebars-helpers](https://www.npmjs.com/package/handlebars-helpers): More than 130 Handlebars helpers in ~20 categories. Helpers can be used with Assemble, Generate… [more](https://github.com/helpers/handlebars-helpers) | [homepage](https://github.com/helpers/handlebars-helpers "More than 130 Handlebars helpers in ~20 categories. Helpers can be used with Assemble, Generate, Verb, Ghost, gulp-handlebars, grunt-handlebars, consolidate, or any node.js/Handlebars project.")
* [helper-related](https://www.npmjs.com/package/helper-related): Template helper for generating a list of links to the homepages of related GitHub/npm projects. | [homepage](https://github.com/helpers/helper-related "Template helper for generating a list of links to the homepages of related GitHub/npm projects.")
* [template-helpers](https://www.npmjs.com/package/template-helpers): Generic JavaScript helpers that can be used with any template engine. Handlebars, Lo-Dash, Underscore, or… [more](https://github.com/jonschlinkert/template-helpers) | [homepage](https://github.com/jonschlinkert/template-helpers "Generic JavaScript helpers that can be used with any template engine. Handlebars, Lo-Dash, Underscore, or any engine that supports helper functions.")
### Contributors
| **Commits** | **Contributor** |
| --- | --- |
| 102 | [jonschlinkert](https://github.com/jonschlinkert) |
| 7 | [stefanwalther](https://github.com/stefanwalther) |
### Author
**Jon Schlinkert**
* [LinkedIn Profile](https://linkedin.com/in/jonschlinkert)
* [GitHub Profile](https://github.com/jonschlinkert)
* [Twitter Profile](https://twitter.com/jonschlinkert)
### License
Copyright © 2018, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT License](LICENSE).
***
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on May 29, 2018._
---
_Source: https://npm.io/package/helper-reflinks · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._