@suds-cli/markdown 0.1.0-alpha.0

package/README.md

@@ -0,0 +1,41 @@
+# @suds-cli/markdown
+
+Markdown viewer component for Suds terminal UIs.
+
+<img src="../../examples/markdown-demo.gif" width="950" alt="Markdown component demo" />
+
+## Features
+
+- Renders markdown with beautiful terminal styling
+- Scrollable viewport for long documents
+- Automatic light/dark theme detection
+- Support for headers, code blocks, lists, links, and more
+- Word wrapping at viewport width
+
+## Installation
+
+```bash
+pnpm add @suds-cli/markdown
+```
+
+## Usage
+
+```typescript
+import { MarkdownModel } from '@suds-cli/markdown'
+import { Program } from '@suds-cli/tea'
+
+let model = MarkdownModel.new({ active: true })
+const [updatedModel, cmd] = model.setFileName('README.md')
+model = updatedModel
+
+// Handle resize
+const [resizedModel] = model.setSize(width, height)
+model = resizedModel
+
+// Render
+const view = model.view()
+```
+
+## API
+
+See the [API documentation](../../docs/markdown.md) for complete details.

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Markdown viewer component for Suds terminal UIs.
+ *
+ * @packageDocumentation
+ */
+export { MarkdownModel, type MarkdownOptions } from "./model.js";
+export { RenderMarkdownMsg, ErrorMsg } from "./messages.js";
+export { renderMarkdown, type RenderMarkdownOptions } from "./renderer.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,aAAa,EAAE,KAAK,eAAe,EAAE,MAAM,YAAY,CAAC;AACjE,OAAO,EAAE,iBAAiB,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,KAAK,qBAAqB,EAAE,MAAM,eAAe,CAAC"}

package/dist/index.js

@@ -0,0 +1,9 @@
+/**
+ * Markdown viewer component for Suds terminal UIs.
+ *
+ * @packageDocumentation
+ */
+export { MarkdownModel } from "./model.js";
+export { RenderMarkdownMsg, ErrorMsg } from "./messages.js";
+export { renderMarkdown } from "./renderer.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,aAAa,EAAwB,MAAM,YAAY,CAAC;AACjE,OAAO,EAAE,iBAAiB,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAC5D,OAAO,EAAE,cAAc,EAA8B,MAAM,eAAe,CAAC"}

package/dist/messages.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Message types for the markdown component.
+ */
+/**
+ * Message containing rendered markdown content.
+ * @public
+ */
+export declare class RenderMarkdownMsg {
+    readonly content: string;
+    readonly _tag = "markdown-render";
+    constructor(content: string);
+}
+/**
+ * Message containing an error from file reading or rendering.
+ * @public
+ */
+export declare class ErrorMsg {
+    readonly error: Error;
+    readonly _tag = "markdown-error";
+    constructor(error: Error);
+}
+//# sourceMappingURL=messages.d.ts.map

package/dist/messages.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../src/messages.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;GAGG;AACH,qBAAa,iBAAiB;aAGA,OAAO,EAAE,MAAM;IAF3C,QAAQ,CAAC,IAAI,qBAAqB;gBAEN,OAAO,EAAE,MAAM;CAC5C;AAED;;;GAGG;AACH,qBAAa,QAAQ;aAGS,KAAK,EAAE,KAAK;IAFxC,QAAQ,CAAC,IAAI,oBAAoB;gBAEL,KAAK,EAAE,KAAK;CACzC"}

package/dist/messages.js

@@ -0,0 +1,26 @@
+/**
+ * Message types for the markdown component.
+ */
+/**
+ * Message containing rendered markdown content.
+ * @public
+ */
+export class RenderMarkdownMsg {
+    content;
+    _tag = "markdown-render";
+    constructor(content) {
+        this.content = content;
+    }
+}
+/**
+ * Message containing an error from file reading or rendering.
+ * @public
+ */
+export class ErrorMsg {
+    error;
+    _tag = "markdown-error";
+    constructor(error) {
+        this.error = error;
+    }
+}
+//# sourceMappingURL=messages.js.map

