@markitdownjs/pdf 0.1.0 → 0.1.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 MarkItDownJS 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,57 @@
+# @markitdownjs/pdf
+
+[![npm](https://img.shields.io/npm/v/@markitdownjs/pdf)](https://www.npmjs.com/package/@markitdownjs/pdf)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+PDF to AST converter for MarkItDownJS, powered by `pdfjs-dist`. Extracts text content, document structure, metadata, and page information.
+
+## Install
+
+```bash
+npm install @markitdownjs/pdf
+```
+
+`pdfjs-dist` is a peer dependency and will be installed automatically.
+
+## Usage
+
+```ts
+import { MarkItDown } from "@markitdownjs/core";
+import { PdfConverter } from "@markitdownjs/pdf";
+
+const parser = new MarkItDown();
+parser.registerConverter(new PdfConverter());
+
+const result = await parser.convert({ source: pdfBuffer, mimeType: "application/pdf" });
+console.log(result.markdown);
+```
+
+## Key Exports
+
+| Export | Description |
+|---|---|
+| `PdfConverter` | Converter plugin — register with `MarkItDown` |
+
+## What Gets Extracted
+
+- Text content with paragraph and heading detection
+- Page boundaries (preserved as `pageNumber` in AST nodes)
+- Document metadata: title, author, creation date, subject
+- Multi-column layout heuristics
+
+## Options
+
+```ts
+parser.registerConverter(new PdfConverter({
+  extractMetadata: true,
+  preservePageBreaks: true,
+}));
+```
+
+## Accepted MIME Types
+
+- `application/pdf`
+
+---
+
+Part of the [MarkItDownJS](https://github.com/markitdownjs/markitdownjs) monorepo.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@markitdownjs/pdf",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "PDF converter for MarkItDownJS",
   "license": "MIT",
   "type": "module",
@@ -18,8 +18,8 @@
   ],
   "dependencies": {
     "pdfjs-dist": "^4.0.0",
-    "@markitdownjs/shared": "0.1.0",
-    "@markitdownjs/ast": "0.1.0"
+    "@markitdownjs/ast": "0.1.1",
+    "@markitdownjs/shared": "0.1.1"
   },
   "devDependencies": {
     "typescript": "^5.5.0"