@markitdownjs/core 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,66 @@
+# @markitdownjs/core
+
+[![npm](https://img.shields.io/npm/v/@markitdownjs/core)](https://www.npmjs.com/package/@markitdownjs/core)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+Core orchestration package for MarkItDownJS. Provides the plugin registry, document pipeline, and renderer — the central package most users install.
+
+## Install
+
+```bash
+npm install @markitdownjs/core
+```
+
+Install converter packages separately as needed:
+
+```bash
+npm install @markitdownjs/pdf @markitdownjs/docx @markitdownjs/html
+```
+
+## 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: fileBuffer, mimeType: "application/pdf" });
+console.log(result.markdown);
+```
+
+## Key Exports
+
+| Export | Description |
+|---|---|
+| `MarkItDown` | Main entry point — register converters, run conversions |
+| `MarkItDownOptions` | Configuration options for the `MarkItDown` constructor |
+| `DefaultConverterRegistry` | Built-in registry for managing converter plugins |
+| `DocumentPipeline` | Low-level pipeline for transforming `ConversionInput` → AST |
+| `MarkdownRenderer` | Renders a `DocumentNode` AST to Markdown string |
+| `MetadataExtractor` | Extracts title, author, dates, and other document metadata |
+| `AssetManager` | Handles embedded asset resolution (images, attachments) |
+
+## Options
+
+```ts
+const parser = new MarkItDown({
+  includeMetadata: true,
+  assetBasePath: "./assets",
+});
+```
+
+## Result Shape
+
+```ts
+interface ConversionResult {
+  markdown: string;
+  ast: DocumentNode;
+  metadata: Record<string, unknown>;
+}
+```
+
+---
+
+Part of the [MarkItDownJS](https://github.com/markitdownjs/markitdownjs) monorepo.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@markitdownjs/core",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Core document conversion pipeline for MarkItDownJS",
   "license": "MIT",
   "type": "module",
@@ -17,7 +17,7 @@
     "dist"
   ],
   "dependencies": {
-    "@markitdownjs/shared": "0.1.0"
+    "@markitdownjs/shared": "0.1.1"
   },
   "devDependencies": {
     "typescript": "^5.5.0",