remark-unwrap-images

remark plugin to remove the wrapping paragraph for images.

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
• Types
• Compatibility
• Security
• Related
• Contribute
• License

What is this?

This package is a unified (remark) plugin that searches for paragraphs which contain only images (possibly in links) and nothing else, and then remove those surrounding paragraphs.

When should I use this?

This project can make it simpler to style images with CSS, for example displaying them at the full available width, because paragraph styles no longer interfere with them.

Install

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

npm install remark-unwrap-images

In Deno with esm.sh:

import remarkUnwrapImages from 'https://esm.sh/remark-unwrap-images@4'

In browsers with esm.sh:

<script type="module">
  import remarkUnwrapImages from 'https://esm.sh/remark-unwrap-images@4?bundle'
</script>

Use

Say we have the following file example.md.

# Saturn

Saturn is the sixth planet from the Sun and the second-largest in the Solar
System, after Jupiter.

![Saturn](//upload.wikimedia.org/wikipedia/commons/thumb/c/c7/Saturn_during_Equinox.jpg/300px-Saturn_during_Equinox.jpg)

…and a module example.js:

import {unified} from 'unified'
import rehypeStringify from 'rehype-stringify'
import remarkParse from 'remark-parse'
import remarkRehype from 'remark-rehype'
import remarkUnwrapImages from 'remark-unwrap-images'
import {read} from 'to-vfile'

const file = await unified()
  .use(remarkParse)
  .use(remarkRehype)
  .use(remarkUnwrapImages)
  .use(rehypeStringify)
  .process(await read('example.md'))

console.log(String(file))

…then running node example.js yields:

<h1>Saturn</h1>
<p>Saturn is the sixth planet from the Sun and the second-largest in the Solar
System, after Jupiter.</p>
<p><img src="//upload.wikimedia.org/wikipedia/commons/thumb/c/c7/Saturn_during_Equinox.jpg/300px-Saturn_during_Equinox.jpg" alt="Saturn"></p>

API

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

unified().use(remarkUnwrapImages)

Remove the wrapping paragraph for images.

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-unwrap-images@^4, compatible with Node.js 16.

This plugin works with unified version 6+ and remark version 7+.

Security

Use of remark-unwrap-images does not involve rehype (hast) or user content, it only removes some existing nodes, so there are no openings for cross-site scripting (XSS) attacks.

Related

• remark-images — add a simpler image syntax
• remark-embed-images — embed local images as data URIs, inlining files as base64-encoded values

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 © Compositor and Vercel, Inc.