reflinks

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

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your ❤️ and support.

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

const reflinks = require('reflinks');
 
// returns a promise by default
reflinks(['micromatch', 'generate'])
  .then(res => {
    console.log(res.links);
    // results in:
    //  [ '[generate]: https://github.com/generate/generate',
    //    '[micromatch]: https://github.com/micromatch/micromatch' ]
  })
  .catch(console.error);
 
// or takes a callback
reflinks(['base', 'verb', 'generate'], function(err, res) {
  console.log(res.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

cache

Disable caching by setting options.cache to false.

Type: Boolean

Default: undefined

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

This option is also aliased as reflinksCache.

clearCache

Delete the cache by setting options.clearCache to true.

Type: Boolean

Default: undefined

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

About

$ npm install && npm test

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Related projects

You might also be interested in these 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

Contributors

Author

Jon Schlinkert

• LinkedIn Profile
• GitHub Profile
• Twitter Profile

License

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

This file was generated by verb-generate-readme, v0.6.0, on May 29, 2018.