gulp-reflinks

gulp-reflinks

Gulp plugin for reflinks. Lints a markdown string to find missing reflinks for npm package names, resolves the homepage or repository url from npm, and appends a valid reflink to the document.

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 gulp-reflinks

Usage

What does this do?

• Finds reflinks like [gulp][] or [gulp]
• Resolves the homepage or repository.url from npm
• Appends [gulp]: http://gulpjs.com to the markdown string
• Does not add (duplicate) reflinks that already exist in the document

Why should I use use this?

gulp-reflinks makes it easy to write documentation that references other libraries, by simply adding the name, like [foo][], without having to remember or write the entire URL to the GitHub repository.

Must be a valid npm name

For reflinks to be fixed, the reflink text must match the name of a valid npm package. For example [Foo Bar][] won't be fixed, but [gulp][] would.

var gulp = require('gulp');
var reflinks = require('gulp-reflinks');

gulp.task('default', function() {
  return gulp.src('*.md')
    .pipe(reflinks())
    .pipe(gulp.dest('dist/'));
});

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

Related projects

You might also be interested in these projects:

• helper-reflinks: Async template helper for generating a list of markdown reference links. | homepage
• reflinks: Generate (relative) reference links for a glob of markdown files, allowing you to more easily… more | homepage

Author

Jon Schlinkert

• LinkedIn Profile
• GitHub Profile
• Twitter Profile

License

Copyright © 2018, Jon Schlinkert. Released under the MIT License.

This file was generated by verb-generate-readme, v0.6.0, on May 30, 2018.