Skip to content

Function: documentToMarkdown() ​

ts
function documentToMarkdown(documentData, options?): string;

Defined in: application/services/transformers/document-to-markdown.ts:696

Renders document data as Markdown: a title heading, the description, then the remaining fields as sections, ordered by the profile schema when one is given. Labels come from fieldLabels, the type library and the schema; values are shown in the preferred language. Ends with the SideDoc attribution footer unless omitAttributionFooter is set.

Parameters ​

ParameterType
documentDataany
options?DocumentTransformOptions

Returns ​

string