package/dist/messages.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"messages.js","sourceRoot":"","sources":["../src/messages.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;GAGG;AACH,MAAM,OAAO,iBAAiB;IAGA;IAFnB,IAAI,GAAG,iBAAiB,CAAC;IAElC,YAA4B,OAAe;QAAf,YAAO,GAAP,OAAO,CAAQ;IAAG,CAAC;CAChD;AAED;;;GAGG;AACH,MAAM,OAAO,QAAQ;IAGS;IAFnB,IAAI,GAAG,gBAAgB,CAAC;IAEjC,YAA4B,KAAY;QAAZ,UAAK,GAAL,KAAK,CAAO;IAAG,CAAC;CAC7C"}

package/dist/model.d.ts

@@ -0,0 +1,82 @@
+/**
+ * Markdown viewer component.
+ */
+import { Style } from "@suds-cli/chapstick";
+import { ViewportModel } from "@suds-cli/viewport";
+import type { Cmd, Msg } from "@suds-cli/tea";
+/**
+ * Options for creating a markdown model.
+ * @public
+ */
+export interface MarkdownOptions {
+    /**
+     * Whether the component is active and should handle input.
+     * Defaults to true.
+     */
+    active?: boolean;
+    /**
+     * Initial width for the viewport.
+     * Defaults to 0.
+     */
+    width?: number;
+    /**
+     * Initial height for the viewport.
+     * Defaults to 0.
+     */
+    height?: number;
+    /**
+     * Style for the viewport.
+     */
+    style?: Style;
+}
+/**
+ * Markdown viewer model that renders markdown files with terminal styling
+ * in a scrollable viewport.
+ * @public
+ */
+export declare class MarkdownModel {
+    readonly viewport: ViewportModel;
+    readonly active: boolean;
+    readonly fileName: string;
+    private constructor();
+    /**
+     * Create a new markdown model.
+     * @param options - Configuration options
+     */
+    static new(options?: MarkdownOptions): MarkdownModel;
+    /**
+     * Tea init hook (no-op).
+     */
+    init(): Cmd<Msg>;
+    /**
+     * Set the filename to render. Returns a command that will read and render the file.
+     * @param fileName - Path to the markdown file
+     */
+    setFileName(fileName: string): [MarkdownModel, Cmd<Msg>];
+    /**
+     * Set the size of the viewport and re-render if a file is set.
+     * @param width - New width
+     * @param height - New height
+     */
+    setSize(width: number, height: number): [MarkdownModel, Cmd<Msg>];
+    /**
+     * Set whether the component is active and should handle input.
+     * @param active - Active state
+     */
+    setIsActive(active: boolean): MarkdownModel;
+    /**
+     * Scroll to the top of the viewport.
+     */
+    gotoTop(): MarkdownModel;
+    /**
+     * Handle messages. Processes viewport scrolling and markdown rendering.
+     * @param msg - The message to handle
+     */
+    update(msg: Msg): [MarkdownModel, Cmd<Msg>];
+    /**
+     * Render the markdown viewport.
+     */
+    view(): string;
+    private with;
+}
+//# sourceMappingURL=model.d.ts.map

package/dist/model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"model.d.ts","sourceRoot":"","sources":["../src/model.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAC;AAE5C,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAI9C;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC;CACf;AAED;;;;GAIG;AACH,qBAAa,aAAa;IACxB,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAC;IACjC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IACzB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAE1B,OAAO;IAUP;;;OAGG;IACH,MAAM,CAAC,GAAG,CAAC,OAAO,GAAE,eAAoB,GAAG,aAAa;IAcxD;;OAEG;IACH,IAAI,IAAI,GAAG,CAAC,GAAG,CAAC;IAIhB;;;OAGG;IACH,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,CAAC,aAAa,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;IAMxD;;;;OAIG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,CAAC,aAAa,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;IAYjE;;;OAGG;IACH,WAAW,CAAC,MAAM,EAAE,OAAO,GAAG,aAAa;IAK3C;;OAEG;IACH,OAAO,IAAI,aAAa;IAMxB;;;OAGG;IACH,MAAM,CAAC,GAAG,EAAE,GAAG,GAAG,CAAC,aAAa,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;IAsC3C;;OAEG;IACH,IAAI,IAAI,MAAM;IAId,OAAO,CAAC,IAAI;CAOb"}

