Interface MarkupPreviewParams

Query parameters accepted by POST /rest/api/latest/markup/preview.

interface MarkupPreviewParams {
    hardwrap?: boolean;
    htmlEscape?: boolean;
    includeHeadingId?: boolean;
    urlMode?: string;
}

Properties

hardwrap?: boolean

Whether single newlines are rendered as hard line breaks

htmlEscape?: boolean

Whether HTML in the markup should be escaped

includeHeadingId?: boolean

Whether rendered headings get an id attribute

urlMode?: string

How URLs in the rendered HTML are built (e.g. 'ABSOLUTE' or 'RELATIVE'). Defaults to relative URLs.