reflinks

reflinks

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 --save reflinks

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) return console.log(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.

Options

reflinksCache

Disable caching.

Type: Boolean

Default: undefined

reflinks(['base'], {reflinksCache: false}, function(err, links) {
  if (err) return console.log(err);
});

About

Related projects

• markdown-utils: Micro-utils for creating markdown snippets. | homepage
• remarkable: Markdown parser, done right. 100% Commonmark support, extensions, syntax plugins, high speed - all in… 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

• github/jonschlinkert
• twitter/jonschlinkert

License

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

This file was generated by verb, v0.9.0, on July 13, 2016.