package/dist/model.js

@@ -0,0 +1,152 @@
+/**
+ * Markdown viewer component.
+ */
+import { Style } from "@suds-cli/chapstick";
+import { readFileContent } from "@suds-cli/filesystem";
+import { ViewportModel } from "@suds-cli/viewport";
+import { RenderMarkdownMsg, ErrorMsg } from "./messages.js";
+import { renderMarkdown } from "./renderer.js";
+/**
+ * Markdown viewer model that renders markdown files with terminal styling
+ * in a scrollable viewport.
+ * @public
+ */
+export class MarkdownModel {
+    viewport;
+    active;
+    fileName;
+    constructor(options) {
+        this.viewport = options.viewport;
+        this.active = options.active;
+        this.fileName = options.fileName;
+    }
+    /**
+     * Create a new markdown model.
+     * @param options - Configuration options
+     */
+    static new(options = {}) {
+        const viewport = ViewportModel.new({
+            width: options.width ?? 0,
+            height: options.height ?? 0,
+            style: options.style,
+        });
+        return new MarkdownModel({
+            viewport,
+            active: options.active ?? true,
+            fileName: "",
+        });
+    }
+    /**
+     * Tea init hook (no-op).
+     */
+    init() {
+        return null;
+    }
+    /**
+     * Set the filename to render. Returns a command that will read and render the file.
+     * @param fileName - Path to the markdown file
+     */
+    setFileName(fileName) {
+        const updated = this.with({ fileName });
+        const cmd = renderMarkdownCmd(this.viewport.width, fileName);
+        return [updated, cmd];
+    }
+    /**
+     * Set the size of the viewport and re-render if a file is set.
+     * @param width - New width
+     * @param height - New height
+     */
+    setSize(width, height) {
+        const updatedViewport = this.viewport.setWidth(width).setHeight(height);
+        const updated = this.with({ viewport: updatedViewport });
+        if (this.fileName !== "") {
+            const cmd = renderMarkdownCmd(width, this.fileName);
+            return [updated, cmd];
+        }
+        return [updated, null];
+    }
+    /**
+     * Set whether the component is active and should handle input.
+     * @param active - Active state
+     */
+    setIsActive(active) {
+        if (active === this.active)
+            return this;
+        return this.with({ active });
+    }
+    /**
+     * Scroll to the top of the viewport.
+     */
+    gotoTop() {
+        const updatedViewport = this.viewport.scrollToTop();
+        if (updatedViewport === this.viewport)
+            return this;
+        return this.with({ viewport: updatedViewport });
+    }
+    /**
+     * Handle messages. Processes viewport scrolling and markdown rendering.
+     * @param msg - The message to handle
+     */
+    update(msg) {
+        // Handle markdown rendering
+        if (msg instanceof RenderMarkdownMsg) {
+            // Apply width for word wrapping and left-align to pad lines to consistent width
+            // Viewport handles height/scrolling
+            const styled = new Style()
+                .width(this.viewport.width)
+                .alignHorizontal('left')
+                .render(msg.content);
+            const updatedViewport = this.viewport.setContent(styled);
+            return [this.with({ viewport: updatedViewport }), null];
+        }
+        // Handle errors
+        if (msg instanceof ErrorMsg) {
+            const errorContent = msg.error.message;
+            const updatedViewport = this.viewport.setContent(errorContent);
+            return [
+                this.with({
+                    fileName: "",
+                    viewport: updatedViewport,
+                }),
+                null,
+            ];
+        }
+        // Handle viewport updates if active
+        if (this.active) {
+            const [updatedViewport, cmd] = this.viewport.update(msg);
+            if (updatedViewport !== this.viewport) {
+                return [this.with({ viewport: updatedViewport }), cmd];
+            }
+        }
+        return [this, null];
+    }
+    /**
+     * Render the markdown viewport.
+     */
+    view() {
+        return this.viewport.view();
+    }
+    with(patch) {
+        return new MarkdownModel({
+            viewport: patch.viewport ?? this.viewport,
+            active: patch.active ?? this.active,
+            fileName: patch.fileName ?? this.fileName,
+        });
+    }
+}
+/**
+ * Command to read and render a markdown file.
+ */
+function renderMarkdownCmd(width, fileName) {
+    return async () => {
+        try {
+            const content = await readFileContent(fileName);
+            const rendered = renderMarkdown(content, { width });
+            return new RenderMarkdownMsg(rendered);
+        }
+        catch (error) {
+            return new ErrorMsg(error instanceof Error ? error : new Error(String(error)));
+        }
+    };
+}
+//# sourceMappingURL=model.js.map

