markdown

Documentation

Index

• func StreamMarkdown(ctx context.Context, next func(context.Context) (Chunk, error), w io.Writer, ...) error
• type Chunk
• type StreamOptions

Functions

func StreamMarkdown

func StreamMarkdown(
	ctx context.Context,
	next func(context.Context) (Chunk, error),
	w io.Writer,
	opts StreamOptions,
) error

StreamMarkdown renders streaming markdown to the supplied writer. When Raw is false it spins up a Bubble Tea viewport so the output remains scrollable and responsive.

Types

type Chunk

type Chunk struct {
	Text string
}

Chunk represents an incremental markdown fragment emitted by the stream.

type StreamOptions

type StreamOptions struct {
	Raw      bool
	WordWrap int
	Cancel   func()
	UIWriter io.Writer
}

StreamOptions configures how streaming markdown should be rendered.