Files
wehub-resource-sync e30e75b5d4
Code Quality / Oxlint + Oxfmt (push) Waiting to run
Code Quality / Template Sync (push) Waiting to run
Code Quality / Build Changed Packages (push) Waiting to run
Code Quality / Test Changed Packages (push) Waiting to run
Deploy Expo Example / Deploy Production (push) Waiting to run
Deploy Ink Example / Deploy Production (push) Waiting to run
Python Tests / pytest (assistant-stream, 3.10) (push) Waiting to run
Python Tests / pytest (assistant-stream, 3.12) (push) Waiting to run
Python Tests / pytest (assistant-ui-sync-server-api, 3.10) (push) Waiting to run
Python Tests / pytest (assistant-ui-sync-server-api, 3.12) (push) Waiting to run
Deploy Shadcn Registry / Deploy Production (push) Waiting to run
Template Metrics / LOC + Bundle Size (push) Waiting to run
Changesets / Create Version PR (push) Has been cancelled
chore: import upstream snapshot with attribution
2026-07-13 13:40:13 +08:00
..

@assistant-ui/react-ink-markdown

Terminal markdown rendering for @assistant-ui/react-ink. Wraps markdansi to render formatted headings, code blocks, tables, lists, and more in the terminal, with Shiki syntax highlighting.

Installation

npm install @assistant-ui/react-ink @assistant-ui/react-ink-markdown ink react shiki

Usage

Inside MessagePrimitive.Parts, use MarkdownTextPrimitive to read text and status from the runtime context automatically:

import { MessagePrimitive } from "@assistant-ui/react-ink";
import { MarkdownTextPrimitive } from "@assistant-ui/react-ink-markdown";

<MessagePrimitive.Parts>
  {({ part }) => (part.type === "text" ? <MarkdownTextPrimitive /> : null)}
</MessagePrimitive.Parts>;

For standalone use or to attach a custom Shiki highlighter, see the Documentation section below.

Documentation

Full reference at assistant-ui.com/docs/ink.