pdf-to-md
Turn PDFs, scans, and Office documents into clean Markdown with one command, even 1,000-page books.
pdf-to-md is a command-line tool that converts documents to Markdown, HTML, or JSON with the Datalab Convert API, the hosted version of the open-source Marker engine. It handles the tedious parts for you: splitting big PDFs, uploading in parallel, retrying, stitching the results back together, and fixing page numbers and image links.
$ pdf-to-md books/
✓ darwin.pdf → darwin.md (516 pages, $1.55)
✓ tolstoy.pdf → tolstoy.md (537 pages, $1.61)
✓ grimm.pdf → grimm.md (510 pages, $1.53)
Done in 4m37s: 3 converted · 1563 pages · $4.69
Output from a real run (file names shortened): three scanned 19th-century books in English, Russian, and German Fraktur.
Why pdf-to-md
- Built for big documents. PDFs are split into page chunks that convert in parallel and are merged back into a single file. Page separators, anchors, and image links stay correct across chunks.
- Safe to re-run. Output names are deterministic (
report.pdf→report.md) and finished files are skipped. Re-running on a folder converts only what's new or failed, so you never pay twice by accident. - Honest about results. Every file reports its pages and cost. The exit code says whether anything failed. A bad API key stops the run immediately instead of failing file by file.
- Resilient. Rate limits, server errors, and dropped connections are retried with backoff. Ctrl-C stops cleanly without leaving half-written files.
- Made for scripting. Converted paths go to stdout, progress and errors to stderr, so it drops straight into pipelines and CI jobs.
- Any language, any era. Tested on modern PDFs, math, statistical tables from a faded microfiche, and scans of Cyrillic, blackletter German, and vertical classical Chinese (samples).
Installation
Requires Python 3.11 or newer. pipx installs it in its own isolated environment:
pipx install pdf-to-markdown-cli
uv tool install pdf-to-markdown-cli and pip install pdf-to-markdown-cli work too.
Then get an API key from datalab.to/app/keys and export it:
export DATALAB_API_KEY="your_api_key"
Quick start
pdf-to-md report.pdf
This writes report.md next to the PDF, plus a report_images/ folder if the document contains images. That's it.
Recipes
# Mirror a folder tree elsewhere
pdf-to-md ~/papers -o ~/papers-md
# Preview files and pages, at no cost
pdf-to-md ~/papers --dry-run
# Best quality for hard scans and tables
pdf-to-md scan.pdf --mode accurate
# First ten pages plus page 42 (0-based)
pdf-to-md book.pdf --page-range 0-9,42
# HTML or JSON instead of Markdown
pdf-to-md slides.pptx --html
pdf-to-md form.pdf --json
# Mark page boundaries in the output
pdf-to-md contract.pdf --paginate
# Text only: no images or descriptions
pdf-to-md manual.pdf --no-images \
--no-image-captions
# Redo everything, replacing old outputs
pdf-to-md ~/papers --overwrite
# Feed converted files to other tools
pdf-to-md ~/papers -q | xargs wc -w
How it works
- Plan. Inputs are discovered recursively. Hidden files and folders this tool generated earlier are ignored. Each input gets a deterministic output path, and inputs whose output already exists are skipped.
- Split. PDFs are cut into chunks of
--chunk-sizepages (default 25). Page selection with--page-rangeor--max-pageshappens here, so only those pages are uploaded and billed. Other formats are uploaded whole. - Convert. Up to
--concurrencychunks (default 5) are processed at once. Each one is uploaded and then polled until it's done. Throttling and server errors are retried, honoring the API'sRetry-After. - Merge. Chunk results are joined in page order. Page separators, HTML page ids, JSON block ids, and in-document anchors are renumbered to match the original document. Images are renamed so they never collide, and links to them are URL-encoded.
- Write. The output is written to a temporary file and renamed into place, so an interrupted run never leaves a partial file behind.
Output
papers/
├── report.pdf
├── report.md ← the document
└── report_images/ ← images, if any
- If two inputs would produce the same name (
a.pdfanda.docx), both keep their source extension:a.pdf.mdanda.docx.md. Names are compared case-insensitively, and an output never overwrites an input. - Hard-wrapped paragraph lines are joined in Markdown output (disable with
--keep-line-breaks). Image descriptions live in the image alt text.
Supported formats
| Input | Extensions |
|---|---|
.pdf (split into chunks) |
|
| Word processing | .doc .docx .odt |
| Presentations | .ppt .pptx .odp |
| Spreadsheets | .xls .xlsx .xlsm .xltx .ods .csv |
| Web and ebooks | .html .htm .epub |
| Images | .png .jpg .jpeg .webp .gif .tiff .tif |
Outputs are Markdown (.md, the default), HTML (.html), or JSON (.json, Marker's block tree with page and position data). The API accepts files of up to 200 MB. Non-PDF files are always sent as a single request.
Quality, speed, and cost
--mode picks a Datalab processing mode:
| Mode | Use it for |
|---|---|
fast (API default) |
Clean digital PDFs and good scans. |
balanced |
Mixed documents with tables, forms, or harder layouts. |
accurate |
The hardest material: poor scans, dense tables, handwriting. |
Every result line shows what Datalab billed, and the run summary adds it up. In our September 2026 test runs, conversions cost about 0.3¢ per page ($3 per 1,000 pages). See Datalab's pricing for current rates.
Throughput depends on your plan's limits. With the default of 5 concurrent requests (the free tier's limit), the 1,563-page run above took 4 minutes 37 seconds. Paid plans allow far more concurrency, so raise -j to match yours.
Sample conversions
examples/ holds sample documents next to their actual output from this tool:
| Sample (links to output) | Language | What it tests |
|---|---|---|
| Alice in Wonderland | English | Illustrated novel, curly quotes |
| Algebraic geometry notes | English | Mathematics rendered as LaTeX |
| Origin of Species (1859) | English | Old scan, fold-out tree diagram |
| War and Peace (1937 ed.) | Russian | Cyrillic mixed with French, footnotes |
| Grimm's Fairy Tales (1857) | German | Fraktur blackletter typeface |
| Shijing Gupu (1908) | Chinese | Vertical text, music notation |
| 1880 Census tables | English | Microfiche scan, side-by-side tables |
| 1980 Census ancestry | English | Dense table, two-level headers |
See examples/README.md for sources and how the samples are used in tests.
Command reference
pdf-to-md INPUT [INPUT ...] [options]
INPUT is any mix of files and directories. The tool also runs as python -m docs_to_md.
Output
| Option | Description |
|---|---|
-f, --format FMT |
markdown (default), html, or json. --html and --json are shortcuts. |
-o, --output-dir DIR |
Write here instead of next to each input. Folder structure under directory inputs is mirrored. |
--overwrite |
Replace existing outputs instead of skipping those inputs. |
--keep-line-breaks |
Keep hard-wrapped paragraph lines in Markdown. |
Conversion
| Option | Description |
|---|---|
--backend NAME |
Conversion service. Default and currently only choice: datalab. |
-m, --mode MODE |
fast (the API default), balanced, or accurate. |
--paginate |
Insert page separators. |
--no-images |
Don't extract images. |
--no-image-captions |
Don't generate image descriptions. |
--skip-cache |
Ignore Datalab's server-side cache of previous results. |
--api-option KEY=VALUE |
Send any other Convert API field. Repeatable, e.g. --api-option extras=extract_links. |
Pages and chunking
| Option | Description |
|---|---|
--page-range RANGE |
0-based pages to convert, e.g. 0,5-10. |
--max-pages N |
Convert at most N pages of each document. |
--chunk-size N |
PDF pages per request. Default: 25. Smaller chunks mean more parallelism but more requests. |
--no-chunk |
Send each PDF as one request. |
Run control
| Option | Description |
|---|---|
--api-key KEY |
API key. Prefer the environment variable, which keeps the key out of shell history. |
-j, --concurrency N |
Requests in flight at once. Default: 5. |
--timeout SECONDS |
Give up on a single request after this long. Default: 3600. |
-n, --dry-run |
Show what would be converted, with page and chunk counts. Makes no API calls and needs no key. |
-q, --quiet |
Print only errors (converted paths still go to stdout). |
-v, --verbose |
Print debug logs, including every API call and retry. |
--version |
Print the version and exit. |
Scripting and automation
Only converted file paths are printed to stdout, one per line. Status lines, the progress bar, and errors go to stderr.
| Exit status | Meaning |
|---|---|
0 |
Every input was converted or skipped. |
1 |
At least one file failed; the rest were still converted. |
2 |
Usage or configuration error, including a rejected API key or an exhausted account. |
130 |
Interrupted with Ctrl-C. |
Because finished files are skipped, the simplest way to retry failures in an interrupted batch is to run the same command again.
Configuration
| Variable | Purpose |
|---|---|
DATALAB_API_KEY |
API key, the same variable Datalab's SDK uses. The pre-1.0 name MARKER_PDF_KEY also works. --api-key overrides both. |
NO_COLOR |
Disable colored output. |
The tool keeps no state between runs. Temporary chunk files live in the system temp directory and are deleted when the run ends.
Troubleshooting
| Message | What to do |
|---|---|
No API key found |
Set DATALAB_API_KEY. |
Authentication failed |
The key was rejected. Check it on the Datalab dashboard. |
Payment required |
Your Datalab account is out of credits. |
exists (use --overwrite) |
The output is already there. Add --overwrite to redo it. |
timed out |
A request took longer than --timeout. Raise it, or lower --chunk-size. |
| Frequent throttling | You're above your plan's limits (the free tier allows 10 requests per minute). Lower -j. |
Anything else: rerun with -v and open an issue with the output.
Upgrading from 0.x
Version 1.0 moved to Datalab's current /api/v1/convert endpoint and fixed --html and --json, which produced no output in 0.5.x.
- Outputs are now
report.md+report_images/instead ofreport_<random>.md+images_<random>/, and existing outputs are skipped unless you pass--overwrite. -oaccepts relative paths and mirrors folder structure.--llmnow means--mode balancedand--maxmeans--mode accurate. Datalab removed the options behind--strip,--force, and--langs, so those flags are ignored with a warning.--pages,--noimg,-cs, and-mpstill work as aliases of--paginate,--no-images,--chunk-size, and--max-pages.- Failures now exit non-zero, and
~/.docs_to_md/is no longer used and can be deleted.
Full details are in the changelog.
Contributing
Bug reports, ideas, and pull requests are welcome. CONTRIBUTING.md covers setup, the test suites (including the opt-in live API tests), and the release process.
Acknowledgements
Conversion quality comes from Marker and the Datalab API. This is an independent project and isn't affiliated with Datalab.
License
MIT © Nikita Sokolsky
Metadata
Release files for pdf-to-markdown-cli 1.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| pdf_to_markdown_cli-1.2.0.tar.gz | 8.9 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pdf_to_markdown_cli-1.2.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 8.9 MB
Release files / pdf_to_markdown_cli-1.2.0.tar.gz
| Download URL | pdf_to_markdown_cli-1.2.0.tar.gz |
|---|---|
| Size | 8.9 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
955eee4511b45435d7b3b2b9efc3b6fd89f4973142e96e6cc4265cd355e93fcf
|
|
BLAKE2b-256 checksum How to use checksums |
a9cb890a87e08b4145b7a5b826639d71b2a5597c02df41f12551c613a3957ed1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 29, 2026.
Transparency logRelease files / pdf_to_markdown_cli-1.2.0-py3-none-any.whl
| Download URL | pdf_to_markdown_cli-1.2.0-py3-none-any.whl |
|---|---|
| Size | 36.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1b27cfe7f639d83d4999322a0d55484664d972723fa250bc4634e6f398f0c782
|
|
BLAKE2b-256 checksum How to use checksums |
e0911ad92aa662043c4ec084777bfa1aa2c0a87c49a3d49e862cb9f2fd10bef4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 29, 2026.
Transparency log