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): インラインコードのハイライトが有効な場合に使用するlexer。デフォルトは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が存在します。