Crate the_other_tui_markdown 

Convert Markdown text into ratatui_core::text::Text for display in a TUI.

Overview

This crate parses Markdown with pulldown_cmark and maps every element to styled ratatui_core::text::Spans and ratatui_core::text::Lines, producing a self-contained ratatui_core::text::Text<'static> ready to hand to a ratatui Paragraph widget (or any other widget that accepts Text).

Quick start

use the_other_tui_markdown::into_text;

let text = into_text("# Hello\n\nSome **bold** and _italic_ text.");
// `text` is a `ratatui_core::text::Text<'static>` ready to render.

Theming

Every Markdown element has a corresponding [Style] field on Theme. All defaults are based on the 16-colour ANSI palette (no true-colour required). Override what you need:

use the_other_tui_markdown::{RendererBuilder, Theme, into_text_with_renderer};
use ratatui_core::style::{Color, Modifier, Style};

let mut theme = Theme::default();
theme.h1 = Style::new().fg(Color::Green).add_modifier(Modifier::BOLD);

let renderer = RendererBuilder::new().with_theme(theme).build();
let text = into_text_with_renderer("# My heading", &renderer);

Per-element rendering customization

RendererBuilder lets you replace the default rendering for any element type with a custom closure. This is especially useful for links — you can map each URL to a short hint number so the user can open it by typing a number:

use the_other_tui_markdown::{RendererBuilder, into_text_with_renderer};
use ratatui_core::text::Span;
use std::collections::HashMap;
use std::sync::{Arc, Mutex};
use std::sync::atomic::{AtomicU32, Ordering};

// A shared hint table: url → number.
let hints: Arc<Mutex<HashMap<String, u32>>> = Arc::new(Mutex::new(HashMap::new()));
let counter = Arc::new(AtomicU32::new(0));

let hints_clone = Arc::clone(&hints);
let counter_clone = Arc::clone(&counter);
let renderer = RendererBuilder::new()
    .with_link(move |alt, url| {
        let mut map = hints_clone.lock().unwrap();
        let n = *map.entry(url.to_owned()).or_insert_with(|| {
            counter_clone.fetch_add(1, Ordering::Relaxed) + 1
        });
        vec![Span::raw(format!("[{}]({})", alt, n))]
    })
    .build();

let text = into_text_with_renderer(
    "Visit [the docs](https://docs.rs) and [crates.io](https://crates.io).",
    &renderer,
);
// Renders as: "Visit [the docs](1) and [crates.io](2)."
// `hints` now maps "https://docs.rs" → 1, "https://crates.io" → 2.

Supported Markdown elements

Element	Default output
# H1 … ###### H6	# text prefix + heading style
**bold** / __bold__	[Modifier::BOLD]
*italic* / _italic_	[Modifier::ITALIC]
~~strikethrough~~	[Modifier::CROSSED_OUT]
^superscript^	[Modifier::DIM]
~subscript~	[Modifier::DIM]
`inline code`	yellow foreground
```lang … ```	[lang] label + yellow foreground
[alt](url)	[alt](url) in link style
	🖼 alt(url) in image style
> quote	▌ text with quote style (GFM alerts supported)
- item / 1. item	• item / 1. item with nesting
- [x] done	[x] / [ ] prefix
--- (rule)	────────────────────────────────────────
Tables	aligned columns with ─┼─ separator
[^1] footnote refs	[^1] in dim style; defs appended at end
Inline / block HTML	verbatim, unstyled
Inline / display math	verbatim content in math style
Definition lists	term in bold, definition indented

Re-exports

pub use renderer::CodeBlockFn;

pub use renderer::FootnoteRefFn;

pub use renderer::HeadingFn;

pub use renderer::ImageFn;

pub use renderer::InlineCodeFn;

pub use renderer::LinkFn;

pub use renderer::Renderer;

pub use renderer::RendererBuilder;

pub use renderer::RuleFn;

pub use theme::Theme;

Modules

converter

Core event-driven converter: walks pulldown-cmark events and builds ratatui_core::text::Text.

renderer

Per-element rendering customization.

theme

Styling configuration for the Markdown renderer.

Functions

into_text

Convert Markdown to Text using the default Theme and no custom element renderers.

into_text_with_renderer

Convert Markdown to Text using a fully configured Renderer.

into_text_with_theme

Convert Markdown to Text using the default Theme and a custom theme override, but no custom element renderers.