JSPM

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

Generate (relative) reference links for a glob of markdown files, allowing you to more easily create references from one file to another.

Package Exports

  • 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 (reflinks) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

reflinks NPM version NPM downloads Build Status

Generate (relative) reference links for a glob of markdown files, allowing you to more easily create references from one file to another.

Install

Install with npm:

$ npm install reflinks --save

HEADS UP!

The API was completely changed in v0.2. The main export is now an async function that expects a callback, and instead of globbing local files, reflinks are created from npm package names.

Usage

var reflinks = require('reflinks');

reflinks(['base', 'verb', 'generate'], function(err, links) {
  if (err) throw err;
  console.log(links);
  // results in:
  // [ '[generate]: https://github.com/generate/generate',
  //   '[verb]: https://github.com/verbose/verb',
  //   '[base]: https://github.com/node-base/base' ]
});

By default results are cached for 7 days. See [pkg-cache][] for more details and API documentation related to caching packages.

You might also be interested in these projects:

Contributing

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

Building docs

Generate readme and API documentation with [verb][]:

$ npm install verb && npm run docs

Or, if [verb][] is installed globally:

$ 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, v0.9.0, on April 21, 2016.