Skip to content

paragraph()

ts
function paragraph(value, options?): Node;

Defined in: paragraph.ts:82

Builder-element for a paragraph

Parameters

ParameterTypeDescription
valuestring | NodeContent of this element
options?ParagraphOptionsText styles for this paragraph

Returns

Node

A markdown node

Example

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

const markdown = define(
  paragraph("Some sentence", [ "bold", "italic" ])
);

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#paragraphs

Since

1.0.0

Author

Simon Kovtyk