tmp

Terminal Markdown Preview

Preview markdown in your terminal — with Mermaid diagrams, math, and syntax highlighting.

Built with Rust. Pure terminal. No browser.

Install

cargo install tmdp

Usage

tmp README.md

That's it. Auto-detects your terminal and picks the best rendering mode.

Features

Dual rendering modes

Syntax highlighting

15 languages via tree-sitter:

fn main() {
    let numbers: Vec<i32> = (1..=10).filter(|n| n % 2 == 0).collect();
    for n in &numbers {
        println!("{n}");
    }
}

@dataclass
class Point:
    x: float
    y: float

    def distance(self, other: "Point") -> float:
        return ((self.x - other.x) ** 2 + (self.y - other.y) ** 2) ** 0.5

async function fetchUser(id: string): Promise<User> {
  const res = await fetch(`/api/users/${id}`);
  return res.json();
}

Supported: Rust, Python, TypeScript, JavaScript, Go, C, C++, Java, Bash, JSON, YAML, CSS, HTML, TOML.

Mermaid diagrams

Rendered pixel-perfect via pure Rust (mermaid-rs-renderer + resvg). No Node.js required.

flowchart TD
    A[Markdown File] --> B{Comrak Parser}
    B --> C[Text / Headings]
    B --> D[Code Blocks]
    B --> E[Mermaid Blocks]
    B --> F[Math Blocks]
    C --> G[Styled Text]
    D --> H[Tree-sitter Highlight]
    E --> I[SVG → PNG → Image Protocol]
    F --> J[Unicode Math]
    G --> K[Terminal]
    H --> K
    I --> K
    J --> K

sequenceDiagram
    participant User
    participant tmp
    participant File

    User->>tmp: tmp README.md
    tmp->>File: Read + watch
    tmp->>tmp: Parse & render
    File-->>tmp: File changed
    tmp->>tmp: Re-render

Math equations

LaTeX to Unicode symbol conversion:

Inline: $E = mc^2$, $\alpha + \beta = \gamma$

$$ \int_{-\infty}^{{\infty} e}{-x^2} dx = \sqrt{\pi} $$

$$ \sum_{i=1}^{{n} i}2 = \frac{n(n+1)(2n+1)}{6} $$

Tables

And more

• Headings with # prefix and visual hierarchy
• Bold, italic, strikethrough, inline code
• Hyperlinks (OSC 8 clickable)
• Blockquotes with styled background
• Lists with bullet points
• Horizontal rules
• Live reload on file save

Performance

• Mermaid diagrams render in parallel threads
• Results cached by source hash — unchanged diagrams skip rendering on reload
• Font database loaded once via LazyLock
• Kitty images cached by content hash — zero I/O after first frame
• zlib-compressed Kitty transmission (kitty-compress)

Architecture

Known limitations

• Math: Unicode approximation — complex nested expressions may not render perfectly
• Mermaid: depends on mermaid-rs-renderer 0.2.x — some diagram types have minor quirks
• Cat mode: re-renders entire document on file change

License

MIT