remark-unlink
remark plugin to remove all links, images, references, and definitions.
Contents
What is this?
This package is a unified (remark) plugin to remove all links and images.
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 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 12.20+, 14.14+, or 16.0+), install with npm:
npm install remark-unlink
In Deno with esm.sh
:
import remarkUnlink from 'https://esm.sh/remark-unlink@4'
In browsers with esm.sh
:
<script type="module">
import remarkUnlink from 'https://esm.sh/remark-unlink@4?bundle'
</script>
Use
Say we have the following file example.md
.
## TOC
- [section 1](#section-1)
- [section 2](#section-2)
## section 1
Section [content][1] may include some [links](https://domain.name/path).
[1]: https://domain.name/path
## section 2

More content.
And our module example.js
looks as follows:
import {read} from 'to-vfile'
import {remark} from 'remark'
import remarkUnlink from 'remark-unlink'
main()
async function main() {
const file = await remark()
.use(remarkUnlink)
.process(await read('example.md'))
console.log(String(file))
}
Now, running node example
yields:
## TOC
* section 1
* section 2
## section 1
Section content may include some links.
## section 2
More content.
API
This package exports no identifiers. The default export is remarkUnlink
.
unified().use(remarkUnlink)
Plugin to remove all links, images, references, and definitions. 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-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