rich.markdown

class rich.markdown.BlockQuote

一个块引用。

on_child_close(context, child)

当子元素关闭时调用。

此方法允许父元素接管其子元素的渲染。

参数

• context (MarkdownContext) – Markdown 上下文。

• child (MarkdownElement) – 子 Markdown 元素。

返回值

如果要渲染元素，则返回 True；如果不要渲染元素，则返回 False。

返回类型

bool

class rich.markdown.CodeBlock(lexer_name, theme)

带语法高亮的代码块。

参数

• lexer_name (str) –

• theme (str) –

classmethod create(markdown, token)

用于创建 Markdown 元素的工厂。

参数

• markdown (Markdown) – 父 Markdown 对象。

• token (Token) – 来自 markdown-it 的节点。

返回值

一个新的 Markdown 元素

返回类型

MarkdownElement

class rich.markdown.Heading(tag)

一个标题。

参数

tag (str) –

classmethod create(markdown, token)

用于创建 Markdown 元素的工厂。

参数

• markdown (Markdown) – 父 Markdown 对象。

• token (Token) – 来自 markdown-it 的节点。

返回值

一个新的 Markdown 元素

返回类型

MarkdownElement

on_enter(context)

当进入节点时调用。

参数

context (MarkdownContext) – Markdown 上下文。

返回类型

无

class rich.markdown.HorizontalRule

用于分隔部分的水平规则。

class rich.markdown.ImageItem(destination, hyperlinks)

渲染图像的占位符。

参数

• destination (str) –

• hyperlinks (bool) –

classmethod create(markdown, token)

用于创建 Markdown 元素的工厂。

参数

• markdown (Markdown) – 父 Markdown 对象。

• token (Any) – 来自 markdown-it 的令牌。

返回值

一个新的 Markdown 元素

返回类型

MarkdownElement

on_enter(context)

当进入节点时调用。

参数

context (MarkdownContext) – Markdown 上下文。

返回类型

无

class rich.markdown.Link(text, href)

参数

• text (str) –

• href (str) –

classmethod create(markdown, token)

用于创建 Markdown 元素的工厂。

参数

• markdown (Markdown) – 父 Markdown 对象。

• token (Token) – 来自 markdown-it 的节点。

返回值

一个新的 Markdown 元素

返回类型

MarkdownElement

class rich.markdown.ListElement(list_type, list_start)

一个列表元素。

参数

• list_type (str) –

• list_start (int | None) –

classmethod create(markdown, token)

用于创建 Markdown 元素的工厂。

参数

• markdown (Markdown) – 父 Markdown 对象。

• token (Token) – 来自 markdown-it 的节点。

返回值

一个新的 Markdown 元素

返回类型

MarkdownElement

on_child_close(context, child)

当子元素关闭时调用。

此方法允许父元素接管其子元素的渲染。

参数

• context (MarkdownContext) – Markdown 上下文。

• child (MarkdownElement) – 子 Markdown 元素。

返回值

如果要渲染元素，则返回 True；如果不要渲染元素，则返回 False。

返回类型

bool

class rich.markdown.ListItem

列表中的一个项目。

on_child_close(context, child)

当子元素关闭时调用。

此方法允许父元素接管其子元素的渲染。

参数

• context (MarkdownContext) – Markdown 上下文。

• child (MarkdownElement) – 子 Markdown 元素。

返回值

如果要渲染元素，则返回 True；如果不要渲染元素，则返回 False。

返回类型

bool

class rich.markdown.Markdown(markup, code_theme='monokai', justify=None, style='none', hyperlinks=True, inline_code_lexer=None, inline_code_theme=None)

Markdown 可渲染对象。

参数

• markup (str) – 包含 Markdown 的字符串。

• code_theme (str, optional) – 代码块的 Pygments 主题。默认值为 “monokai”。

• justify (JustifyMethod, optional) – 段落的对齐方式。默认值为 None。

• style (Union[str, Style], optional) – 可选的样式，应用于 Markdown。

• hyperlinks (bool, optional) – 启用超链接。默认值为 True。

• inline_code_lexer (Optional[str]) – (str, optional): 如果启用了内联代码高亮显示，则要使用的词法分析器。默认值为 None。