package/dist/model.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"model.js","sourceRoot":"","sources":["../src/model.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAC;AAC5C,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD,OAAO,EAAE,iBAAiB,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AA4B/C;;;;GAIG;AACH,MAAM,OAAO,aAAa;IACf,QAAQ,CAAgB;IACxB,MAAM,CAAU;IAChB,QAAQ,CAAS;IAE1B,YAAoB,OAInB;QACC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;QACjC,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QAC7B,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;IACnC,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,GAAG,CAAC,UAA2B,EAAE;QACtC,MAAM,QAAQ,GAAG,aAAa,CAAC,GAAG,CAAC;YACjC,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,CAAC;YACzB,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,CAAC;YAC3B,KAAK,EAAE,OAAO,CAAC,KAAK;SACrB,CAAC,CAAC;QAEH,OAAO,IAAI,aAAa,CAAC;YACvB,QAAQ;YACR,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,IAAI;YAC9B,QAAQ,EAAE,EAAE;SACb,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,IAAI;QACF,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,WAAW,CAAC,QAAgB;QAC1B,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;QACxC,MAAM,GAAG,GAAG,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;QAC7D,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;IACxB,CAAC;IAED;;;;OAIG;IACH,OAAO,CAAC,KAAa,EAAE,MAAc;QACnC,MAAM,eAAe,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QACxE,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,eAAe,EAAE,CAAC,CAAC;QAEzD,IAAI,IAAI,CAAC,QAAQ,KAAK,EAAE,EAAE,CAAC;YACzB,MAAM,GAAG,GAAG,iBAAiB,CAAC,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;YACpD,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;QACxB,CAAC;QAED,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IACzB,CAAC;IAED;;;OAGG;IACH,WAAW,CAAC,MAAe;QACzB,IAAI,MAAM,KAAK,IAAI,CAAC,MAAM;YAAE,OAAO,IAAI,CAAC;QACxC,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;IAC/B,CAAC;IAED;;OAEG;IACH,OAAO;QACL,MAAM,eAAe,GAAG,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC;QACpD,IAAI,eAAe,KAAK,IAAI,CAAC,QAAQ;YAAE,OAAO,IAAI,CAAC;QACnD,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,eAAe,EAAE,CAAC,CAAC;IAClD,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,GAAQ;QACb,4BAA4B;QAC5B,IAAI,GAAG,YAAY,iBAAiB,EAAE,CAAC;YACrC,gFAAgF;YAChF,oCAAoC;YACpC,MAAM,MAAM,GAAG,IAAI,KAAK,EAAE;iBACvB,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;iBAC1B,eAAe,CAAC,MAAM,CAAC;iBACvB,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;YAEvB,MAAM,eAAe,GAAG,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;YACzD,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,eAAe,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;QAC1D,CAAC;QAED,gBAAgB;QAChB,IAAI,GAAG,YAAY,QAAQ,EAAE,CAAC;YAC5B,MAAM,YAAY,GAAG,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC;YACvC,MAAM,eAAe,GAAG,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;YAC/D,OAAO;gBACL,IAAI,CAAC,IAAI,CAAC;oBACR,QAAQ,EAAE,EAAE;oBACZ,QAAQ,EAAE,eAAe;iBAC1B,CAAC;gBACF,IAAI;aACL,CAAC;QACJ,CAAC;QAED,oCAAoC;QACpC,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,MAAM,CAAC,eAAe,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACzD,IAAI,eAAe,KAAK,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACtC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,eAAe,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC;YACzD,CAAC;QACH,CAAC;QAED,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACtB,CAAC;IAED;;OAEG;IACH,IAAI;QACF,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;IAC9B,CAAC;IAEO,IAAI,CAAC,KAA6B;QACxC,OAAO,IAAI,aAAa,CAAC;YACvB,QAAQ,EAAE,KAAK,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ;YACzC,MAAM,EAAE,KAAK,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM;YACnC,QAAQ,EAAE,KAAK,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ;SAC1C,CAAC,CAAC;IACL,CAAC;CACF;AAED;;GAEG;AACH,SAAS,iBAAiB,CAAC,KAAa,EAAE,QAAgB;IACxD,OAAO,KAAK,IAAI,EAAE;QAChB,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,MAAM,eAAe,CAAC,QAAQ,CAAC,CAAC;YAChD,MAAM,QAAQ,GAAG,cAAc,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;YACpD,OAAO,IAAI,iBAAiB,CAAC,QAAQ,CAAC,CAAC;QACzC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,IAAI,QAAQ,CACjB,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAC1D,CAAC;QACJ,CAAC;IACH,CAAC,CAAC;AACJ,CAAC"}

