Verb middleware that resolves reflinks for valid npm package names in markdown documents and appends them to the document.


Keywords
api docs, code comments, docs, documentation, generate, generator, jsdoc, markdown, plugin, readme, reflinks, template, templates, verb, verb-generator, verbgenerator, verbplugin
License
MIT
Install
npm install verb-reflinks@1.0.0

Documentation

verb-reflinks NPM version NPM monthly downloads NPM total downloads Linux Build Status

Verb middleware that resolves reflinks for valid npm package names in markdown documents and appends them to the document.

Install

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.

Usage

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?

  • Finds reflinks like [gulp][] or [gulp]
  • Resolves the homepage or repository.url from the npm 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: Gulp plugin for reflinks. Lints a markdown string to find missing reflinks for npm package… more | homepage
  • reflinks: Generate (relative) reference links for a glob of markdown files, allowing you to more easily… more | homepage
  • verb: Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used… more | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

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

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

Author

Jon Schlinkert

License

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


This file was generated by verb-generate-readme, v0.5.0, on April 04, 2017.