linebreak()

function linebreak(type): Node;

Defined in: linebreak.ts:43

Builder-element for a linebreak

Parameters

Parameter	Type	Description
type	LinebreakType	Type of this element

Returns

Node

A markdown node

Example

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

const markdown = define(
  paragraph("Here a leading sentence..."),
  linebreak("html"),
  paragraph("...and here the trailing one.")
);

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#line-breaks

Since

1.0.0

Author

Simon Kovtyk