Class

MarkdownExporter

ConsoleMonster.Markdown

Exports widget data and terminal snapshots as Markdown through the optional OfficeIMO bridge.

Inheritance

Export 3 overloads

public static string Export(IWidget widget, ExportOptions? options = null, bool fenced = false) #

Exports tables, records and trees semantically, or preserves the rendered frame when fenced is true.

Parameters

widget ConsoleMonster.Layout.IWidget required: The widget or layout.
options ConsoleMonster.Export.ExportOptions? = null optional: Size, culture, glyphs and theme.
fenced bool = false optional: Preserves the exact terminal layout in a code block instead of exporting semantic data.

Returns

string The Markdown document.

public static string Export(CellBuffer frame) #

Preserves an already rendered frame in a fenced text block.

Parameters

frame ConsoleMonster.Canvas.CellBuffer required: The frame; its dimensions are kept.

Returns

string The Markdown code block.

public static string Export(LiveSession session) #

Exports the current live-session snapshot as a fenced text block.

Parameters

session ConsoleMonster.Live.LiveSession required: A session that has drawn a frame.

Returns

string The Markdown code block.

ExportRecording 2 overloads

public static string ExportRecording(SessionRecording recording) #

Exports terminal scrollback and the final main screen as a fenced text block.

Parameters

recording ConsoleMonster.Sessions.SessionRecording required: The recorded terminal session.

Returns

string The complete transcript as Markdown.

public static string ExportRecording(IWidget root, IEnumerable<LiveEvent> events, RecordingExportOptions? options = null)

Replays dashboard events into timestamped fenced frames in an OfficeIMO document.

Parameters

root ConsoleMonster.Layout.IWidget required: The dashboard definition addressed by the recorded events.
events System.Collections.Generic.IEnumerable<ConsoleMonster.Live.LiveEvent> required: Recorded updates, in order.
options ConsoleMonster.Export.RecordingExportOptions? = null optional: Replay dimensions, sampling and timing.

Returns

string A document containing each distinct replayed frame.