reflinks/README.md

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

# reflinks [![NPM version](https://img.shields.io/npm/v/reflinks.svg?style=flat)](https://www.npmjs.com/package/reflinks) [![NPM monthly downloads](https://img.shields.io/npm/dm/reflinks.svg?style=flat)](https://npmjs.org/package/reflinks) [![NPM total downloads](https://img.shields.io/npm/dt/reflinks.svg?style=flat)](https://npmjs.org/package/reflinks) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/reflinks.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/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](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.

## Install

Install with [npm](https://www.npmjs.com/):

```sh
$ 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

```js
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](https://github.com/jonschlinkert/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`

```js
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`

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

## About

<details>
<summary><strong>Contributing</strong></summary>

Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).

</details>

<details>
<summary><strong>Running Tests</strong></summary>

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:

```sh
$ npm install && npm test
```

</details>

<details>
<summary><strong>Building docs</strong></summary>

_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_

To generate the readme, run the following command:

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

</details>

### Related projects

You might also be interested in these projects:

* [markdown-utils](https://www.npmjs.com/package/markdown-utils): Micro-utils for creating markdown snippets. | [homepage](https://github.com/jonschlinkert/markdown-utils "Micro-utils for creating markdown snippets.")
* [remarkable](https://www.npmjs.com/package/remarkable): Markdown parser, done right. 100% Commonmark support, extensions, syntax plugins, high speed - all in… [more](https://github.com/jonschlinkert/remarkable) | [homepage](https://github.com/jonschlinkert/remarkable "Markdown parser, done right. 100% Commonmark support, extensions, syntax plugins, high speed - all in one.")

### Contributors

| **Commits** | **Contributor** | 
| --- | --- |
| 53 | [jonschlinkert](https://github.com/jonschlinkert) |
| 4 | [stefanwalther](https://github.com/stefanwalther) |
| 2 | [charlike-old](https://github.com/charlike-old) |

### Author

**Jon Schlinkert**

* [LinkedIn Profile](https://linkedin.com/in/jonschlinkert)
* [GitHub Profile](https://github.com/jonschlinkert)
* [Twitter Profile](https://twitter.com/jonschlinkert)

### License

Copyright © 2018, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT License](LICENSE).

***

_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on May 29, 2018._