JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 292
  • Score
    100M100P100Q92287F
  • License MIT

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

Package Exports

  • verb-reflinks

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (verb-reflinks) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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
  • Appends the resolve reflink, [gulp]: http://gulpjs.com, to the markdown string if it doesn't already exist

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

  • 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 document was generated by verb-generate-readme (a verb generator), please don't edit the readme directly. Any changes to the readme must be made in .verb.md.)

To generate the readme and API documentation with verb:

$ npm install -g verb verb-generate-readme && verb

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Jon Schlinkert

License

Copyright © 2016, Jon Schlinkert. Released under the MIT license.

This file was generated by verb-generate-readme, v0.2.1, on December 29, 2016.