import type { Node } from "./builder.js"; /** * Text styles for paragraph * @category Builder types * * @since 1.0.0 * @author Simon Kovtyk */ type TextStyle = "bold" | "boldAlt" | "italic" | "italicAlt" | "strikethrough" | "strikethroughAlt" | "allBoldAndItalic" | "subscript" | "superscript" | "underline"; /** * Options for paragraph * @category Builder types * * @since 1.0.0 * @author Simon Kovtyk */ type Options = TextStyle[]; /** * Builder-element for a paragraph * @param value - Content of this element * @param options - Text styles for this paragraph * @returns A markdown node * @category Builder * @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 */ declare function paragraph(value: Node | string, options?: Options): Node; export type { TextStyle as ParagraphTextStyle, Options as ParagraphOptions }; export { paragraph }; //# sourceMappingURL=paragraph.d.ts.map