remark-embed-images
!Buildbuild-badgebuild
!Coveragecoverage-badgecoverage
!Downloadsdownloads-badgedownloads
!Sizesize-badgesize
!Sponsorssponsors-badgecollective
!Backersbackers-badgecollective
!Chatchat-badgechatremark plugin to embed local images as data URIs.
Contents
* [`unified().use(remarkEmbedImages)`](#unifieduseremarkembedimages)
What is this?
This package is a unified (remark) plugin that inlines images as data URIs.When should I use this?
You can use this package when you want to move markdown that references local images around more easily, because images will be inlined. This does makes the markdown quite hard to read and isn’t supported everywhere (such as GitHub), because data URIs might result in security risks.Install
This package is ESM onlyesm. In Node.js (version 16+), install with npm:npm install remark-embed-images
In Deno with
esm.sh
esmsh:import remarkEmbedImages from 'https://esm.sh/remark-embed-images@4'
In browsers with
esm.sh
esmsh:<script type="module">
import remarkEmbedImages from 'https://esm.sh/remark-embed-images@4?bundle'
</script>
Use
Say we have an imagefoo.png
file-foo-png and next to it the following
file example.md
:![A pink square](./foo.png)
…and a module
example.js
:import {remark} from 'remark'
import remarkEmbedImages from 'remark-embed-images'
import {read} from 'to-vfile'
const file = await remark()
.use(remarkEmbedImages)
.process(await read('example.md'))
console.log(String(file))
…then running
node example.js
yields:![A pink square](data:image/png;base64,iVBORw0…)
API
This package exports no identifiers. The default export isremarkEmbedImages
api-remark-embed-images.unified().use(remarkEmbedImages)
Embed local images as data URIs.Parameters
There are no options.Returns
Transform (Transformer
unified-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-embed-images@^4
,
compatible with Node.js 16.This plugin works with
unified
version 6+ and remark
version 7+.Security
Always be careful with user input. For example, it’s possible to hide JavaScript inside images (such as GIFs, WebPs, and SVGs). User provided images open you up to a cross-site scripting (XSS)wiki-xss attack.Related
— add a simpler image syntax
— remove the wrapping paragraph for images
Contribute
Seecontributing.md
contributing in remarkjs/.github
health for ways
to get started.
See support.md
support for ways to get help.This project has a code of conductcoc. By interacting with this repository, organization, or community you agree to abide by its terms.