Skip to content

define()

ts
function define(...nodes): DefineReturn;

Defined in: builder.ts:58

Core-API of the builder, that allows to build markdown.

Parameters

ParameterTypeDescription
...nodes(Node | null | undefined)[]Nodes, that gets represented in markdown

Returns

DefineReturn

A result of the definition

Example

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

const markdown = define(
 alert("important", "I like this lib")
);

console.assert(
  markdown.toString()
);

Since

1.0.0

Author

Simon Kovtyk