package/dist/renderer.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Markdown rendering utilities.
+ */
+/**
+ * Options for rendering markdown.
+ * @public
+ */
+export interface RenderMarkdownOptions {
+    /**
+     * Width for word wrapping. Defaults to 80.
+     */
+    width?: number;
+}
+/**
+ * Renders markdown content with terminal styling.
+ * Detects terminal background (light/dark) and applies appropriate styling.
+ *
+ * @param content - The markdown string to render
+ * @param options - Rendering options
+ * @returns The styled markdown output
+ * @public
+ */
+export declare function renderMarkdown(content: string, options?: RenderMarkdownOptions): string;
+//# sourceMappingURL=renderer.d.ts.map

package/dist/renderer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"renderer.d.ts","sourceRoot":"","sources":["../src/renderer.ts"],"names":[],"mappings":"AAAA;;GAEG;AAOH;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;;;GAQG;AACH,wBAAgB,cAAc,CAC5B,OAAO,EAAE,MAAM,EACf,OAAO,GAAE,qBAA0B,GAClC,MAAM,CAsCR"}

package/dist/renderer.js

@@ -0,0 +1,52 @@
+/**
+ * Markdown rendering utilities.
+ */
+import { Marked } from "marked";
+import { markedTerminal } from "marked-terminal";
+import { getTerminalBackground } from "@suds-cli/chapstick";
+import chalk from "chalk";
+/**
+ * Renders markdown content with terminal styling.
+ * Detects terminal background (light/dark) and applies appropriate styling.
+ *
+ * @param content - The markdown string to render
+ * @param options - Rendering options
+ * @returns The styled markdown output
+ * @public
+ */
+export function renderMarkdown(content, options = {}) {
+    const width = options.width ?? 80;
+    const background = getTerminalBackground();
+    // Use appropriate colors for terminal background
+    const isDark = background !== 'light';
+    // Create marked instance with terminal renderer
+    const marked = new Marked(markedTerminal({
+        // Wrap text at specified width
+        width,
+        reflowText: true,
+        // Headings - brighter on dark backgrounds
+        firstHeading: isDark ? chalk.cyan.bold : chalk.blue.bold,
+        heading: isDark ? chalk.cyan.bold : chalk.blue.bold,
+        // Code blocks
+        code: isDark ? chalk.white : chalk.gray,
+        blockquote: isDark ? chalk.white : chalk.gray,
+        // Emphasis
+        strong: chalk.bold,
+        em: chalk.italic,
+        // Lists
+        listitem: chalk.reset,
+        // Links
+        link: isDark ? chalk.blueBright : chalk.blue,
+        // Other elements
+        hr: chalk.gray,
+        paragraph: chalk.reset,
+    }));
+    try {
+        const rendered = marked.parse(content);
+        return rendered.trim();
+    }
+    catch (error) {
+        throw new Error(`Failed to render markdown: ${error instanceof Error ? error.message : String(error)}`);
+    }
+}
+//# sourceMappingURL=renderer.js.map

