Skip to content

Latest commit

 

History

History

plugin-image

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 

@emdaer/plugin-image · Travis Documented with emdaer Maintained with lerna

An emdaer plugin that renders HTML img elements

Usage

@emdaer/plugin-image is an emdaer plugin – see the emdaer monorepo for more information

Documentation

Example

emdaer

Usage in README

<!--emdaer-p
  - '@emdaer/plugin-image'
  - src: hero.svg
    alt: emdaer
    align: center
-->

imagePlugin

Renders HTML img elements.

Parameters

  • options any
    • options.src string The image URL.
    • options.alt string? The alternative text describing the image.
    • options.align ("left" | "center" | "right")? The alignment of the image with respect to its surrounding context.
    • options.width string? The intrinsic width of the image in pixels.
    • options.height string? The intrinsic height of the image in pixels.

Examples

<!--emdaer-p
  - '@emdaer/plugin-image'
  - src: hero.svg
    alt: emdaer
    align: center
-->

Returns Promise<string> The image element