image()

function image(source, alt?): Node;

Defined in: image.ts:27

Builder-element for an image

Parameters

Parameter	Type	Description
source	string | Node	Source of the image
alt?	string | Node	Alt-text of the image

Returns

Node

A markdown node

Example

import { define, image } from "@ogs-gmbh/markdown";

const markdown = define(
  image("https://example.com/image.png", "An example image")
);

console.assert(
  markdown.toString()
);

See

https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#images

Since

1.0.0

Author

Simon Kovtyk