@ryangarber/markitdown-ts 0.1.1 → 0.1.2
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/LICENSE +1 -0
- package/README.md +9 -13
- package/package.json +1 -1
package/LICENSE
CHANGED
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# markitdown-ts
|
|
2
2
|
|
|
3
|
-
`markitdown-ts` converts
|
|
3
|
+
`markitdown-ts` converts various file types to Markdown without filesystem, process, stream, or any other runtime-specific dependencies. It can run in browsers, workers, edge functions, and all other modern JavaScript environments.
|
|
4
4
|
|
|
5
5
|
## Supported formats
|
|
6
6
|
|
|
@@ -14,23 +14,21 @@
|
|
|
14
14
|
- ZIP archives (`.zip`), with nested files converted recursively
|
|
15
15
|
- Wikipedia, YouTube metadata, and Bing result pages supplied as HTML
|
|
16
16
|
|
|
17
|
-
Audio, image metadata, local-path, and YouTube transcript features from the original project are intentionally
|
|
18
|
-
They may be added back over time as alternative implementations are found. Want to see one added? Contributions are welcome!
|
|
17
|
+
Audio, image metadata, local-path, and YouTube transcript features from the original project are intentionally left out because their implementations depended on runtime-specific modules, binaries, streams, or filesystem access. They may be added back over time as alternative implementations are found. Want to see one added? Contributions are welcome!
|
|
19
18
|
|
|
20
19
|
## Installation
|
|
21
20
|
|
|
22
21
|
```sh
|
|
23
|
-
|
|
22
|
+
pnpm install @ryangarber/markitdown-ts
|
|
24
23
|
```
|
|
25
24
|
|
|
26
25
|
## Usage
|
|
27
26
|
|
|
28
|
-
### `Uint8Array` (preferred)
|
|
29
|
-
|
|
30
27
|
```ts
|
|
31
|
-
import { MarkItDown } from "markitdown-ts";
|
|
28
|
+
import { MarkItDown } from "@ryangarber/markitdown-ts";
|
|
29
|
+
|
|
30
|
+
const bytes: Uint8Array = /* plain bytes */;
|
|
32
31
|
|
|
33
|
-
const bytes = new TextEncoder().encode("Hello from the web");
|
|
34
32
|
const result = await new MarkItDown().convert(bytes, {
|
|
35
33
|
file_extension: ".txt"
|
|
36
34
|
});
|
|
@@ -38,14 +36,11 @@ const result = await new MarkItDown().convert(bytes, {
|
|
|
38
36
|
console.log(result?.markdown);
|
|
39
37
|
```
|
|
40
38
|
|
|
41
|
-
Any `Uint8Array` subclass is accepted as well. This keeps byte data from other modern JavaScript runtimes interoperable without requiring runtime-specific types.
|
|
42
|
-
|
|
43
|
-
### Other in-memory sources
|
|
44
|
-
|
|
45
39
|
The same `convert` method accepts:
|
|
46
40
|
|
|
41
|
+
- `Uint8Array`
|
|
47
42
|
- `ArrayBuffer` and `SharedArrayBuffer`
|
|
48
|
-
-
|
|
43
|
+
- `DataView` or any other typed array
|
|
49
44
|
- `Blob` and `File`
|
|
50
45
|
- `Response`
|
|
51
46
|
|
|
@@ -105,4 +100,5 @@ Biome handles both formatting and linting. `tsup` produces ESM, CommonJS, source
|
|
|
105
100
|
|
|
106
101
|
## License
|
|
107
102
|
|
|
103
|
+
MIT License © 2026 Ryan Garber\
|
|
108
104
|
MIT License © 2024 Vaibhav Raj
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ryangarber/markitdown-ts",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.2",
|
|
4
4
|
"description": "Convert various file formats to Markdown for indexing, text analysis, and other applications that benefit from structured text. Node-free fork of the TypeScript fork of the original Python library.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"markdown",
|