verb-reflinks
Advanced tools
Verb middleware that resolves reflinks for valid npm package names in markdown documents and appends them to the document.
Verb middleware that resolves reflinks for valid npm package names in markdown documents and appends them to the document.
Install with npm:
$ 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.
var reflinks = require('verb-reflinks');
var verb = require('verb');
var app = verb();
app.postRender(/\.md$/, reflinks());
What does this do?
[gulp][] or [gulp]homepage or repository.url from the npm package name, if available[gulp]: http://gulpjs.com, to the markdown string if it does not already exist somewhere in the documentMust 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.
reflinks. Lints a markdown string to find missing reflinks for npm package… more | homepagePull 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:
$ 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:
$ npm install && npm test
Jon Schlinkert
Copyright © 2017, Jon Schlinkert. Released under the MIT License.
This file was generated by verb-generate-readme, v0.5.0, on April 04, 2017.
FAQs
Verb middleware that resolves reflinks for valid npm package names in markdown documents and appends them to the document.
We found that verb-reflinks demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Five coordinated Chrome extensions enable session hijacking and block security controls across enterprise HR and ERP platforms.
Research
Node.js patched a crash bug where AsyncLocalStorage could cause stack overflows to bypass error handlers and terminate production servers.
Research
/Security News
A malicious Chrome extension steals newly created MEXC API keys, exfiltrates them to Telegram, and enables full account takeover with trading and withdrawal rights.