npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

reflinks

v1.0.0

Published

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

Downloads

927

Readme

reflinks NPM version NPM monthly downloads NPM total downloads Linux Build Status

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

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

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

Related projects

You might also be interested in these projects:

Contributors

| Commits | Contributor | | --- | --- | | 53 | jonschlinkert | | 4 | stefanwalther | | 2 | charlike-old |

Author

Jon Schlinkert

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.