Swift流式Markdown库

Installation

SwiftStreamingMarkdown is distributed exclusively as a Swift Package.

Quick start

The simplest entry point is MarkdownView, which parses and renders a static string of Markdown using the default theme:

import SwiftUI
import SwiftStreamingMarkdown

struct ContentView: View {
  var body: some View {
    ScrollView {
      MarkdownView(text: """
      # Hello, **world!**

      SwiftStreamingMarkdown supports tables, lists, code blocks, and
      inline `code`.

      

      """)
      .padding()
    }
  }
}

Streaming usage

For chat-style UIs that grow the Markdown source over time, use StreamedMarkdownView. It takes a StreamedMarkdownSource whose text property yields progressively larger snapshots of the Markdown source (each emission is the full source so far, not a delta) and incrementally parses and renders them as they arrive.

import SwiftUI
import SwiftStreamingMarkdown

class ChatResponseSource: ObservableObject, StreamedMarkdownSource {
  var text: AsyncStream<String> { ... }
}

struct ChatBubble: View {
  @EnvironmentObject var source: ChatResponseSource

  var body: some View {
    StreamedMarkdownView(source: source)
  }
}

If you'd rather drive DocumentView directly, parse each snapshot with MarkdownParser.parse(text:config:) and feed the resulting RenderableDocument into your view yourself.

The bundled sample app demonstrates chunked streaming end-to-end with adjustable chunk size and interval, plus auto-scroll wired through a MarkdownListener.

Demos

Here are a few demos to help you quickly understand this library's capabilities. More can be found in the sample app.

Table
LaTeX
Customization
Inline citation
Code block

Sample app

A SwiftUI sample app lives in Examples/SwiftStreamingMarkdownSample. It includes a streaming demonstration with adjustable chunk size and interval, a settings screen, and a logging MarkdownListener implementation. The sample Xcode project is generated from Examples/SwiftStreamingMarkdownSample/project.yml; run make sample-project to generate and open it in Xcode.

`Package.swift`

.package(url: "https://github.com/microsoft/SwiftStreamingMarkdown", from: "0.1.0"),

.target(
  name: "MyApp",
  dependencies: [
    .product(name: "SwiftStreamingMarkdown", package: "SwiftStreamingMarkdown")
  ]
)