markdown

feishu.cards.markdown

escape_markdown

Python

escape_markdown(text: str) -> str

将 lark-markdown 控制字符转义为对应的 HTML 实体。

用于将任意用户或大模型生成的文本安全地嵌入卡片 2.0 的 markdown 元素中， 使其中的控制字符不会破坏渲染效果。

参数：

名称	类型	描述	默认
text	str	待转义的原始文本。	必需

返回：

类型	描述
str	所有控制字符均被替换为 HTML 实体后的文本。

飞书文档

Markdown标签

示例：

>>> escape_markdown("a*b_c")
'a*b_c'
>>> escape_markdown("~")
'∼'
>>> escape_markdown("hello world 123")
'hello world 123'

源代码位于： feishu/cards/markdown.py

def escape_markdown(text: str) -> str:
    r"""
    将 lark-markdown 控制字符转义为对应的 HTML 实体。

    用于将任意用户或大模型生成的文本安全地嵌入卡片 2.0 的 `markdown` 元素中，
    使其中的控制字符不会破坏渲染效果。

    Args:
        text: 待转义的原始文本。

    Returns:
        所有控制字符均被替换为 HTML 实体后的文本。

    飞书文档:
        [Markdown标签](https://open.feishu.cn/document/uAjLw4CM/ukzMukzMukzM/feishu-cards/card-json-v2-components/content-components/rich-text)

    Examples:
        >>> escape_markdown("a*b_c")
        'a*b_c'
        >>> escape_markdown("~")
        '∼'
        >>> escape_markdown("hello world 123")
        'hello world 123'
    """
    return text.translate(_TRANSLATION)