package/dist/renderer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"renderer.js","sourceRoot":"","sources":["../src/renderer.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAC5D,OAAO,KAAK,MAAM,OAAO,CAAC;AAa1B;;;;;;;;GAQG;AACH,MAAM,UAAU,cAAc,CAC5B,OAAe,EACf,UAAiC,EAAE;IAEnC,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC;IAClC,MAAM,UAAU,GAAG,qBAAqB,EAAE,CAAC;IAE3C,iDAAiD;IACjD,MAAM,MAAM,GAAG,UAAU,KAAK,OAAO,CAAC;IAEtC,gDAAgD;IAChD,MAAM,MAAM,GAAG,IAAI,MAAM,CACvB,cAAc,CAAC;QACb,+BAA+B;QAC/B,KAAK;QACL,UAAU,EAAE,IAAI;QAChB,0CAA0C;QAC1C,YAAY,EAAE,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI;QACxD,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI;QACnD,cAAc;QACd,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI;QACvC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI;QAC7C,WAAW;QACX,MAAM,EAAE,KAAK,CAAC,IAAI;QAClB,EAAE,EAAE,KAAK,CAAC,MAAM;QAChB,QAAQ;QACR,QAAQ,EAAE,KAAK,CAAC,KAAK;QACrB,QAAQ;QACR,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI;QAC5C,iBAAiB;QACjB,EAAE,EAAE,KAAK,CAAC,IAAI;QACd,SAAS,EAAE,KAAK,CAAC,KAAK;KACvB,CAAC,CACH,CAAC;IAEF,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,MAAM,CAAC,KAAK,CAAC,OAAO,CAAW,CAAC;QACjD,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;IACzB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CAAC,8BAA8B,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAC1G,CAAC;AACH,CAAC"}

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@suds-cli/markdown",
+  "version": "0.1.0-alpha.0",
+  "description": "Markdown viewer component for Suds terminal UIs",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "chalk": "^5.4.1",
+    "marked": "^15.0.0",
+    "marked-terminal": "^7.3.0",
+    "@suds-cli/chapstick": "0.1.0-alpha.0",
+    "@suds-cli/filesystem": "0.0.0",
+    "@suds-cli/tea": "0.0.0",
+    "@suds-cli/viewport": "0.0.1-alpha.0"
+  },
+  "devDependencies": {
+    "typescript": "5.8.2",
+    "vitest": "^4.0.15"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "scripts": {
+    "clean": "rm -rf dist",
+    "build": "pnpm run clean && tsc -p ./tsconfig.json",
+    "test": "vitest run",
+    "generate:api-report": "api-extractor run --local",
+    "check:api-report": "pnpm run generate:api-report",
+    "check:eslint": "pnpm run lint",
+    "lint": "eslint \"{src,test}/**/*.{ts,tsx}\""
+  }
+}