@profullstack/readm3 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 readm3 contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,127 @@
+# readm3
+
+A terminal markdown reader. File browser on the left, the rendered document on
+the right, and nothing else in the way.
+
+Built on [HQTUI](https://github.com/profullstack/hqtui) — truecolor, mouse, and
+a terminal that gets restored no matter how the process dies.
+
+```
+╭─  readm3  ──────────── 6 ─╮╭─  README.md  ────────────────────────────────────── 24% ─╮
+│ ▾ docs                    ││ readm3                                                   │
+│     usage.md              ││ ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ │
+│   README.md               ││                                                          │
+│   CHANGELOG.md            ││ A terminal markdown reader. File browser on the left, the │
+│                           ││ rendered document on the right.                          │
+│                           ││                                                          │
+│                           ││ Install                                                  │
+│                           ││ ─────────                                                │
+│                           ││                                                          │
+│                           ││ ┌─ bash ────────────────────────────────────────────────  │
+│                           ││ │ bun add -g @profullstack/readm3                        │
+│                           ││ └────────────────────────────────────────────────────────  │
+╰───────────────────────────╯╰──────────────────────────────────────────────────────────╯
+ ↑↓ move  ↵ open  ←→ fold  / find  tab reader  ? keys  q quit              docs  dark
+```
+
+## Install
+
+```bash
+bun add -g @profullstack/readm3     # Bun is the default runtime
+npm  install -g @profullstack/readm3 # Node 22.6+ works too
+```
+
+Or run it without installing:
+
+```bash
+bunx @profullstack/readm3
+npx  @profullstack/readm3
+```
+
+## Use
+
+```bash
+readm3                  # browse markdown under the current directory
+readm3 ./docs           # browse a directory
+readm3 CHANGELOG.md     # open a file, browse its directory
+readm3 --theme nord     # pick a palette
+```
+
+The browser only shows markdown. Directories with nothing beneath them are
+pruned, `node_modules` and friends are never walked, and README sorts first.
+
+## Keys
+
+| | | | |
+|---|---|---|---|
+| `↑` `↓` `j` `k` | move or scroll | `tab` | switch pane |
+| `→` `←` `l` `h` | expand or collapse | `/` | filter files |
+| `enter` | open the file | `esc` | clear the filter |
+| `space` `b` | page down / up | `r` | rescan and reload |
+| `g` `G` | top / bottom | `[` `]` | sidebar width |
+| `?` | help | `q` `ctrl+c` | quit |
+
+The mouse works too: the wheel scrolls whichever pane it is over, and a click
+opens a file.
+
+## What it renders
+
+Headings, **bold**, *italic*, `inline code`, links, fenced and indented code
+blocks with a language label, ordered and unordered lists, nested lists, task
+lists, blockquotes, tables with per-column alignment, horizontal rules, images
+as labelled placeholders, and YAML front matter — shown rather than hidden,
+because it is usually what you opened the file for.
+
+The HTML that real READMEs are full of is folded back into markdown rather than
+printed as tags, and inline code is held out of that, so `Array<string>`
+survives.
+
+## Options
+
+```
+-t, --theme <name>   dark, dracula, nord, tokyo-night, gruvbox, matrix,
+                     monochrome, high-contrast, light
+-w, --width <n>      sidebar width in columns (default: 28% of the terminal)
+-a, --all            include dot-directories and dotfiles
+-M, --no-mouse       disable mouse tracking
+-v, --version
+-h, --help
+```
+
+## As a library
+
+The renderer and the file tree are pure and need no terminal, so they can be
+reused on their own:
+
+```ts
+import { renderMarkdown, toText, scan, files } from "@profullstack/readm3";
+
+const lines = renderMarkdown("# Hello\n\nSome **text**.", 60);
+console.log(toText(lines));
+// [ 'Hello', '━━━…', '', 'Some text.' ]
+
+for (const file of files(scan("./docs"))) console.log(file.path);
+```
+
+`renderMarkdown` returns lines of spans carrying a semantic `role` — `h1`,
+`code`, `link`, `quote` and so on — rather than colors, so the same document can
+be re-themed without re-parsing.
+
+## Runtimes
+
+Bun is the default. Node 22.6+ runs the same code. Tested on Linux, macOS and
+Windows Terminal.
+
+## Develop
+
+```bash
+bun install
+bun src/cli.ts .     # run it against its own repo
+bun test test/       # 48 tests, no TTY needed
+bun run typecheck
+bun run build
+```
+
+## License
+
+MIT.

package/bin/readm3.mjs

@@ -0,0 +1,7 @@
+#!/usr/bin/env node
+import { main } from "../dist/cli.js";
+
+main(process.argv.slice(2)).catch((error) => {
+  console.error(error instanceof Error ? error.message : error);
+  process.exit(1);
+});

package/dist/cli.d.ts

@@ -0,0 +1,9 @@
+import { type ViewerOptions } from "./viewer.ts";
+export declare const VERSION = "0.1.0";
+export interface ParsedArgs extends ViewerOptions {
+    help: boolean;
+    version: boolean;
+}
+export declare function parseArgs(argv: string[]): ParsedArgs;
+export declare function main(argv?: string[]): Promise<void>;
+//# sourceMappingURL=cli.d.ts.map

package/dist/cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":"AAOA,OAAO,EAAO,KAAK,aAAa,EAAE,MAAM,aAAa,CAAC;AAEtD,eAAO,MAAM,OAAO,UAAU,CAAC;AA2B/B,MAAM,WAAW,UAAW,SAAQ,aAAa;IAC/C,IAAI,EAAE,OAAO,CAAC;IACd,OAAO,EAAE,OAAO,CAAC;CAClB;AAID,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,UAAU,CAuEpD;AAED,wBAAsB,IAAI,CAAC,IAAI,GAAE,MAAM,EAA0B,GAAG,OAAO,CAAC,IAAI,CAAC,CA4BhF"}

package/dist/cli.js

@@ -0,0 +1,146 @@
+/**
+ * Argument parsing and entry point. `readm3 --help` is the contract.
+ */
+import { statSync } from "node:fs";
+import { dirname, resolve } from "node:path";
+import { pathToFileURL } from "node:url";
+import { themeList } from "@profullstack/hqtui";
+import { run } from "./viewer.js";
+export const VERSION = "0.1.0";
+const USAGE = `readm3 — a terminal markdown reader
+
+Usage
+  readm3 [path] [options]
+
+  path            A directory to browse, or a file to open. Defaults to the
+                  current directory.
+
+Options
+  -t, --theme <name>   Color theme. One of: ${themeList.map((t) => t.name).join(", ")}
+  -w, --width <n>      Sidebar width in columns. Default: 28% of the terminal
+  -a, --all            Include dot-directories and dotfiles
+  -M, --no-mouse       Disable mouse tracking
+  -v, --version        Print the version
+  -h, --help           Print this help
+
+Keys
+  up/down j k    move or scroll        tab      switch pane
+  right/left l h expand or collapse    /        filter files
+  enter          open the file         r        rescan and reload
+  space / b      page down / up        [ ]      sidebar width
+  g / G          top / bottom          ?        help
+                                       q        quit
+`;
+class UsageError extends Error {
+}
+export function parseArgs(argv) {
+    const parsed = {
+        root: process.cwd(),
+        help: false,
+        version: false,
+        mouse: true,
+        all: false,
+    };
+    let target;
+    for (let i = 0; i < argv.length; i++) {
+        const arg = argv[i];
+        const next = () => {
+            const value = argv[++i];
+            if (value === undefined)
+                throw new UsageError(`${arg} needs a value`);
+            return value;
+        };
+        switch (arg) {
+            case "-h":
+            case "--help":
+                parsed.help = true;
+                break;
+            case "-v":
+            case "--version":
+                parsed.version = true;
+                break;
+            case "-t":
+            case "--theme":
+                parsed.theme = next();
+                break;
+            case "-w":
+            case "--width": {
+                const value = Number.parseInt(next(), 10);
+                if (!Number.isFinite(value) || value <= 0)
+                    throw new UsageError("--width needs a positive number");
+                parsed.sidebar = value;
+                break;
+            }
+            case "-a":
+            case "--all":
+                parsed.all = true;
+                break;
+            case "-M":
+            case "--no-mouse":
+                parsed.mouse = false;
+                break;
+            default:
+                if (arg.startsWith("-") && arg !== "-")
+                    throw new UsageError(`Unknown option: ${arg}`);
+                if (target !== undefined)
+                    throw new UsageError("Only one path may be given");
+                target = arg;
+                break;
+        }
+    }
+    if (target !== undefined) {
+        const path = resolve(target);
+        let isDir;
+        try {
+            isDir = statSync(path).isDirectory();
+        }
+        catch {
+            throw new UsageError(`No such file or directory: ${target}`);
+        }
+        if (isDir) {
+            parsed.root = path;
+        }
+        else {
+            parsed.root = dirname(path);
+            parsed.open = path;
+        }
+    }
+    return parsed;
+}
+export async function main(argv = process.argv.slice(2)) {
+    let args;
+    try {
+        args = parseArgs(argv);
+    }
+    catch (error) {
+        if (error instanceof UsageError) {
+            process.stderr.write(`readm3: ${error.message}\n\n${USAGE}`);
+            process.exitCode = 2;
+            return;
+        }
+        throw error;
+    }
+    if (args.help) {
+        process.stdout.write(USAGE);
+        return;
+    }
+    if (args.version) {
+        process.stdout.write(`${VERSION}\n`);
+        return;
+    }
+    if (!process.stdout.isTTY) {
+        process.stderr.write("readm3: needs a terminal. Try `readm3 --help`.\n");
+        process.exitCode = 1;
+        return;
+    }
+    await run(args);
+}
+// Running the source directly (`bun src/cli.ts`, `node src/cli.ts`) should start
+// the reader. The published bin calls `main` itself, so this stays quiet there.
+if (process.argv[1] && import.meta.url === pathToFileURL(process.argv[1]).href) {
+    void main().catch((error) => {
+        process.stderr.write(`${error instanceof Error ? error.message : String(error)}\n`);
+        process.exit(1);
+    });
+}
+//# sourceMappingURL=cli.js.map

package/dist/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AACnC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAC7C,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAChD,OAAO,EAAE,GAAG,EAAsB,MAAM,aAAa,CAAC;AAEtD,MAAM,CAAC,MAAM,OAAO,GAAG,OAAO,CAAC;AAE/B,MAAM,KAAK,GAAG;;;;;;;;;8CASgC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;;;;;;;;;;;;;;CAcpF,CAAC;AAOF,MAAM,UAAW,SAAQ,KAAK;CAAG;AAEjC,MAAM,UAAU,SAAS,CAAC,IAAc;IACtC,MAAM,MAAM,GAAe;QACzB,IAAI,EAAE,OAAO,CAAC,GAAG,EAAE;QACnB,IAAI,EAAE,KAAK;QACX,OAAO,EAAE,KAAK;QACd,KAAK,EAAE,IAAI;QACX,GAAG,EAAE,KAAK;KACX,CAAC;IACF,IAAI,MAA0B,CAAC;IAE/B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACrC,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAW,CAAC;QAC9B,MAAM,IAAI,GAAG,GAAW,EAAE;YACxB,MAAM,KAAK,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;YACxB,IAAI,KAAK,KAAK,SAAS;gBAAE,MAAM,IAAI,UAAU,CAAC,GAAG,GAAG,gBAAgB,CAAC,CAAC;YACtE,OAAO,KAAK,CAAC;QACf,CAAC,CAAC;QAEF,QAAQ,GAAG,EAAE,CAAC;YACZ,KAAK,IAAI,CAAC;YACV,KAAK,QAAQ;gBACX,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC;gBACnB,MAAM;YACR,KAAK,IAAI,CAAC;YACV,KAAK,WAAW;gBACd,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC;gBACtB,MAAM;YACR,KAAK,IAAI,CAAC;YACV,KAAK,SAAS;gBACZ,MAAM,CAAC,KAAK,GAAG,IAAI,EAAE,CAAC;gBACtB,MAAM;YACR,KAAK,IAAI,CAAC;YACV,KAAK,SAAS,CAAC,CAAC,CAAC;gBACf,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;gBAC1C,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC;oBAAE,MAAM,IAAI,UAAU,CAAC,iCAAiC,CAAC,CAAC;gBACnG,MAAM,CAAC,OAAO,GAAG,KAAK,CAAC;gBACvB,MAAM;YACR,CAAC;YACD,KAAK,IAAI,CAAC;YACV,KAAK,OAAO;gBACV,MAAM,CAAC,GAAG,GAAG,IAAI,CAAC;gBAClB,MAAM;YACR,KAAK,IAAI,CAAC;YACV,KAAK,YAAY;gBACf,MAAM,CAAC,KAAK,GAAG,KAAK,CAAC;gBACrB,MAAM;YACR;gBACE,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,GAAG,KAAK,GAAG;oBAAE,MAAM,IAAI,UAAU,CAAC,mBAAmB,GAAG,EAAE,CAAC,CAAC;gBACvF,IAAI,MAAM,KAAK,SAAS;oBAAE,MAAM,IAAI,UAAU,CAAC,4BAA4B,CAAC,CAAC;gBAC7E,MAAM,GAAG,GAAG,CAAC;gBACb,MAAM;QACV,CAAC;IACH,CAAC;IAED,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;QAC7B,IAAI,KAAc,CAAC;QACnB,IAAI,CAAC;YACH,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC;QACvC,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,IAAI,UAAU,CAAC,8BAA8B,MAAM,EAAE,CAAC,CAAC;QAC/D,CAAC;QACD,IAAI,KAAK,EAAE,CAAC;YACV,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC;QACrB,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;YAC5B,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC;QACrB,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,IAAI,CAAC,OAAiB,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IAC/D,IAAI,IAAgB,CAAC;IACrB,IAAI,CAAC;QACH,IAAI,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;IACzB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,UAAU,EAAE,CAAC;YAChC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,KAAK,CAAC,OAAO,OAAO,KAAK,EAAE,CAAC,CAAC;YAC7D,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;YACrB,OAAO;QACT,CAAC;QACD,MAAM,KAAK,CAAC;IACd,CAAC;IAED,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;QACd,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC5B,OAAO;IACT,CAAC;IACD,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;QACjB,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,OAAO,IAAI,CAAC,CAAC;QACrC,OAAO;IACT,CAAC;IACD,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;QAC1B,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,kDAAkD,CAAC,CAAC;QACzE,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;QACrB,OAAO;IACT,CAAC;IAED,MAAM,GAAG,CAAC,IAAI,CAAC,CAAC;AAClB,CAAC;AAED,iFAAiF;AACjF,gFAAgF;AAChF,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,aAAa,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IAC/E,KAAK,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,KAAc,EAAE,EAAE;QACnC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACpF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,15 @@
+/**
+ * readm3 — a terminal markdown reader.
+ *
+ * The renderer and the file tree are exported so they can be reused: both are
+ * pure, and neither needs a terminal.
+ */
+export { renderMarkdown, parseInline, wrapSpans, plain, toText } from "./markdown.ts";
+export type { Line, Span, Role } from "./markdown.ts";
+export { scan, flatten, files, filterTree, matches, reveal, indexOfPath, label, MARKDOWN, DEFAULT_IGNORE, } from "./tree.ts";
+export type { Entry, FlatEntry, ScanOptions } from "./tree.ts";
+export { run } from "./viewer.ts";
+export type { ViewerOptions } from "./viewer.ts";
+export { main, parseArgs, VERSION } from "./cli.ts";
+export type { ParsedArgs } from "./cli.ts";
+//# 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;;;;;GAKG;AACH,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AACtF,YAAY,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AACtD,OAAO,EACL,IAAI,EACJ,OAAO,EACP,KAAK,EACL,UAAU,EACV,OAAO,EACP,MAAM,EACN,WAAW,EACX,KAAK,EACL,QAAQ,EACR,cAAc,GACf,MAAM,WAAW,CAAC;AACnB,YAAY,EAAE,KAAK,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAC/D,OAAO,EAAE,GAAG,EAAE,MAAM,aAAa,CAAC;AAClC,YAAY,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AACpD,YAAY,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC"}

package/dist/index.js

@@ -0,0 +1,11 @@
+/**
+ * readm3 — a terminal markdown reader.
+ *
+ * The renderer and the file tree are exported so they can be reused: both are
+ * pure, and neither needs a terminal.
+ */
+export { renderMarkdown, parseInline, wrapSpans, plain, toText } from "./markdown.js";
+export { scan, flatten, files, filterTree, matches, reveal, indexOfPath, label, MARKDOWN, DEFAULT_IGNORE, } from "./tree.js";
+export { run } from "./viewer.js";
+export { main, parseArgs, VERSION } from "./cli.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;;;;;GAKG;AACH,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAEtF,OAAO,EACL,IAAI,EACJ,OAAO,EACP,KAAK,EACL,UAAU,EACV,OAAO,EACP,MAAM,EACN,WAAW,EACX,KAAK,EACL,QAAQ,EACR,cAAc,GACf,MAAM,WAAW,CAAC;AAEnB,OAAO,EAAE,GAAG,EAAE,MAAM,aAAa,CAAC;AAElC,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC"}

