Awesome
remark-unlink
remark plugin to remove all links, images, references, and definitions.
Contents
- What is this?
- When should I use this?
- Install
- Use
- API
- Types
- Compatibility
- Security
- Contribute
- License
What is this?
This package is a unified (remark) plugin to remove all links and images.
When should I use this?
This project is useful if you display markdown documents somewhere where links and images don’t work, such as man pages, on paper, or some ereaders.
Install
This package is ESM only. In Node.js (version 16+), install with npm:
npm install remark-unlink
In Deno with esm.sh
:
import remarkUnlink from 'https://esm.sh/remark-unlink@5'
In browsers with esm.sh
:
<script type="module">
import remarkUnlink from 'https://esm.sh/remark-unlink@5?bundle'
</script>
Use
Say we have the following file example.md
.
# Uranus
**Uranus** is the seventh [planet](/wiki/Planet "Planet") from the Sun and is a
gaseous cyan [ice giant](/wiki/Ice_giant "Ice giant").
Photograph of Uranus in true colour by Voyager 2 in 1986:
![This is an image of the planet Uranus taken by the spacecraft Voyager 2 in 1986.
The Voyager project is managed for NASA by the Jet Propulsion Laboratory.](https://en.wikipedia.org/wiki/Uranus#/media/File:Uranus_as_seen_by_NASA's_Voyager_2_(remastered)_-_JPEG_converted.jpg)
…and a module example.js
:
import {remark} from 'remark'
import remarkUnlink from 'remark-unlink'
import {read} from 'to-vfile'
const file = await remark()
.use(remarkUnlink)
.process(await read('example.md'))
console.log(String(file))
…then running node example.js
yields:
# Uranus
**Uranus** is the seventh planet from the Sun and is a
gaseous cyan ice giant.
Photograph of Uranus in true colour by Voyager 2 in 1986:
This is an image of the planet Uranus taken by the spacecraft Voyager 2 in
1986\.
The Voyager project is managed for NASA by the Jet Propulsion
Laboratory.
API
This package exports no identifiers.
The default export is remarkUnlink
.
unified().use(remarkUnlink)
Remove all links, images, references, and definitions.
Parameters
There are no parameters.
Returns
Transform (Transformer
).
Types
This package is fully typed with TypeScript. It exports no additional types.
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-unlink@^5
,
compatible with Node.js 16.
This plugin works with unified
version 3+ and remark
version 4+.
Security
Use of remark-unlink
does not involve rehype (hast) or user
content so there are no openings for cross-site scripting (XSS)
attacks.
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 © Eugene Sharygin