html-to-markdown-node 2.3.1

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright 2024-2025 Na'aman Hirschfeld
+
+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,229 @@
+# html-to-markdown-node
+
+Native Node.js and Bun bindings for html-to-markdown using NAPI-RS v3.
+
+High-performance HTML to Markdown conversion using native Rust code compiled to platform-specific binaries.
+
+[![npm version](https://badge.fury.io/js/%40html-to-markdown%2Fnode.svg)](https://www.npmjs.com/package/html-to-markdown-node)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/Goldziher/html-to-markdown/blob/main/LICENSE)
+
+## Performance
+
+Native NAPI-RS bindings deliver **the fastest HTML to Markdown conversion** available in JavaScript.
+
+### Benchmark Results (Apple M4)
+
+| Document Type              | ops/sec    | Notes              |
+| -------------------------- | ---------- | ------------------ |
+| **Small (5 paragraphs)**   | **86,233** | Simple documents   |
+| **Medium (25 paragraphs)** | **18,979** | Nested formatting  |
+| **Large (100 paragraphs)** | **4,907**  | Complex structures |
+| **Tables (20 tables)**     | **5,003**  | Table processing   |
+| **Lists (500 items)**      | **1,819**  | Nested lists       |
+| **Wikipedia (129KB)**      | **1,125**  | Real-world content |
+| **Wikipedia (653KB)**      | **156**    | Large documents    |
+
+**Average: ~18,162 ops/sec** across varied workloads.
+
+### Comparison
+
+- **vs WASM**: ~1.17× faster (native has zero startup time, direct memory access)
+- **vs Python**: ~7.4× faster (avoids FFI overhead)
+- **Best for**: Node.js and Bun server-side applications requiring maximum throughput
+
+## Installation
+
+### Node.js
+
+```bash
+npm install html-to-markdown-node
+# or
+yarn add html-to-markdown-node
+# or
+pnpm add html-to-markdown-node
+```
+
+### Bun
+
+```bash
+bun add html-to-markdown-node
+```
+
+## Usage
+
+### Node.js (CommonJS)
+
+```javascript
+const { convert } = require('html-to-markdown-node');
+
+const html = '<h1>Hello World</h1><p>This is <strong>fast</strong>!</p>';
+const markdown = convert(html);
+console.log(markdown);
+// # Hello World
+//
+// This is **fast**!
+```
+
+### Node.js (ESM)
+
+```javascript
+import { convert } from 'html-to-markdown-node';
+
+const markdown = convert('<h1>Hello</h1>', {
+  headingStyle: 'Atx',
+  codeBlockStyle: 'Backticks',
+  wrap: true,
+  wrapWidth: 80
+});
+```
+
+### Bun
+
+```typescript
+import { convert } from 'html-to-markdown-node';
+
+const html = await Bun.file('input.html').text();
+const markdown = convert(html, {
+  headingStyle: 'Atx',
+  listIndentWidth: 2,
+  bullets: '-'
+});
+
+await Bun.write('output.md', markdown);
+```
+
+## TypeScript
+
+Full TypeScript definitions included:
+
+```typescript
+import { convert, convertWithInlineImages, type JsConversionOptions } from 'html-to-markdown-node';
+
+const options: JsConversionOptions = {
+  headingStyle: 'Atx',
+  codeBlockStyle: 'Backticks',
+  listIndentWidth: 2,
+  bullets: '-',
+  wrap: true,
+  wrapWidth: 80
+};
+
+const markdown = convert('<h1>Hello</h1>', options);
+```
+
+## Inline Images
+
+Extract and decode inline images (data URIs, SVG):
+
+```typescript
+import { convertWithInlineImages } from 'html-to-markdown-node';
+
+const html = '<img src="data:image/png;base64,iVBORw0..." alt="Logo">';
+
+const result = convertWithInlineImages(html, null, {
+  maxDecodedSizeBytes: 5 * 1024 * 1024, // 5MB
+  inferDimensions: true,
+  filenamePrefix: 'img_',
+  captureSvg: true
+});
+
+console.log(result.markdown);
+console.log(`Extracted ${result.inlineImages.length} images`);
+
+for (const img of result.inlineImages) {
+  console.log(`${img.filename}: ${img.format}, ${img.data.length} bytes`);
+  // Save image data to disk
+  require('fs').writeFileSync(img.filename, img.data);
+}
+```
+
+## Supported Platforms
+
+Pre-built native binaries are provided for:
+
+| Platform    | Architectures                                       |
+| ----------- | --------------------------------------------------- |
+| **macOS**   | x64 (Intel), ARM64 (Apple Silicon)                  |
+| **Linux**   | x64 (glibc/musl), ARM64 (glibc/musl), ARMv7 (glibc) |
+| **Windows** | x64, ARM64                                          |
+
+### Runtime Compatibility
+
+✅ **Node.js** 18+ (LTS)
+✅ **Bun** 1.0+ (full NAPI-RS support)
+❌ **Deno** (use [html-to-markdown-wasm](https://www.npmjs.com/package/html-to-markdown-wasm) instead)
+
+## When to Use
+
+Choose `html-to-markdown-node` when:
+
+- ✅ Running in Node.js or Bun
+- ✅ Maximum performance is required
+- ✅ Server-side conversion at scale
+
+Use [`html-to-markdown-wasm`](https://www.npmjs.com/package/html-to-markdown-wasm) for:
+
+- 🌐 Browser/client-side conversion
+- 🦕 Deno runtime
+- ☁️ Edge runtimes (Cloudflare Workers, Deno Deploy)
+- 📦 Universal packages
+
+## Configuration Options
+
+See [ConversionOptions](https://github.com/Goldziher/html-to-markdown/tree/main/crates/html-to-markdown-node#types) for all available options including:
+
+- Heading styles (ATX, underlined, ATX closed)
+- Code block styles (indented, backticks, tildes)
+- List formatting (indent width, bullet characters)
+- Text escaping and formatting
+- Preprocessing for web scraping
+- hOCR table extraction
+- And more...
+
+## Examples
+
+### Web Scraping
+
+```javascript
+const { convert } = require('html-to-markdown-node');
+
+const scrapedHtml = await fetch('https://example.com').then(r => r.text());
+
+const markdown = convert(scrapedHtml, {
+  preprocessing: {
+    enabled: true,
+    preset: 'Aggressive',
+    removeNavigation: true,
+    removeForms: true
+  },
+  headingStyle: 'Atx',
+  codeBlockStyle: 'Backticks'
+});
+```
+
+### hOCR Document Processing
+
+```javascript
+const { convert } = require('html-to-markdown-node');
+const fs = require('fs');
+
+// OCR output from Tesseract in hOCR format
+const hocrHtml = fs.readFileSync('scan.hocr', 'utf8');
+
+// Automatically detects hOCR and reconstructs tables
+const markdown = convert(hocrHtml, {
+  hocrSpatialTables: true  // Enable spatial table reconstruction
+});
+```
+
+## Links
+
+- [GitHub Repository](https://github.com/Goldziher/html-to-markdown)
+- [Full Documentation](https://github.com/Goldziher/html-to-markdown/blob/main/README.md)
+- [WASM Package](https://www.npmjs.com/package/html-to-markdown-wasm)
+- [Python Package](https://pypi.org/project/html-to-markdown/)
+- [Rust Crate](https://crates.io/crates/html-to-markdown-rs)
+
+## License
+
+MIT

package/package.json

@@ -0,0 +1,67 @@
+{
+  "name": "html-to-markdown-node",
+  "version": "2.3.1",
+  "description": "High-performance HTML to Markdown converter - Node.js native bindings",
+  "main": "index.js",
+  "types": "index.d.ts",
+  "repository": "https://github.com/Goldziher/html-to-markdown",
+  "license": "MIT",
+  "keywords": [
+    "html",
+    "markdown",
+    "converter",
+    "rust",
+    "napi",
+    "native"
+  ],
+  "files": [
+    "index.js",
+    "index.d.ts"
+  ],
+  "napi": {
+    "binaryName": "html-to-markdown-node",
+    "targets": [
+      "x86_64-apple-darwin",
+      "aarch64-apple-darwin",
+      "x86_64-pc-windows-msvc",
+      "aarch64-pc-windows-msvc",
+      "x86_64-unknown-linux-gnu",
+      "x86_64-unknown-linux-musl",
+      "aarch64-unknown-linux-gnu",
+      "aarch64-unknown-linux-musl",
+      "armv7-unknown-linux-gnueabihf"
+    ]
+  },
+  "engines": {
+    "node": ">= 10"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "devDependencies": {
+    "@napi-rs/cli": "^3.3.1",
+    "@types/node": "^24.7.2",
+    "tinybench": "^5.0.1",
+    "tsx": "^4.20.6",
+    "vitest": "^3.0.0"
+  },
+  "dependencies": {
+    "@emnapi/runtime": "1.5.0",
+    "@octokit/core": "7.0.5",
+    "typanion": "3.14.0",
+    "up": "^1.0.2"
+  },
+  "scripts": {
+    "artifacts": "napi artifacts",
+    "build": "napi build --platform --release",
+    "build:debug": "napi build --platform",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:simple": "node test.js",
+    "bench": "tsx benchmark.ts",
+    "universal": "napi universal",
+    "version": "napi version",
+    "clean": "rm -rf dist node_modules *.node"
+  }
+}