package/dist/markdown.d.ts

@@ -0,0 +1,35 @@
+export type Role = "text" | "h1" | "h2" | "h3" | "code" | "fence" | "gutter" | "lang" | "link" | "url" | "quote" | "bullet" | "rule" | "meta" | "th";
+export interface Span {
+    text: string;
+    role?: Role;
+    bold?: boolean;
+    italic?: boolean;
+    underline?: boolean;
+    dim?: boolean;
+}
+export interface Line {
+    spans: Span[];
+}
+type Style = Omit<Span, "text">;
+/** The visible text of a line, with all styling dropped. Handy in tests. */
+export declare function plain(line: Line): string;
+/** Every line as plain text. */
+export declare function toText(lines: Line[]): string[];
+/**
+ * Fold the HTML that real READMEs are full of back into markdown.
+ *
+ * Inline code is held out of this: `Array<string>` must survive tag stripping.
+ */
+export declare function normalizeHtml(src: string): string;
+export declare function parseInline(src: string, base?: Style): Span[];
+/** Greedy word wrap that carries each word's styling with it. */
+export declare function wrapSpans(spans: Span[], width: number, first?: number, hanging?: number): Line[];
+/**
+ * Render markdown to styled lines already wrapped to `width`.
+ *
+ * `width` is the pane's interior, so a resize re-renders rather than reflows —
+ * cheap, and it keeps tables and code gutters honest.
+ */
+export declare function renderMarkdown(source: string, width: number): Line[];
+export {};
+//# sourceMappingURL=markdown.d.ts.map