• inline_code_theme (Optional[str]) – (Optional[str], optional): 内联代码高亮显示的 Pygments 主题，或 None 表示不进行高亮显示。默认值为 None。

class rich.markdown.MarkdownContext(console, options, style, inline_code_lexer=None, inline_code_theme='monokai')

管理控制台渲染状态。

参数

• console (Console) –

• options (ConsoleOptions) –

• style (Style) –

• inline_code_lexer (Optional[str]) –

• inline_code_theme (str) –

property current_style: Style

当前样式，它是堆栈中所有样式的乘积。

enter_style(style_name)

进入样式上下文。

参数

style_name (Union[str, Style]) –

返回类型

样式

leave_style()

离开样式上下文。

返回类型

样式

on_text(text, node_type)

解析器访问文本时调用。

参数

• text (str) –

• node_type (str) –

返回类型

无

class rich.markdown.Paragraph(justify)

段落。

参数

justify (typing_extensions.Literal[default, left, center, right, full]) –

classmethod create(markdown, token)

用于创建 Markdown 元素的工厂。

参数

• markdown (Markdown) – 父 Markdown 对象。

• token (Token) – 来自 markdown-it 的节点。

返回值

一个新的 Markdown 元素

返回类型

MarkdownElement

class rich.markdown.TableBodyElement

对应于 tbody_open 和 tbody_close 的 MarkdownElement。

on_child_close(context, child)

当子元素关闭时调用。

此方法允许父元素接管其子元素的渲染。

参数

• context (MarkdownContext) – Markdown 上下文。

• child (MarkdownElement) – 子 Markdown 元素。

返回值

如果要渲染元素，则返回 True；如果不要渲染元素，则返回 False。

返回类型

bool

class rich.markdown.TableDataElement(justify)

对应于 td_open 和 td_close 以及 th_open 和 th_close 的 MarkdownElement。

参数

justify (JustifyMethod) –

classmethod create(markdown, token)

用于创建 Markdown 元素的工厂。

参数

• markdown (Markdown) – 父 Markdown 对象。

• token (Token) – 来自 markdown-it 的节点。

返回值

一个新的 Markdown 元素

返回类型

MarkdownElement

on_text(context, text)

解析文本时调用。

参数

• context (MarkdownContext) – Markdown 上下文。

• text (Union[str, Text]) –

返回类型

无

class rich.markdown.TableElement

对应于 table_open 的 MarkdownElement。

on_child_close(context, child)

当子元素关闭时调用。

此方法允许父元素接管其子元素的渲染。

参数

• context (MarkdownContext) – Markdown 上下文。

• child (MarkdownElement) – 子 Markdown 元素。

返回值

如果要渲染元素，则返回 True；如果不要渲染元素，则返回 False。

返回类型

bool

class rich.markdown.TableHeaderElement

对应于 thead_open 和 thead_close 的 MarkdownElement。

on_child_close(context, child)

当子元素关闭时调用。

此方法允许父元素接管其子元素的渲染。

参数

• context (MarkdownContext) – Markdown 上下文。

• child (MarkdownElement) – 子 Markdown 元素。

返回值

如果要渲染元素，则返回 True；如果不要渲染元素，则返回 False。

返回类型

bool

class rich.markdown.TableRowElement

对应于 tr_open 和 tr_close 的 MarkdownElement。

on_child_close(context, child)

当子元素关闭时调用。

此方法允许父元素接管其子元素的渲染。

参数

• context (MarkdownContext) – Markdown 上下文。

• child (MarkdownElement) – 子 Markdown 元素。

返回值

如果要渲染元素，则返回 True；如果不要渲染元素，则返回 False。

返回类型

bool

class rich.markdown.TextElement

渲染文本的元素的基类。

on_enter(context)

当进入节点时调用。

参数

context (MarkdownContext) – Markdown 上下文。

返回类型

无

on_leave(context)

解析器离开元素时调用。

参数

context (MarkdownContext) – [描述]

返回类型

无

on_text(context, text)

解析文本时调用。

参数

• context (MarkdownContext) – Markdown 上下文。

• text (Union[str, Text]) –

返回类型

无

class rich.markdown.UnknownElement

未知元素。

希望不会有未知元素，并且我们将为文档中的所有内容提供 MarkdownElement。