gulp-reflinks
Version:
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.
98 lines (61 loc) • 4.02 kB
Markdown
# gulp-reflinks [](https://www.npmjs.com/package/gulp-reflinks) [](https://npmjs.org/package/gulp-reflinks) [](https://npmjs.org/package/gulp-reflinks) [](https://travis-ci.org/jonschlinkert/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](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 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.
```js
var gulp = require('gulp');
var reflinks = require('gulp-reflinks');
gulp.task('default', function() {
return gulp.src('*.md')
.pipe(reflinks())
.pipe(gulp.dest('dist/'));
});
```
## About
<details>
<summary><strong>Contributing</strong></summary>
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
</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:
```sh
$ npm install && npm test
```
</details>
<details>
<summary><strong>Building docs</strong></summary>
_(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
```
</details>
### Related projects
You might also be interested in these projects:
* [helper-reflinks](https://www.npmjs.com/package/helper-reflinks): Async template helper for generating a list of markdown reference links. | [homepage](https://github.com/helpers/helper-reflinks "Async template helper for generating a list of markdown reference links.")
* [reflinks](https://www.npmjs.com/package/reflinks): Generate (relative) reference links for a glob of markdown files, allowing you to more easily… [more](https://github.com/jonschlinkert/reflinks) | [homepage](https://github.com/jonschlinkert/reflinks "Generate (relative) reference links for a glob of markdown files, allowing you to more easily create references from one file to another.")
### 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 30, 2018._