Component | Markdown

Render formatted markdown.

Node.js

ui.markdown(`
    # Welcome to Markdown Example

    ## Features

    1. **Bold text** and *italic text*
    2. [Hyperlinks](https://example.com)
    3. Inline \`code\`

    ### Lists

    - Unordered list item 1
    - Unordered list item 2
    - Nested item

    > This is a blockquote.
`)

Python

ui.markdown("""
    # Welcome to Markdown Example

    ## Features

    1. **Bold text** and *italic text*
    2. [Hyperlinks](https://example.com)
    3. Inline \`code\`

    ### Lists

    - Unordered list item 1
    - Unordered list item 2
    - Nested item

    > This is a blockquote.
""")

API reference

Function signature

Node.js

ui.markdown(
    markdown: string,
    options: Partial<{
        style: Style
    }>
)

Python

ui.markdown(
    markdown: str,
    *,
    style: Style | None = None
)

Parameters

Node.js

markdown

required string

The markdown to be rendered.

Python

markdown

required str

The markdown to be rendered.

---

Node.js

properties.style

optional Style

Directly style the underlying element using CSS. See the styling guide for more details on available style properties.

Python

style

optional Style | None

Directly style the underlying element using CSS. See the styling guide for more details on available style properties.

---