@emdaer/plugin-image ·

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

Usage in README

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

imagePlugin

• See: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img

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