Security News
Highlights from the 2024 Rails Community Survey
A record 2,709 developers participated in the 2024 Ruby on Rails Community Survey, revealing key tools, practices, and trends shaping the Rails ecosystem.
remark-embed-images
Advanced tools
remark plugin to embed local images as data URIs.
This package is a unified (remark) plugin that inlines images as data URIs.
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.
This package is ESM only. In Node.js (version 16+), install with npm:
npm install remark-embed-images
In Deno with esm.sh
:
import remarkEmbedImages from 'https://esm.sh/remark-embed-images@4'
In browsers with esm.sh
:
<script type="module">
import remarkEmbedImages from 'https://esm.sh/remark-embed-images@4?bundle'
</script>
Say we have an image 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…)
This package exports no identifiers.
The default export is remarkEmbedImages
.
unified().use(remarkEmbedImages)
Embed local images as data URIs.
There are no options.
Transform (Transformer
).
This package is fully typed with TypeScript. It exports no additional types.
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+.
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) attack.
remarkjs/remark-images
— add a simpler image syntaxremarkjs/remark-unwrap-images
— remove the wrapping paragraph for imagesSee 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.
FAQs
remark plugin to embed local images as data URIs
The npm package remark-embed-images receives a total of 4,656 weekly downloads. As such, remark-embed-images popularity was classified as popular.
We found that remark-embed-images demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
A record 2,709 developers participated in the 2024 Ruby on Rails Community Survey, revealing key tools, practices, and trends shaping the Rails ecosystem.
Security News
In 2023, data breaches surged 78% from zero-day and supply chain attacks, but developers are still buried under alerts that are unable to prevent these threats.
Security News
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.