remark-inline-links

remark-inline-links

remark plugin to change references and definitions into normal links and images.

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
  • unified().use(remarkInlineLinks)
• Types
• Compatibility
• Security
• Related
• Contribute
• License

What is this?

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

unified is a project that transforms content with abstract syntax trees (ASTs). remark adds support for markdown to unified. mdast is the markdown AST that remark uses. This is a remark plugin that transforms mdast.

When should I use this?

This project is useful when you want to transform markdown and prefer that it uses links and images. “Normal” links and images are well known whereas references and definitions are somewhat uncommon. Long URLs in source code can make reading markdown difficult though.

Two different plugins, remark-defsplit and remark-reference-links, do the inverse: turn links and images into references and definitions.

Install

This package is ESM only. In Node.js (version 12.20+, 14.14+, or 16.0+), install with npm:

npm install remark-inline-links

In Deno with Skypack:

import remarkInlineLinks from 'https://cdn.skypack.dev/remark-inline-links@6?dts'

In browsers with Skypack:

<script type="module">
  import remarkInlineLinks from 'https://cdn.skypack.dev/remark-inline-links@6?min'
</script>

Use

Say we have the following file example.md:

[foo], [foo][], [bar][foo].

![foo], ![foo][], ![bar][foo].

[foo]: http://example.com "Example Domain"

And our module example.js looks as follows:

import {read} from 'to-vfile'
import {remark} from 'remark'
import remarkInlineLinks from 'remark-inline-links'

main()

async function main() {
  const file = await remark()
    .use(remarkInlineLinks)
    .process(await read('example.md'))

  console.log(String(file))
}

Now running node example.js yields:

[foo](http://example.com "Example Domain"), [foo](http://example.com "Example Domain"), [bar](http://example.com "Example Domain").

![foo](http://example.com "Example Domain"), ![foo](http://example.com "Example Domain"), ![bar](http://example.com "Example Domain").

API

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

unified().use(remarkInlineLinks)

Plugin to change references and definitions into normal links and images. There are no options.

Types

This package is fully typed with TypeScript. There are no extra exported types.

Compatibility

Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, and 16.0+. Our projects sometimes work with older versions, but this is not guaranteed.

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

Security

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

Related

• remark-reference-links — change links and images to references with separate definitions, w/ IDs based on hostnames of URLs
• remark-defsplit — change links and images to references with separate definitions, w/ numeric IDs
• remark-unlink — remove all links, references, and definitions

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