Markdown options for read-only text

  • Release version: Australia
  • Updated March 12, 2026
  • 1 minute to read

    • Enable markdown formatting for ReadOnlyText components in CPQ layouts to enhance text presentation. Use syntax for bold, italics, lists, links, images, and dynamic field values to create clear, engaging, and context-aware display text in configurations.

    This article describes the markdown syntax and behaviors available to administrators when a text field is defined on a native CPQ UI layout with component display type ReadOnlyText. For a broader discussion of layout options, see CSV layout upload.

    To apply markdown formatting to a ReadOnlyText component:

    1. In the layout editor, open the field properties (button with cog icon)
    2. Add the following as the raw value: { "enableMarkdown": true }
    3. Use the following markdown syntax in the text field value.
    Table 1. Markdown formatting options
    Formatting Option Syntax Output Notes
    Bold **this will be bold** bold text A double underscore instead of the double * will also work
    Italics

    *this will be italic*

    _this will be italic_

    		 italic text A single underscore instead of the single * will also work
    Unordered List Item\r- Item\r- Item
    • Item
    • Item
    • Item
    Ordered List 1.Item\r2. Item\r3. Item
    1. Item
    2. Item
    3. Item
    Newline \n
    Link [link display text] (https://www.example.com) link display text Any JavaScript entered will be sanitized
    Image ![alt text](image url, "title text") N/A
    Table | Header1 | Header2 |\n|---|---|\n| Row1Col1 | Row1Col2 |\n| Row2Col1 | Row2Col2 |
    Header1 Header2
    Row1Col1 Row1Col2
    Row2Col1 Row2Col2

    By default, columns are left-aligned. To right-align, use ---:. To center, use :---:.

    By default, table borders are off. To add borders, add theme property Markdown-table-borderWidth: 1px.
    Dynamic Text {{fieldVariableName}} Outputs the value of the selected field in the text
    Dynamic Non- Field Text {{txn#rowNumber}}

    Outputs the value of the dynamic text based on context

    Currently, only rowNumber in a txn line is supported

    This markdown syntax is the same as that available for field help popups.

    Returning strings with Markdown

    When you return a string with Markdown, enclose the string in double quotes, especially when using escaped characters such as \n for line breaks. Using single quotes may prevent Markdown from rendering properly and can lead to unexpected results.

    For example, when the following return function is entered, it leads to the escaped characters appearing in the output:

    Incorrect use of single quotes

    Bad string appearing as a result of single quotes

    When the return function encloses the same text in double quotes, the output appears as intended:

    Correct use of double quotes

    Appropriate string appearing as a result of double quotes