@emdaer/plugin-image

An emdaer plugin that renders HTML img elements

Stats

stars ๐ŸŒŸissues โš ๏ธupdated ๐Ÿ› created ๐Ÿฃsize ๐Ÿ‹๏ธโ€โ™€๏ธ
1428Jun 17, 2021Oct 15, 2017Minified + gzip package size for @emdaer/plugin-image in KB

Readme

@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

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.