Generate (relative) reference links for a glob of markdown files, allowing you to more easily create references from one file to another.
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 :heart: and support.
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.
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.
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.
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);
});
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
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:
$ npm install && npm test
(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)
To generate the readme, run the following command:
$ npm install -g verbose/verb#dev verb-generate-readme && verb
You might also be interested in these projects:
| Commits | Contributor |
|---|---|
| 53 | jonschlinkert |
| 4 | stefanwalther |
| 2 | charlike-old |
Jon Schlinkert
Copyright © 2018, Jon Schlinkert. Released under the MIT License.
This file was generated by verb-generate-readme, v0.6.0, on May 29, 2018.
FAQs
Generate (relative) reference links for a glob of markdown files, allowing you to more easily create references from one file to another.
We found that reflinks demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Five coordinated Chrome extensions enable session hijacking and block security controls across enterprise HR and ERP platforms.
Research
Node.js patched a crash bug where AsyncLocalStorage could cause stack overflows to bypass error handlers and terminate production servers.
Research
/Security News
A malicious Chrome extension steals newly created MEXC API keys, exfiltrates them to Telegram, and enables full account takeover with trading and withdrawal rights.