@mdgate/containers 0.6.8 → 0.6.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +39 -4
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -1,7 +1,42 @@
|
|
|
1
1
|
# @mdgate/containers
|
|
2
2
|
|
|
3
|
-
ZIP/OPC
|
|
3
|
+
**Internal ZIP/OPC, OLE, and XML helpers for mdgate converters.**
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
5
|
+
This package is a shared library used by format converters. Install a converter package (for example [`@mdgate/docx`](https://github.com/mdgate/converters/tree/main/packages/docx)) or [`@mdgate/converters`](https://github.com/mdgate/converters/tree/main/packages/converters) instead of depending on this directly.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## What it provides
|
|
10
|
+
|
|
11
|
+
* ZIP / OPC package reading
|
|
12
|
+
* OLE compound files (CFB)
|
|
13
|
+
* a namespace-aware XML parser
|
|
14
|
+
* container-level format detection (which Office, ODF, EPUB, or iWork package a ZIP or OLE file is)
|
|
15
|
+
|
|
16
|
+
Format packages use these primitives. Applications should not need them.
|
|
17
|
+
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
## Need a complete reader?
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
npm install @mdgate/converters
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
```ts
|
|
27
|
+
import { toMarkdown } from '@mdgate/converters';
|
|
28
|
+
|
|
29
|
+
const markdown = await toMarkdown(bytes, {
|
|
30
|
+
path: filename,
|
|
31
|
+
});
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
[`@mdgate/containers`](https://github.com/mdgate/converters/tree/main/packages/containers) is part of the open-source [`mdgate/converters`](https://github.com/mdgate/converters) project.
|
|
35
|
+
|
|
36
|
+
For AI agents, the same converter architecture can be used to extend `read_file` from text files to real-world document formats.
|
|
37
|
+
|
|
38
|
+
---
|
|
39
|
+
|
|
40
|
+
## License
|
|
41
|
+
|
|
42
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@mdgate/containers",
|
|
3
|
-
"version": "0.6.
|
|
3
|
+
"version": "0.6.9",
|
|
4
4
|
"description": "mdgate container parsing: ZIP/OPC packages, OLE compound files, XML",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"license": "MIT",
|
|
7
|
-
"homepage": "https://
|
|
7
|
+
"homepage": "https://convert.mdgate.dev",
|
|
8
8
|
"repository": {
|
|
9
9
|
"type": "git",
|
|
10
10
|
"url": "git+https://github.com/mdgate/converters.git",
|
|
@@ -28,8 +28,8 @@
|
|
|
28
28
|
"prepublishOnly": "bun run build"
|
|
29
29
|
},
|
|
30
30
|
"dependencies": {
|
|
31
|
-
"@mdgate/core": "0.6.
|
|
32
|
-
"@mdgate/utils": "0.6.
|
|
31
|
+
"@mdgate/core": "0.6.9",
|
|
32
|
+
"@mdgate/utils": "0.6.9"
|
|
33
33
|
},
|
|
34
34
|
"publishConfig": {
|
|
35
35
|
"access": "public"
|