remark-inline-links
v7.0.0
Published
remark plugin to transform references and definitions into normal links and images
Downloads
49,623
Readme
remark-inline-links
remark plugin to turn references and definitions into normal links and images.
Contents
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)
).
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 16+), install with npm:
npm install remark-inline-links
In Deno with esm.sh
:
import remarkInlineLinks from 'https://esm.sh/remark-inline-links@7'
In browsers with esm.sh
:
<script type="module">
import remarkInlineLinks from 'https://esm.sh/remark-inline-links@7?bundle'
</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 a module example.js
:
import {remark} from 'remark'
import remarkInlineLinks from 'remark-inline-links'
import {read} from 'to-vfile'
const file = await remark()
.use(remarkInlineLinks)
.process(await read('example.md'))
console.log(String(file))
…then 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)
Turn references and definitions into normal links and images.
Types
This package is fully typed with TypeScript.
Parameters
There are no parameters.
Returns
Transform (Transformer
).
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-inline-links@^7
,
compatible with Node.js 16.
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 URLsremark-defsplit
— change links and images to references with separate definitions, w/ numeric IDsremark-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.