rich.markdown

class rich.markdown.BlockQuote

一句区块引语。

on_child_close(context, child)

当子元素关闭时调用。

此方法允许父元素接管其子元素的呈现。

参数

• context (MarkdownContext) -- 降价上下文。

• 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的节点。

返回

一个新的降价元素

返回类型

MarkdownElement

class rich.markdown.Heading(tag)

一个标题。

参数

tag (str) --

classmethod create(markdown, token)

工厂来创建Markdown元素，

参数

• markdown (Markdown) -- 父Markdown对象。

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

返回

一个新的降价元素

返回类型

MarkdownElement

on_enter(context)

在进入节点时调用。

参数

context (MarkdownContext) -- 降价上下文。

返回类型

None

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的代币。

返回

一个新的降价元素

返回类型

MarkdownElement

on_enter(context)

在进入节点时调用。

参数

context (MarkdownContext) -- 降价上下文。

返回类型

None

class rich.markdown.Link(text, href)

参数

• text (str) --

• href (str) --

classmethod create(markdown, token)

工厂来创建Markdown元素，

参数

• markdown (Markdown) -- 父Markdown对象。

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

返回

一个新的降价元素

返回类型

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的节点。

返回

一个新的降价元素

返回类型

MarkdownElement

on_child_close(context, child)

当子元素关闭时调用。

此方法允许父元素接管其子元素的呈现。

参数

• context (MarkdownContext) -- 降价上下文。

• child (MarkdownElement) -- 该子markdown元素。

返回

返回True以呈现元素，或返回False以不呈现元素。

返回类型

bool

class rich.markdown.ListItem

列表中的一项。

on_child_close(context, child)

当子元素关闭时调用。

此方法允许父元素接管其子元素的呈现。

参数

• context (MarkdownContext) -- 降价上下文。

• 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)

可渲染的降价显示。

参数

• markup (str) -- 包含标记的字符串。

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

• justify (JustifyMethod, optional) -- 调整段落的价值。默认为无。

• style (Union[str, Style], optional) -- 应用于降价的可选样式。

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

• inline_code_lexer (Optional[str]) -- (str，可选)：启用内联代码突出显示时使用的词法分析器。默认为无。

• inline_code_theme (Optional[str]) -- (可选 [str] ，可选)：用于内联代码突出显示的Pygments主题，或用于不突出显示的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]) --

返回类型

Style

leave_style()

留下一个风格的背景。

返回类型

Style

on_text(text, node_type)

在分析器访问文本时调用。

参数

• text (str) --

• node_type (str) --

返回类型

None

class rich.markdown.Paragraph(justify)

一段话。

参数

justify (Literal['default', 'left', 'center', 'right', 'full']) --

classmethod create(markdown, token)

工厂来创建Markdown元素，

参数

• markdown (Markdown) -- 父Markdown对象。

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

返回

一个新的降价元素

返回类型

MarkdownElement

class rich.markdown.TableBodyElement

对应于的Markdown Element tbody_open 和 tbody_close 。

on_child_close(context, child)

当子元素关闭时调用。

此方法允许父元素接管其子元素的呈现。

参数

• context (MarkdownContext) -- 降价上下文。

• child (MarkdownElement) -- 该子markdown元素。

返回

返回True以呈现元素，或返回False以不呈现元素。

返回类型

bool

class rich.markdown.TableDataElement(justify)

对应于的Markdown Element td_open 和 td_close 和 th_open 和 th_close 。

参数

justify (JustifyMethod) --

classmethod create(markdown, token)

工厂来创建Markdown元素，

参数

• markdown (Markdown) -- 父Markdown对象。

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

返回

一个新的降价元素

返回类型

MarkdownElement

on_text(context, text)

在分析文本时调用。

参数

• context (MarkdownContext) -- 降价上下文。

• text (Union[str, Text]) --

返回类型

None

class rich.markdown.TableElement

对应于的Markdown Element table_open 。

on_child_close(context, child)

当子元素关闭时调用。

此方法允许父元素接管其子元素的呈现。

参数

• context (MarkdownContext) -- 降价上下文。

• child (MarkdownElement) -- 该子markdown元素。

返回

返回True以呈现元素，或返回False以不呈现元素。

返回类型

bool

class rich.markdown.TableHeaderElement

对应于的Markdown Element thead_open 和 thead_close 。

on_child_close(context, child)

当子元素关闭时调用。

此方法允许父元素接管其子元素的呈现。

参数

• context (MarkdownContext) -- 降价上下文。

• child (MarkdownElement) -- 该子markdown元素。

返回

返回True以呈现元素，或返回False以不呈现元素。

返回类型

bool

class rich.markdown.TableRowElement

对应于的Markdown Element tr_open 和 tr_close 。

on_child_close(context, child)

当子元素关闭时调用。

此方法允许父元素接管其子元素的呈现。

参数

• context (MarkdownContext) -- 降价上下文。

• child (MarkdownElement) -- 该子markdown元素。

返回

返回True以呈现元素，或返回False以不呈现元素。

返回类型

bool

class rich.markdown.TextElement

呈现文本的元素的基类。

on_enter(context)

在进入节点时调用。

参数

context (MarkdownContext) -- 降价上下文。

返回类型

None

on_leave(context)

在分析器离开元素时调用。

参数

context (MarkdownContext) -- [description]

返回类型

None

on_text(context, text)

在分析文本时调用。

参数

• context (MarkdownContext) -- 降价上下文。

• text (Union[str, Text]) --

返回类型

None

class rich.markdown.UnknownElement

一个未知的元素。

希望不会有未知的元素，并且我们将拥有文档中所有内容的Markdown Element。