marked-images v3.1.0

marked-images

Simple marked renderer to include image attributes in markdown. Also generates vimeo links.

installation

npm install marked-images

usage

NOTE: breaking changes:

• As of v2.0.0, this library uses the marked.use() plugin api.
• As of v3.0.0, since marked v4.x the marked() function is no longer the default export. CommonJS code which does marked = require(marked) should be changed to call marked.marked(<markdown-string>) instead of marked().

var marked = require('marked');

var markedImages = require('marked-images');

// opts are optional
var opts = {
  xhtml: false,
  fqImages: { route: '/images/', url:'https://images.example.com' }, // use custom image endpoint url when link starts with route
  fqLinks: 'https://www.example.com',                                // generate fully qualified links if fqImages is not set
  relPath: false
}

marked.use(markedImages(opts));

var html = marked.marked(markdown);

simple width and height

{number}x{number} in the title text part of the link in quotes after the url e.g.

![](src "1x2 title text")
or
![](src "title text 1x2")

generates:

<img src="src" alt="" width="1" height="2" title="title text">

explicit attributes

any attribute name=value, no quotes around the value e.g.

![](src "width=1 height=2 align=right title text")

generates:

<img src="src" alt="" width="1" height="2" align="right" title="title text">

CSS classnames

.{classname}

![Alt-text](src ".class1 .class-2 .class_3 10x10"

generates:

<img src="src" alt="Alt-text" width="10" height="10" class="class1 class-2 class_3">

vimeo link

start src with 'vimeo/' e.g.

![](vimeo/00000000 "500x281")

generates:

<iframe src="//player.vimeo.com/video/00000000" frameborder="0" webkitAllowFullScreen mozallowfullscreen allowFullScreen width="500" height="281"></iframe>