Package Exports
- remark-images
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (remark-images) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
remark-images
remark plugin to add an improved image syntax.
Install
npm:
npm install remark-imagesUse
Say we have the following file, example.md:
#### A url
Below will render an image:
https://c8r-x0.s3.amazonaws.com/lab-components-macbook.jpgAnd our script, example.js, looks as follows:
const vfile = require('to-vfile')
const remark = require('remark')
const images = require('remark-images')
remark()
.use(images)
.process(vfile.readSync('example.md'), function(err, file) {
if (err) throw err
console.log(String(file))
})Now, running node example yields:
#### A url
Below will render an image:
[](https://c8r-x0.s3.amazonaws.com/lab-components-macbook.jpg)API
remark().use(images)
Add an improved image syntax.
Transform URLs in text that reference images (png, svg, jpg, jpeg, or
gif) to images.
Supported URLs / URIs:
https://example.com/image.jpg/image.jpg./image.jpg../image.jpg
Security
Although this plugin should be safe to use, 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.
This may become a problem if the Markdown later transformed to rehype (hast) or opened in an unsafe Markdown viewer.
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.