celestia-island/ratatui-markdown

ratatui-markdown is a Rust library for rendering markdown inside terminal user interfaces built with ratatui. If you are building a command line tool that needs to show formatted text in the terminal, such as documentation, README files, or chat messages, this library turns markdown into styled terminal output. It handles the common markdown elements: headings, lists, code blocks, blockquotes, tables, images, and inline formatting like bold, italic, and inline code. Beyond plain markdown, it can render Mermaid diagrams such as sequence, pie, gantt, and state diagrams directly from fenced code blocks, and it supports syntax highlighted code blocks using tree-sitter, with each programming language available as an optional feature so you only include what you need. The library also includes a collapsible tree viewer for exploring JSON or TOML data with expand and collapse controls and keyboard navigation, plus a hybrid scrolling system that lets users freely scroll through content or move between individual focusable items. These pieces combine into ready made widgets called MarkdownPreview and MarkdownViewer, which bundle the markdown renderer, tree view, and scrolling into a single component you can drop into an application. Styling is handled through a theme system with more than 15 color slots covering text, borders, JSON values, and popups, so the look can be customized to match an application. The library also correctly handles the width of CJK characters like Chinese, Japanese, and Korean text, and can strip TOML frontmatter from the top of a document before rendering. Most features are included by default, but they can be turned on or off individually, and the project ships several runnable examples covering basic markdown, syntax highlighting, images, Mermaid diagrams, and tree views. It requires Rust 1.74 or newer and the ratatui framework version 0.29, and is dual licensed under MIT or Apache-2.0.