JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 9971
  • Score
    100M100P100Q128727F
  • License MIT

Improved syntax for images in markdown

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 turn image urls into rendered images.

Installation

npm i -s remark-images

Usage

const remark = require('remark')
const images = require('remark-images')
const html = require('remark-html')

remark()
  .use(images)
  .use(html)
  .process(markdownString, function (err, file) {
    if (err) { throw err }

    console.log(String(file))
  })

Example

#### A url

Below will render an image:

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

Supported urls / uris:

  • http://example.com/image.jpg
  • /image.jpg
  • ./image.jpg
  • ../image.jpg

Supported file types:

  • png
  • svg
  • jpg
  • jpeg
  • gif