mdsyntax 0.2.0

Render markdown with syntax highlighting in the terminal

mdsyntax

Render markdown with syntax highlighting in the terminal.

Installation

pip install mdsyntax

Usage

Python API

from mdsyntax import md_print, md_render

# Print directly to terminal
md_print("""
# Hello World

This is **bold** and *italic* text.

```python
def greet(name):
    return f"Hello, {name}!"

""")

Get ANSI string for further processing

output = md_render("Some inline code here")

### Command Line

```bash
# Render a file
mdsyntax README.md

# Pipe from stdin
echo "# Hello" | mdsyntax

# Use a different syntax theme
mdsyntax --style dracula document.md

# List available themes
mdsyntax --list-styles

Styling API

Style arbitrary text without markdown:

from mdsyntax import Style, style

# Static methods
print(Style.bold_text("important"))
print(Style.italic_text("emphasis"))
print(Style.color("warning", fg="red"))
print(Style.color("highlight", fg="white", bg="blue"))

# Chainable API
print(style("hello").bold().italic())
print(style("fancy").fg("cyan").underline())
print(style("rgb").fg((255, 100, 50)))  # RGB colors

Available styles:

• bold() / Style.bold_text()
• dim() / Style.dim_text()
• italic() / Style.italic_text()
• underline() / Style.underline_text()
• strikethrough() / Style.strike_text()
• fg(color) / bg(color) - named colors or RGB tuples

Named colors: black, red, green, yellow, blue, magenta, cyan, white

Features

• Headers (h1-h6) with color coding
• Bold, italic, bold italic
• Strikethrough
• Inline code
• Fenced code blocks with syntax highlighting
• Links
• Unordered and ordered lists
• Task lists
• Blockquotes
• Horizontal rules

Configuration

Code Styles

Any Pygments style is supported. Popular options:

• monokai (default)
• dracula
• one-dark
• gruvbox-dark
• nord
• github-dark

True Color

By default, mdsyntax auto-detects 24-bit color support via the COLORTERM environment variable. You can override this:

# Force 256-color mode
md_print(text, true_color=False)

# Force true color
md_print(text, true_color=True)

API Reference

md_print(text, *, code_style="monokai", code_width=None, true_color=None)

Print markdown to terminal.

• text: Markdown string to render
• code_style: Pygments style name for code blocks
• code_width: Fixed width for code blocks (default: terminal width)
• true_color: Use 24-bit color (default: auto-detect)

md_render(...) -> str

Same arguments as md_print, but returns the ANSI-formatted string instead of printing.

MarkdownRenderer

Dataclass for more control:

from mdsyntax import MarkdownRenderer

renderer = MarkdownRenderer(
    code_style="dracula",
    code_width=80,
    true_color=True,
)
output = renderer.render(markdown_text)

SyntaxHighlighter

Standalone code highlighter:

from mdsyntax import SyntaxHighlighter

hl = SyntaxHighlighter(style="monokai")
print(hl.highlight("print('hello')", "python"))
print(SyntaxHighlighter.available_styles())

Style / style()

Style text without markdown parsing:

from mdsyntax import Style, style

# Static (returns string directly)
Style.bold_text("text")
Style.color("text", fg="red", bg="white")

# Chainable (call str() or print directly)
style("text").bold().fg("blue")

Ansi

Direct access to ANSI escape codes:

from mdsyntax import Ansi

print(f"{Ansi.BOLD}Bold{Ansi.BOLD_OFF}")
print(f"{Ansi.FG_RED}Red{Ansi.FG_DEFAULT}")
print(f"{Ansi.rgb_fg(255, 100, 50)}RGB{Ansi.FG_DEFAULT}")

License

MIT

Contributing

Contributions are welcome! See CONTRIBUTING.md for guidelines.