package/dist/markdown.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"markdown.d.ts","sourceRoot":"","sources":["../src/markdown.ts"],"names":[],"mappings":"AASA,MAAM,MAAM,IAAI,GACZ,MAAM,GACN,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,MAAM,GACN,OAAO,GACP,QAAQ,GACR,MAAM,GACN,MAAM,GACN,KAAK,GACL,OAAO,GACP,QAAQ,GACR,MAAM,GACN,MAAM,GACN,IAAI,CAAC;AAET,MAAM,WAAW,IAAI;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,GAAG,CAAC,EAAE,OAAO,CAAC;CACf;AAED,MAAM,WAAW,IAAI;IACnB,KAAK,EAAE,IAAI,EAAE,CAAC;CACf;AAED,KAAK,KAAK,GAAG,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;AAehC,4EAA4E;AAC5E,wBAAgB,KAAK,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,CAExC;AAED,gCAAgC;AAChC,wBAAgB,MAAM,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,MAAM,EAAE,CAE9C;AAuDD;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAKjD;AAoBD,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,GAAE,KAAU,GAAG,IAAI,EAAE,CAEjE;AAkGD,iEAAiE;AACjE,wBAAgB,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,SAAI,EAAE,OAAO,SAAQ,GAAG,IAAI,EAAE,CAqD1F;AA0FD;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,EAAE,CAiOpE"}