Verb middleware that resolves reflinks for valid npm package names in markdown documents and appends them to the document.
npm install verb-reflinks> Verb middleware that resolves reflinks for valid npm package names in markdown documents and appends them to the document.
Install with npm:
``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.
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 or repository.url from the npm package name, if available[gulp]: http://gulpjs.com
* Appends the resolved reflink, like , 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.
* gulp-reflinks: Gulp plugin for reflinks. Lints a markdown string to find missing reflinks for npm package… more | 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."" class="text-primary hover:underline" target="_blank" rel="noopener noreferrer">homepage
* reflinks: Generate (relative) reference links for a glob of markdown files, allowing you to more easily… more | homepage reference links for a glob of markdown files, allowing you to more easily create references from one file to another.")
* verb: Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used… more | homepage
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
_(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:
`sh`
$ npm install -g verbose/verb#dev verb-generate-readme && verb
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
Jon Schlinkert
* github/jonschlinkert
* twitter/jonschlinkert
Copyright © 2017, Jon Schlinkert.
Released under the MIT License.
*
_This file was generated by verb-generate-readme, v0.5.0, on April 04, 2017._