https://github.com/remarkjs/remark-embed-images
plugin to embed local images as data URIs
https://github.com/remarkjs/remark-embed-images
image markdown remark remark-plugin
Last synced: 17 days ago
JSON representation
plugin to embed local images as data URIs
- Host: GitHub
- URL: https://github.com/remarkjs/remark-embed-images
- Owner: remarkjs
- License: mit
- Created: 2017-07-14T13:52:30.000Z (almost 8 years ago)
- Default Branch: main
- Last Pushed: 2024-10-22T12:37:24.000Z (8 months ago)
- Last Synced: 2025-05-09T11:51:31.056Z (about 2 months ago)
- Topics: image, markdown, remark, remark-plugin
- Language: JavaScript
- Homepage: https://remark.js.org
- Size: 240 KB
- Stars: 35
- Watchers: 9
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# remark-embed-images
[![Build][build-badge]][build]
[![Coverage][coverage-badge]][coverage]
[![Downloads][downloads-badge]][downloads]
[![Size][size-badge]][size]
[![Sponsors][sponsors-badge]][collective]
[![Backers][backers-badge]][collective]
[![Chat][chat-badge]][chat]
**[remark][]** plugin to embed local images as data URIs.
## Contents
* [What is this?](#what-is-this)
* [When should I use this?](#when-should-i-use-this)
* [Install](#install)
* [Use](#use)
* [API](#api)
* [`unified().use(remarkEmbedImages)`](#unifieduseremarkembedimages)
* [Types](#types)
* [Compatibility](#compatibility)
* [Security](#security)
* [Related](#related)
* [Contribute](#contribute)
* [License](#license)
## 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 only][esm].
In Node.js (version 18+), install with [npm][]:
```sh
npm install remark-embed-images
```
In Deno with [`esm.sh`][esmsh]:
```js
import remarkEmbedImages from 'https://esm.sh/remark-embed-images@5'
```
In browsers with [`esm.sh`][esmsh]:
```html
import remarkEmbedImages from 'https://esm.sh/remark-embed-images@5?bundle'
```
## Use
Say we have an image [`foo.png`][file-foo-png] and next to it the following
file `example.md`:
```markdown
```
…and a module `example.js`:
```js
import {remark} from 'remark'
import remarkEmbedImages from 'remark-embed-images'
import {read} from 'to-vfile'
const file = await read('example.md')
await remark()
.use(remarkEmbedImages)
.process(file)
console.log(String(file))
```
…then running `node example.js` yields:
```markdown
```
## API
This package exports no identifiers.
The default export is [`remarkEmbedImages`][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@5`,
compatible with Node.js 18.
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
* [`remarkjs/remark-images`](https://github.com/remarkjs/remark-images)
— add a simpler image syntax
* [`remarkjs/remark-unwrap-images`](https://github.com/remarkjs/remark-unwrap-images)
— remove the wrapping paragraph for images
## Contribute
See [`contributing.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 conduct][coc].
By interacting with this repository, organization, or community you agree to
abide by its terms.
## License
[MIT][license] © [David Herges][author]
[build-badge]: https://github.com/remarkjs/remark-embed-images/workflows/main/badge.svg
[build]: https://github.com/remarkjs/remark-embed-images/actions
[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-embed-images.svg
[coverage]: https://codecov.io/github/remarkjs/remark-embed-images
[downloads-badge]: https://img.shields.io/npm/dm/remark-embed-images.svg
[downloads]: https://www.npmjs.com/package/remark-embed-images
[size-badge]: https://img.shields.io/bundlejs/size/remark-embed-images
[size]: https://bundlejs.com/?q=remark-embed-images
[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
[backers-badge]: https://opencollective.com/unified/backers/badge.svg
[collective]: https://opencollective.com/unified
[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg
[chat]: https://github.com/remarkjs/remark/discussions
[npm]: https://docs.npmjs.com/cli/install
[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
[esmsh]: https://esm.sh
[health]: https://github.com/remarkjs/.github
[contributing]: https://github.com/remarkjs/.github/blob/main/contributing.md
[support]: https://github.com/remarkjs/.github/blob/main/support.md
[coc]: https://github.com/remarkjs/.github/blob/main/code-of-conduct.md
[license]: license
[author]: https://spektrakel.de
[remark]: https://github.com/remarkjs/remark
[typescript]: https://www.typescriptlang.org
[unified]: https://github.com/unifiedjs/unified
[unified-transformer]: https://github.com/unifiedjs/unified#transformer
[wiki-xss]: https://en.wikipedia.org/wiki/Cross-site_scripting
[file-foo-png]: test/fixtures/foo/foo.png
[api-remark-embed-images]: #unifieduseremarkembedimages