unified

Project:remarkjs/remark-images

Package:remark-images@1.0.0

  1. Dependencies:3·Dependents:26
  2. remark plugin to add an improved image syntax
  1. remark 170
  2. unified 132
  3. plugin 88
  4. markdown 80
  5. mdast 68
  6. image 11
  7. mdx 6
  8. react 5

remark-images

Build Coverage Downloads Size Sponsors Backers Chat

remark plugin to add an improved image syntax.

Install

npm:

npm install remark-images

Use

Say we have the following file, example.md:

#### A url

Below will render an image:

https://c8r-x0.s3.amazonaws.com/lab-components-macbook.jpg

And 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)](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:

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, organisation, or community you agree to abide by its terms.

License

MIT © John Otander