API / @aionbuilders/nabu

deltaToMarkdown

Function Stability: stable

Converts a Loro text delta to inline Markdown. A line break (\n in the text) is exported as a markdown hard break (backslash + newline), unless rawBreaks (a block that re-reads its own lines, like a callout body, keeps the plain newline).

Related guide: Clipboard and Markdown →

Signature

TypeScript
import { deltaToMarkdown } from '@aionbuilders/nabu';
TypeScript
function deltaToMarkdown(delta: Delta<string>[], options?: object): string

Parameters

Parameters of deltaToMarkdown
ParameterTypeDefaultDescription
deltaDelta<string>[]n/an/a
optionsoptionalobject{}n/a
options.rawBreaksoptionalbooleanfalsen/a

Returns

string

Source: src/lib/behaviors/text/text.behavior.svelte.js:47