mirror of
https://github.com/firecrawl/anydoc.git
synced 2026-09-14 14:18:33 +08:00
tomsideguide
118 lines
5.8 KiB
Markdown
118 lines
5.8 KiB
Markdown
# @firecrawl/anydoc
|
|
|
|
[](https://www.npmjs.com/package/@firecrawl/anydoc)
|
|
[](https://github.com/firecrawl/anydoc/blob/main/LICENSE)
|
|
|
|
Convert Word, PowerPoint, Excel, OpenDocument, RTF, EPUB, CSV, and PDF files into clean GitHub-Flavored Markdown. Node.js bindings for the [anydoc](https://github.com/firecrawl/anydoc) Rust crate, built by [Firecrawl](https://firecrawl.dev). Also available as a hosted API through [Firecrawl Parse](https://firecrawl.dev/parse), which adds our OCR models for the scanned pages anydoc can't read on its own.
|
|
|
|
Every format parses into one shared document model and renders through a single Markdown serializer, so headings, tables, lists, and footnotes come out the same no matter which format goes in. Conversion runs on the libuv thread pool and never blocks the event loop. TypeScript types ship with the package.
|
|
|
|
```bash
|
|
npm install @firecrawl/anydoc
|
|
```
|
|
|
|
## Supported formats
|
|
|
|
| Format | Extensions |
|
|
| ---------------- | ---------------------------------------------------------- |
|
|
| Word | `.doc`, `.docx`, `.docm` |
|
|
| PowerPoint | `.ppt`, `.pps`, `.pot`, `.pptx`, `.pptm`, `.ppsx`, `.ppsm` |
|
|
| Excel | `.xls`, `.xlsx`, `.xlsm`, `.xlsb` |
|
|
| OpenDocument | `.odt`, `.ods`, `.odp` |
|
|
| Rich Text Format | `.rtf` |
|
|
| EPUB | `.epub` |
|
|
| CSV | `.csv` |
|
|
| PDF | `.pdf` |
|
|
|
|
## CLI
|
|
|
|
The package ships an `anydoc` command, so `npx` converts a document with no install:
|
|
|
|
```bash
|
|
npx @firecrawl/anydoc report.docx # Markdown to stdout
|
|
npx @firecrawl/anydoc slides.pptx -o slides.md # or to a file
|
|
npx @firecrawl/anydoc - --format csv < data.csv # read stdin
|
|
```
|
|
|
|
Markdown goes to stdout, errors to stderr, and `anydoc --help` covers the rest.
|
|
|
|
## Usage
|
|
|
|
```js
|
|
import { toDocument, toMarkdown, toMarkdownBytes, toMarkdownPages } from '@firecrawl/anydoc';
|
|
|
|
// From a file path:
|
|
const markdown = await toMarkdown('report.docx');
|
|
|
|
// From bytes, with the format detected from the content:
|
|
const fromBytes = await toMarkdownBytes(bytes);
|
|
|
|
// Or name it, which signature-less formats (CSV) need:
|
|
const fromCsv = await toMarkdownBytes(bytes, 'csv');
|
|
|
|
// Or stop at the document model, which also carries embedded assets:
|
|
const document = await toDocument(bytes);
|
|
|
|
// A PDF can also come out one page at a time, marking the pages that need OCR:
|
|
const pages = await toMarkdownPages(bytes);
|
|
```
|
|
|
|
## Scanned pages
|
|
|
|
anydoc does not do OCR: a PDF with scanned or image-only pages rejects with `needsOcr` naming them. Pass `ocr: 'hosted'` to send such a document to [Firecrawl Parse](https://firecrawl.dev/parse) instead, through the [`firecrawl`](https://www.npmjs.com/package/firecrawl) package (`npm install firecrawl`). The key comes from `apiKey` or `FIRECRAWL_API_KEY`; without one the keyless tier applies, rate-limited per IP. Documents anydoc converts itself never leave the machine.
|
|
|
|
```js
|
|
const markdown = await toMarkdown('scan.pdf', { ocr: 'hosted' });
|
|
```
|
|
|
|
On the CLI, `anydoc scan.pdf --ocr hosted`, with `--api-key` or `FIRECRAWL_API_KEY`.
|
|
|
|
## Errors
|
|
|
|
A conversion rejects only when no complete Markdown could come out of the file. The rejection is an `Error` whose `code` names what went wrong:
|
|
|
|
```js
|
|
try {
|
|
return await toMarkdown(path);
|
|
} catch (error) {
|
|
// No document comes out of these, so record the file and take the next one.
|
|
if (error.code === 'encrypted' || error.code === 'unsupported') {
|
|
unconverted.push({ path, reason: error.code });
|
|
return null;
|
|
}
|
|
throw error;
|
|
}
|
|
```
|
|
|
|
| `code` | Meaning |
|
|
| --------------- | ------------------------------------------------------------------- |
|
|
| `unsupported` | Unknown format, or one that cannot be converted |
|
|
| `needsOcr` | Pages of a PDF are scanned or image-only; `pages` names them |
|
|
| `malformed` | Structurally unusable: no meaningful content could be extracted |
|
|
| `encrypted` | Encrypted or password-protected |
|
|
| `resourceLimit` | Crossed a fixed safety limit (decompression, nesting, node count) |
|
|
| `missingPart` | A part required for any meaningful output is absent |
|
|
| `io` | The file could not be read, from `toMarkdown` only |
|
|
|
|
`error.message` carries the detail, naming the package part at fault where the format identifies one. TypeScript gets the union as `ConvertErrorCode`.
|
|
|
|
## Format detection
|
|
|
|
The format is read from the file content, using the marker its specification designates: the PDF header, the RTF open group, OLE stream names, the ZIP package mimetype and content types. CSV has no such marker, so detection returns `null` for it and the extension, or an explicit format, names it instead.
|
|
|
|
```js
|
|
formatFromBytes(bytes); // 'docx', or null when nothing matches
|
|
formatFromExtension('.pptm'); // 'pptx'
|
|
formatFromPath('report.odt'); // 'odt'
|
|
```
|
|
|
|
## Images and embedded objects
|
|
|
|
Markdown cannot embed bytes, so an embedded image renders as its alt text while the bytes stay on `document.assets`, tagged with a media type and the part they came from. Images that carry an external URL render as ordinary Markdown images.
|
|
|
|
Full behavior notes and benchmarks live in the [repository README](https://github.com/firecrawl/anydoc#readme).
|
|
|
|
## License
|
|
|
|
[MIT](https://github.com/firecrawl/anydoc/blob/main/LICENSE)
|