henriklovhaug/md-tui - thehardwarestore.ai

── AI DEEP ANALYSIS ──

reviewed by: deepseek/deepseek-v4-flash

MD-TUI is a Rust-based terminal markdown viewer (TUI) that renders `.md` files with full keyboard navigation, syntax highlighting via tree-sitter, inline images, foldable `<details>` blocks, mermaid diagrams, table rendering, search, and link following (internal/external/wiki). It can be used as a standalone binary (`mdt`) or as a library. The architecture is monolithic but modular: a custom PEG parser (`src/md.pest`) converts markdown into a component tree (`ComponentRoot`) composed of `TextComponent` and `ImageComponent` nodes; these are rendered to the terminal using `ratatui`. Configuration is loaded from `~/.config/mdt/config.toml` or environment variables. The repository demonstrates strong Rust craftsmanship with well-separated modules, optional feature flags (`tree-sitter`, `network`), thread-local caching for syntax highlighting, and a comprehensive test suite covering parsing edge cases, search, and rendering behavior.

── METRICS ──

RATING8.5/10

QUALITY7.8/10

MAINTENANCEactive

DRIFTlow

CONTRIBUTORS25

VELOCITY0.91

OPEN ISSUES21

CLOSED ISSUES107

LAST COMMIT3 weeks ago

── TAGS ──

#markdown-viewer #tui #ratatui #tree-sitter #syntax-highlighting #cli #rust

── DEPENDENCY GRAPH ──

ratatui (cargo) 0.30.2

crossterm (cargo) 0.29.0

ratatui-image (cargo) 11.0.8

better-panic (cargo) 0.3.0

config (cargo) 0.15.25

dirs (cargo) 7.0.0

image (cargo) 0.25.10

itertools (cargo) 0.15.0

notify (cargo) 8.2.0

open (cargo) 5.4.4

pest (cargo) 2.9.1

pest_derive (cargo) 2.9.1

serde (cargo) 1.0.229

strsim (cargo) 0.11.1

unicode-width (cargo) 0.2.2

ureq (cargo) 3.4.1

tree-sitter (cargo) 0.27.0

tree-sitter-highlight (cargo) 0.27.0

tree-sitter-bash (cargo) 0.25.1

tree-sitter-c (cargo) 0.24.2

tree-sitter-cpp (cargo) 0.23.4

tree-sitter-css (cargo) 0.25.0

tree-sitter-elixir (cargo) 0.3.5

tree-sitter-go (cargo) 0.25.0

tree-sitter-html (cargo) 0.23.2

tree-sitter-java (cargo) 0.23.5

tree-sitter-javascript (cargo) 0.25.0

tree-sitter-json (cargo) 0.24.8

tree-sitter-lua (cargo) 0.5.0

tree-sitter-ocaml (cargo) 0.25.0

tree-sitter-php (cargo) 0.24.2

tree-sitter-python (cargo) 0.25.0

tree-sitter-rust (cargo) 0.24.2

tree-sitter-scala (cargo) 0.26.2

tree-sitter-typescript (cargo) 0.23.2

tree-sitter-yaml (cargo) 0.7.2

tree-sitter-diff (cargo) 0.1.0

mermaid-text (cargo) 0.57.0

── FILE BREAKDOWN ──

Files by Type (count)

Rust

25

YAML

2

Markdown

2

Lock File

2

TOML

2

Git Ignore

1

Other (no ext)

1

Other (.nix)

1

Other (.pest)

1

Files by Type (size)

Rust

250KB

Lock File

97KB

Other (no ext)

33KB

Markdown

16KB

YAML

12KB

Other (.pest)

9KB

TOML

3KB

Other (.nix)

1KB

Git Ignore

91B

── KEY FINDINGS: REUSABLE CODE ──

The LLM identified 3 files worth highlighting for reuse:

Provides a `highlight_code()` function that uses tree-sitter to tokenize and highlight source code for 20+ languages (bash, C, Python, Rust, etc.). Results are cached per-language in a thread-local `RefCell<HashMap>`, avoiding repeated `HighlightConfiguration` construction. The module exports a static `HIGHLIGHT_NAMES` array and `DEFAULT_COLOR_MAP` that can be partially overridden via config. This is a self-contained, reusable syntax highlighting service that can be extracted into any Rust TUI or CLI project needing code highlighting.

file: src/highlight/mod.rs ↗ | tags: #tree-sitter #syntax-highlighting #caching

Implements a lightweight file-position cache that saves and loads the last-viewed source line for a document, keyed by a stable 64-bit FNV-1a hash of the canonical path. Entries optionally expire after a configurable TTL (default 60 minutes). The cache is stored in the OS cache directory (`~/.cache/mdt/positions/`). This is a generic, reusable persistence utility for restoring scroll positions or bookmarks in any application.

file: src/resume.rs ↗ | tags: #cache #persistence #position-restore

Contains the `word_wrapping()` function, a pure Rust implementation that splits a sequence of `Word` tokens into lines respecting a maximum visible width (using `unicode-width`). It supports optional hyphenation with a trailing dash for long words, and handles words wider than the line width. Though part of the text rendering pipeline, the wrapping logic is isolated and could be reused in any project needing terminal-width-aware text layout.

file: src/nodes/textcomponent.rs ↗ | tags: #text-wrapping #unicode #hyphenation

── HISTORY ──

Last analyzed: 2026-09-23 22:20:10.105243

Next check: 2026-09-30 22:20:10.092847

$ show henriklovhaug/md-tui