# reflinks > Generate (relative) reference links for a glob of markdown files, allowing you to more easily create references from one file to another. Latest version **1.0.0** (published 2018-05-30) · MIT license · 0 weekly downloads ## Install ```sh npm install reflinks pnpm add reflinks yarn add reflinks bun add reflinks ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.0.0 | | Published | 2018-05-30 | | First published | 2015-03-06 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Node | >=8 | | Dependencies | 6 | | Unpacked size | 10.1 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Author | Jon Schlinkert | | Maintainers | doowb, jonschlinkert | | Keywords | link, links, markdown, md, reference, reflink, reflinks | ## Links - npm: https://www.npmjs.com/package/reflinks - Repository: https://github.com/jonschlinkert/reflinks - Issues: https://github.com/jonschlinkert/reflinks/issues - npm.io page: https://npm.io/package/reflinks ## Dependencies (6) - [ora](https://npm.io/package/ora.md) ^2.1.0 - [get-pkg](https://npm.io/package/get-pkg.md) ^1.0.0 - [data-store](https://npm.io/package/data-store.md) ^3.0.0 - [date-store](https://npm.io/package/date-store.md) ^0.1.2 - [pkg-homepage](https://npm.io/package/pkg-homepage.md) ^0.1.1 - [markdown-reference](https://npm.io/package/markdown-reference.md) ^0.1.0 ## Alternatives - [@mdxeditor/editor](https://npm.io/package/@mdxeditor/editor.md) — 962.4K weekly downloads - [mmdb-lib](https://npm.io/package/mmdb-lib.md) — 680.9K weekly downloads - [playcanvas](https://npm.io/package/playcanvas.md) — 36.2K weekly downloads - [@glw907/cairn-cms](https://npm.io/package/@glw907/cairn-cms.md) — 967 weekly downloads - [markdown-to-confluence](https://npm.io/package/markdown-to-confluence.md) — 103 weekly downloads ## Recent versions - 1.0.0 (latest) — 2018-05-30 - 0.3.6 — 2018-05-29 - 0.3.5 — 2016-12-29 - 0.3.4 — 2016-07-18 - 0.3.3 — 2016-07-14 - 0.3.2 — 2016-07-13 - 0.3.1 — 2016-07-13 - 0.3.0 — 2016-07-13 - 0.2.7 — 2016-06-03 - 0.2.6 — 2016-05-03 - 0.2.5 — 2016-05-03 - 0.2.4 — 2016-04-27 - 0.2.3 — 2016-04-27 - 0.2.2 — 2016-04-22 - 0.2.1 — 2016-04-21 - … 3 more at https://npm.io/package/reflinks/versions ## README # 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
Contributing Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
Running Tests 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 ```
Building docs _(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 ```
### 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._ --- _Source: https://npm.io/package/reflinks · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._