verb-reflinks
Version:
Verb middleware that resolves reflinks for valid npm package names in markdown documents and appends them to the document.
83 lines (50 loc) • 4.19 kB
Markdown
# verb-reflinks [](https://www.npmjs.com/package/verb-reflinks) [](https://npmjs.org/package/verb-reflinks) [](https://npmjs.org/package/verb-reflinks) [](https://travis-ci.org/verbose/verb-reflinks)
> Verb middleware that resolves reflinks for valid npm package names in markdown documents and appends them to the document.
## Install
Install with [npm](https://www.npmjs.com/):
```sh
$ npm install --save verb-reflinks
```
**Why should I use use this?**
`verb-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.
## Usage
Use as a `.postRender` or `.preWrite` middleware.
```js
var reflinks = require('verb-reflinks');
var verb = require('verb');
var app = verb();
app.postRender(/\.md$/, reflinks());
```
**What does this do?**
* Finds reflinks like `[gulp][]` or `[gulp]`
* Resolves the `homepage` or `repository.url` from the [npm](https://www.npmjs.com) package name, if available
* Appends the resolved reflink, like `[gulp]: http://gulpjs.com`, to the markdown string if it does not already exist somewhere in the document
**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 resolved, but `[gulp][]` would.
## About
### Related projects
* [gulp-reflinks](https://www.npmjs.com/package/gulp-reflinks): Gulp plugin for `reflinks`. Lints a markdown string to find missing reflinks for npm package… [more](https://github.com/jonschlinkert/gulp-reflinks) | [homepage](https://github.com/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.")
* [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.")
* [verb](https://www.npmjs.com/package/verb): Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used… [more](https://github.com/verbose/verb) | [homepage](https://github.com/verbose/verb "Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used on hundreds of projects of all sizes to generate everything from API docs to readmes.")
### Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
### 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
```
### 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
```
### Author
**Jon Schlinkert**
* [github/jonschlinkert](https://github.com/jonschlinkert)
* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
### License
Copyright © 2017, [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.5.0, on April 04, 2017._