@emdaer/plugin-list ·

An emdaer plugin that renders HTML list element.

Usage

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

Documentation

Example

1. Item one
2. Item two
3. Item three

Usage in README

<!--emdaer-p
  - '@emdaer/plugin-list'
  - type: ol
    items:
      - Item one
      - Item two
      - Item three
-->

An emdaer plugin that renders HTML list element.

listPlugin

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

Render HTML list elements.

Parameters

• options any
  • options.type ("ol" | "ul")? The type of list; ol (ordered) and ul (unordered).
  • options.items Array<string>? The list items; each will be rendered as an li element.

Examples

<!--emdaer-p
  - '@emdaer/plugin-list'
  - type: ol
    items:
      - Item one
      - Item two
      - Item three
-->

Returns Promise<string> The list HTML element.