helper-reflinks

Async template helper for generating a list of markdown reference links.

MIT 34 个版本
compile docs documentation format generate generator helper helpers link links markdown md ref reference reflink reflinks render template templates verb
主页
仓库
提交 Issue
安装
npm install helper-reflinks
yarn add helper-reflinks
pnpm add helper-reflinks
bun add helper-reflinks
README

helper-reflinks NPM version NPM monthly downloads NPM total downloads Linux Build Status

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

Contributing

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

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:

$ npm install && npm test
Building docs

(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

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.

版本列表
4.0.0 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
2.2.0 2015-12-01
2.1.0 2015-12-01
2.0.1 2015-10-27
2.0.0 2015-10-19
1.4.2 2015-10-18
1.4.1 2015-08-01
1.4.0 2015-08-01
1.3.0 2015-04-26
1.2.3 2015-03-31
1.2.2 2015-03-31
1.2.1 2015-03-18
1.2.0 2015-03-18
1.1.0 2015-03-16
1.0.0 2015-02-03
0.4.0 2015-01-20
0.3.0 2015-01-20
0.2.0 2014-11-29
0.1.1 2014-11-12
0.1.0 2014-11-11