import type { Node } from "./builder.js"; /** * Union of all possible alert types * @category Builder types * * @since 1.0.0 * @author Simon Kovtyk */ type Type = "note" | "tip" | "important" | "warning" | "caution"; /** * Builder-element for an alert * @param type - Type of this element * @param value - Content of this element * @returns A markdown node * @category Builder * @example * ```ts * import { define, alert } from "@ogs-gmbh/markdown"; * * const markdown = define( * alert("important", "I like this lib") * ); * * 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#alerts * @since 1.0.0 * @author Simon Kovtyk */ declare function alert(type: Type, value: Node | string): Node; export type { Type as AlertType }; export { alert }; //# sourceMappingURL=alert.d.ts.map