Markdown

Python-Markdown extensions that process a document and add ANSI color codes to the output.

This module provides a set of extensions for python-markdown that render markdown elements using ANSI escape codes suitable for terminal display.

class ANSIExtension(theme=None, **kwargs)

Main Python-Markdown extension that provides ANSI terminal output.

Initiate Extension and set up configs.

extendMarkdown(md)

Register the ANSI processors.

Return type:

None

class ANSIMarkdown(theme=None, **kwargs)

Markdown processor that converts markdown to ANSI formatted text. This is a convenience class that can be used in place of a markdown.Markdown instance to render markdown to ANSI formatted text suitable for terminal display.

Creates a new Markdown instance.

Keyword arguments:

• extensions: A list of extensions.

  If an item is an instance of a subclass of markdown.extension.Extension, the instance will be used as-is. If an item is of type string, first an entry point will be loaded. If that fails, the string is assumed to use Python dot notation (path.to.module:ClassName) to load a markdown.Extension subclass. If no class is specified, then a makeExtension function is called within the specified module.

• extension_configs: Configuration settings for extensions.

• output_format: Format of output. Supported formats are:

  • “xhtml”: Outputs XHTML style tags. Default.

  • “html”: Outputs HTML style tags.

• tab_length: Length of tabs in the source. Default: 4

class ANSIRenderer(theme=None)

Base ANSI renderer that provides common formatting utilities.

Initialize the ANSI renderer with a theme.

Parameters:

theme – Theme instance to use for colors. If None, uses default theme.

_calculate_column_widths(rows)

Calculate the width of each column in the table.

Return type:

List[int]

_create_table_border(col_widths, border_type)

Create a table border line (top, separator, or bottom).

Return type:

str

_format_table_cells(row, col_widths, row_idx, header_row)

Format all cells in a table row.

Return type:

List[str]

_strip_ansi(text)

Strip ANSI escape codes from text for width calculation.

Return type:

str

blockquote(text)

Format blockquote.

Return type:

str

bold(text)

Format text as bold.

Return type:

str

code_block(text, language='')

Format code block.

Return type:

str

code_inline(text)

Format inline code.

Return type:

str

format_table(rows, header_row=True)

Format a complete table with proper column alignment.

Return type:

str

header(text, level)

Format header.

Return type:

str

horizontal_rule()

Format horizontal rule.

Return type:

str

image(alt_text, url, title='')

Format image (as text representation).

Return type:

str

italic(text)

Format text as italic.

Return type:

str

link(text, url, title='')

Format link.

Return type:

str

list_item(text, ordered=False, index=1)

Format list item.

Return type:

str

strikethrough(text)

Format text as strikethrough.

Return type:

str

underline(text)

Format text as underlined.

Return type:

str

class ANSITreeProcessor(md, renderer)

Tree processor that converts HTML elements to ANSI formatted text.

_format_blockquote(elem, content)

Return type:

str

_format_bold(elem, content)

Return type:

str

_format_br(elem, content)

Return type:

str

_format_by_tag(tag, elem, content)

Format content based on HTML tag.

Return type:

str

_format_code(elem, content)

Format code - inline or block depending on parent.

Return type:

str

_format_code_block(elem, content)

Format code block element.

Return type:

str

_format_hr(elem, content)

Return type:

str

_format_image(elem, content)

Format image element.

Return type:

str

_format_italic(elem, content)

Return type:

str

_format_link(elem, content)

Format link element.

Return type:

str

_format_list_container(elem, content)

Return type:

str

_format_list_item(elem, content)

Format list item element, determining if it’s ordered or unordered.

Return type:

str

_format_paragraph(elem, content)

Return type:

str

_format_pre(elem, content)

Return type:

str

_format_strikethrough(elem, content)

Return type:

str

_format_table(elem, content)

Format entire table element with proper column alignment.

Return type:

str

_format_table_element(elem, content)

Return type:

str

_format_table_row(elem, content)

Return type:

str

_format_underline(elem, content)

Return type:

str

_is_header_tag(tag)

Check if tag is a header tag (h1-h6).

Return type:

bool

_process_element(elem)

Process a single element and its children.

Return type:

str

_set_parent_relationships(elem, parent=None)

Set parent relationships for all elements.

Return type:

None

_setup_tag_formatters()

Set up tag formatting dispatch table.

run(root)

Process the element tree and convert to ANSI text.

Return type:

None

class CodeBlockPostprocessor(md, renderer)

Postprocessor that replaces code block markers with ANSI formatted code.

Initialize the postprocessor.

Parameters:

• md – The Markdown instance

• renderer – ANSI renderer for formatting code blocks

run(text)

Replace code block markers with ANSI formatted code.

Return type:

str

Parameters:

text – The processed markdown text

Returns:

Text with code blocks rendered as ANSI

class FencedCodePreprocessor(md)

Preprocessor that handles fenced code blocks before markdown splits text into blocks.

This processor identifies fenced code blocks and stores them with unique markers, preventing markdown from processing the code content. The markers are later replaced by the tree processor.

Initialize the preprocessor.

Parameters:

md – The Markdown instance

FENCED_BLOCK_RE = re.compile('^[ \\t]*```(?P<lang>[\\w#+.-]*)[^\\n]*\\n(?P<code>.*?)^[ \\t]*```\\s*$', re.MULTILINE|re.DOTALL)

_create_code_html(code, language, marker_id)

Create a simple marker for the code block.

Return type:

str

Parameters:

• code – The code content

• language – The programming language (can be empty)

• marker_id – Unique marker ID for retrieval

Returns:

Marker string that will be replaced by postprocessor

_dedent_code(code, full_match)

Remove base indentation from code block content.

Return type:

str

Parameters:

• code – The code content

• full_match – The full matched text including fences

Returns:

Code with base indentation removed

run(lines)

Process fenced code blocks in the text.

Return type:

List[str]

Parameters:

lines – List of text lines to process

Returns:

List of processed lines with code blocks replaced by markers

markdown_to_ansi(text, theme=None, **kwargs)

Convert markdown text to ANSI formatted text.

Return type:

str

Parameters:

• text – Markdown text to convert

• theme – Theme instance to use for colors. If None, uses default theme.

• **kwargs – Additional arguments passed to markdown.markdown()

Returns:

ANSI formatted text suitable for terminal display