How to stream Markdown from an AI API in an iOS chat app?

Use startRealStreaming() to begin, then appendStreamContent() for incoming chunks, and finishStreaming() on completion. Configure typewriterTextMode and streamingHapticFeedbackStyle for smooth effects, as detailed in the real-time streaming section.

MarkdownDisplayView vs Down for iOS: which should I use?

MarkdownDisplayView is better for real-time streaming and TextKit 2 performance in AI chats, while Down is simpler and supports older iOS versions. Choose based on streaming needs and iOS 15+ targeting.

How do I customize syntax highlighting colors to match my app's theme?

Modify the syntaxColors and syntaxColorsDark properties in MarkdownConfiguration using the SyntaxHighlightColors struct—set colors for keywords, strings, comments, etc., as shown in the customization examples.

Can I use this with SwiftUI or is it UIKit only?

It's built on UIKit and TextKit 2, so integration with SwiftUI requires UIViewRepresentable wrappers, adding complexity for SwiftUI-native projects.

How does it handle image loading and caching?

Images load asynchronously with caching via ImageCacheManager. Use the onImageTap callback for interaction, and ensure network permissions in Info.plist for remote images.

What's the performance like when embedding this in table view cells?

It supports resetForReuse() for cell recycling and optimized incremental updates, but streaming in cells needs typewriterHeightUpdateInterval configuration to minimize layout jumps during height changes.

Open-Awesome

MarkdownDisplayView

Apache-2.0Swift1.8.1

A high-performance iOS Markdown rendering component with streaming support for AI chat interfaces.

GitHub

216 stars29 forks0 contributors

What is MarkdownDisplayView?

MarkdownDisplayView is an iOS library that renders Markdown text with high performance and streaming capabilities. It solves the need for smooth, real-time display of AI-generated Markdown content in chat interfaces while providing extensive styling options.

Target Audience

iOS developers building applications that display Markdown, particularly those integrating AI chat features or requiring rich text rendering with custom theming.

Value Proposition

Developers choose MarkdownDisplayView for its TextKit 2-based performance, native streaming support for AI responses, and deep customization that surpasses basic Markdown renderers.

Overview

A view for display markdown text.support markdown streaming like gpt&claude&gemini&deepseek

Use Cases

Best For

Building AI chat interfaces that stream Markdown responses in real-time
Creating documentation viewers with interactive table of contents and syntax highlighting
Developing educational apps that display mathematical formulas using LaTeX
Implementing custom Markdown syntax extensions like mentions or embedded media
Rendering code snippets with syntax highlighting for multiple programming languages
Designing highly themed Markdown displays with custom fonts, colors, and spacing

Not Ideal For

Apps targeting iOS versions below 15.0 due to TextKit 2 dependency
Cross-platform projects requiring Markdown rendering on web or Android
Developers wanting a zero-configuration, drop-in component without custom extension work
Use cases where Markdown content is entirely static and doesn't benefit from real-time streaming features

Pros & Cons

Pros

TextKit 2 Performance Engine

Built on TextKit 2 with asynchronous and incremental rendering, delivering ultra-fast first-screen loading and low CPU usage—peaking under 56% on iPhone 17 Pro simulator in streaming mode.

AI Chat Streaming Optimized

Supports real-time streaming with smart buffering, typewriter effects, and haptic feedback, specifically designed for smooth LLM response display as shown in demo GIFs with models like DeepSeek.

Full Markdown with Extensions

Handles LaTeX formulas, tables, code blocks with syntax highlighting for 20+ languages, and allows custom extensions like Mermaid diagrams via MarkdownCodeBlockRenderer protocol.

Deep Customization Control

Offers extensive configuration for fonts, colors, spacing, and even haptic feedback styles, enabling precise theming beyond basic Markdown renderers.

Cons

iOS 15+ Lock-In

Requires iOS 15.0 or higher due to TextKit 2, limiting compatibility with older devices and excluding apps that need broader iOS version support.

Complex Extension Setup

Adding custom syntax or renderers involves implementing multiple protocols (parser, view provider, action handler) and careful registration, which can be steep for simple use cases.

Dependency and Build Hurdles

CocoaPods installation depends on swift-markdown from GitHub source, not trunk, and build errors occur on macOS due to iOS-only platform support, adding setup friction.

Frequently Asked Questions

Related Projects

BonMot

Beautiful, easy attributed strings in Swift

Stars3,551

Forks194

Last commit2 years ago

SwiftRichString

👩‍🎨 Elegant Attributed String composition in Swift sauce

Stars3,147

Forks211

Last commit3 years ago

TwitterTextEditor

A standalone, flexible API that provides a full-featured rich text editor for iOS applications.

Stars3,002

Forks171