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

remark-reference-links

v7.0.0

Published

remark plugin to transform links and images to references and definitions

Downloads

224,562

Readme

remark-reference-links

Build Coverage Downloads Size Sponsors Backers Chat

remark plugin to change links and images to references with separate definitions.

Contents

What is this?

This package is a unified (remark) plugin to turn links ([text](url)) and images (![alt](url)) into references ([text][id], ![alt][id]) and definitions ([id]: url).

When should I use this?

This project is useful when you want to transform markdown and prefer that it uses references and definitions. Long URLs in source code can make reading markdown difficult. References and definitions improve that by moving those URLs into definitions, outside of paragraphs.

This plugin is very similar to the alternative remark-defsplit. The difference is that that plugin generates identifiers based on hostnames of URLs and places definitions at the end of each section, whereas this plugin generates numeric identifiers at the end of the document.

A different plugin, remark-inline-links, does the inverse: turn references and definitions into links and images.

Install

This package is ESM only. In Node.js (version 16+), install with npm:

npm install remark-reference-links

In Deno with esm.sh:

import remarkReferenceLinks from 'https://esm.sh/remark-reference-links@7'

In browsers with esm.sh:

<script type="module">
  import remarkReferenceLinks from 'https://esm.sh/remark-reference-links@7?bundle'
</script>

Use

Say we have the following file example.md:

# Pluto

[![Build](https://github.com/solar-system/pluto/workflows/main/badge.svg)](https://github.com/solar-system/pluto/actions)

## History

In the 1840s,
[Urbain Le Verrier](https://wikipedia.org/wiki/Urbain_Le_Verrier) used
Newtonian mechanics to predict the position of the then-undiscovered planet
[Neptune](https://wikipedia.org/wiki/Neptune) after analyzing perturbations
in the orbit of [Uranus](https://wikipedia.org/wiki/Uranus).

And our module example.js looks as follows:

import {remark} from 'remark'
import remarkReferenceLinks from 'remark-reference-links'
import {read} from 'to-vfile'

const file = await remark()
  .use(remarkReferenceLinks)
  .process(await read('example.md'))

console.log(String(file))

…then running node example.js yields:

# Pluto

[![Build][2]][1]

## History

In the 1840s,
[Urbain Le Verrier][3] used
Newtonian mechanics to predict the position of the then-undiscovered planet
[Neptune][4] after analyzing perturbations
in the orbit of [Uranus][5].

[1]: https://github.com/solar-system/pluto/actions

[2]: https://github.com/solar-system/pluto/workflows/main/badge.svg

[3]: https://wikipedia.org/wiki/Urbain_Le_Verrier

[4]: https://wikipedia.org/wiki/Neptune

[5]: https://wikipedia.org/wiki/Uranus

👉 Note: observe that definitions are added at the end of the document and that IDs are numeric identifiers.

API

This package exports no identifiers. The default export is remarkReferenceLinks.

unified().use(remarkReferenceLinks)

Change links and images to references with separate definitions.

Parameters

There are no parameters.

Returns

Transform (Transformer).

Types

This package is fully typed with TypeScript. It exports no additional options.

Compatibility

Projects maintained by the unified collective are compatible with maintained versions of Node.js.

When we cut a new major release, we drop support for unmaintained versions of Node. This means we try to keep the current release line, remark-reference-links@^7, compatible with Node.js 16.

This plugin works with unified version 3+ and remark version 4+.

Security

Use of remark-reference-links does not involve rehype (hast) or user content so there are no openings for cross-site scripting (XSS) attacks.

Related

  • remark-defsplit — transform links and images into references and definitions with numeric IDs
  • remark-inline-links — transform references and definitions into normal links and images

Contribute

See contributing.md in remarkjs/.github for ways to get started. See support.md for ways to get help.

This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.

License

MIT © Titus Wormer