Skip to main content

pdf-to-md

Turn PDFs, scans, and Office documents into clean Markdown with one command, even 1,000-page books.

PyPI Python 3.11+ CI GitHub release License: MIT

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 can also transcribe PDFs and images with OpenAI's GPT-Luna, called directly or through OpenRouter. 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, vertical classical Chinese, Arabic, Hebrew, polytonic Greek, Devanagari, and 1687 Latin (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"

To use GPT-Luna instead, export OPENAI_API_KEY or OPENROUTER_API_KEY and pass --backend openai or --backend openrouter.

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

# Transcribe with GPT-Luna
pdf-to-md scan.pdf --backend openai
pdf-to-md scan.pdf --backend openrouter

# 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

  1. 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.
  2. Split. PDFs are cut into chunks of --chunk-size pages (default 25 for Datalab, 5 for GPT-Luna). Page selection with --page-range or --max-pages happens here, so only those pages are uploaded and billed. Other formats are uploaded whole.
  3. Convert. Up to --concurrency chunks (default 5) are processed at once. Each one is uploaded, then polled until it's done (Datalab) or answered in one request (GPT-Luna). Throttling and server errors are retried, honoring the API's Retry-After.
  4. 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.
  5. 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.pdf and a.docx), both keep their source extension: a.pdf.md and a.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 .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.

Transcribing with GPT-Luna

--backend openai sends each chunk to OpenAI's GPT-6 Luna, a low-cost vision model, through the Responses API. --backend openrouter sends the same request to the same model through OpenRouter. The model sees each page's image and its text layer and writes one transcription per page. The tool checks that it got exactly one page back for every page sent, then merges the pages the same way as Datalab results.

Datalab (default) GPT-Luna
Inputs PDFs, Office, ebooks, images PDFs and images
Outputs Markdown, HTML, JSON Markdown, HTML
Figures Extracted as image files Described in text
Pages per request 25 5
--mode Datalab processing mode Reasoning effort

Datalab remains the default. GPT-Luna runs only when you choose it with --backend.

In September 2026 test runs, GPT-Luna transcribed all 25 sample pages for about 2¢ on either route. That's 0.08¢ per page on average and about 0.2¢ for the dense census tables, versus about 0.3¢ per page on Datalab. Both routes bill the same token rates, and results show the cost of each file. For half price in exchange for slower responses, add --api-option service_tier=flex (OpenAI only).

--mode maps to reasoning effort: fast is none, balanced (the default) is low, and accurate is medium. In balanced mode every sample passed its checks, including the 1880 microfiche table that needs Datalab's accurate mode. As with any language model, output can vary between runs: in repeated tests it occasionally dropped a heading label or a LaTeX backslash.

--model picks another model, such as gpt-5.6-luna. OpenRouter adds the openai/ prefix when the name has none, so the same flag works on both routes. --api-option KEY=VALUE adds any other Responses API field, with JSON values decoded, e.g. --api-option max_output_tokens=32000.

Keep chunks small. In testing, a 16-page request came back with pages split apart, while 5- and 8-page chunks were exact. If a chunk comes back with the wrong page count, it's retried once, then the file fails with a hint to lower --chunk-size.

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
Lane's Arabic-English Lexicon (1863) Arabic, English Three columns, vocalized Arabic inline
Gesenius' Hebrew Grammar (1898) Hebrew, English Pointed Hebrew paradigms, margin letters
Loeb Odyssey (1919) Greek, English Polytonic Greek, critical apparatus
Bhagavad-Gita (1922) Sanskrit, English Devanagari on a cropped scan
Newton's Principia (1687) Latin Long s, ligatures, inline diagram

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 datalab (default), openai, or openrouter.
-m, --mode MODE fast, balanced, or accurate. Defaults to fast on Datalab and balanced on GPT-Luna.
--model NAME GPT-Luna backends only. Default: gpt-6-luna.
--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 API field: a Convert API form field, or a Responses API field for GPT-Luna. 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 on Datalab, 5 on GPT-Luna. 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.
OPENAI_API_KEY OpenAI API key, for --backend openai.
OPENROUTER_API_KEY OpenRouter API key, for --backend openrouter.
NO_COLOR Disable colored output.

--api-key overrides whichever variable the chosen backend reads. 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 the backend's key variable (see Configuration).
Authentication failed The key was rejected. Check it on the Datalab, OpenAI, or OpenRouter dashboard.
Payment required Your Datalab account is out of credits.
out of credits or over quota Your OpenAI or OpenRouter account needs credits or a higher spend limit.
returned N pages for M GPT-Luna merged or split pages. Lower --chunk-size.
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 of report_<random>.md + images_<random>/, and existing outputs are skipped unless you pass --overwrite.
  • -o accepts relative paths and mirrors folder structure.
  • --llm now means --mode balanced and --max means --mode accurate. Datalab removed the options behind --strip, --force, and --langs, so those flags are ignored with a warning.
  • --pages, --noimg, -cs, and -mp still 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, or from OpenAI's GPT-Luna. This is an independent project and isn't affiliated with Datalab, OpenAI, or OpenRouter.

License

MIT © Nikita Sokolsky

Metadata

Release files for pdf-to-markdown-cli 1.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pdf-to-markdown-cli 1.3.0
File Size Uploaded
pdf_to_markdown_cli-1.3.0.tar.gz 9.8 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for pdf-to-markdown-cli 1.3.0
File Interpreter ABI Platform
pdf_to_markdown_cli-1.3.0-py3-none-any.whl Python 3 none any Details

Total release size: 9.8 MB

Release files / pdf_to_markdown_cli-1.3.0.tar.gz

Download URL pdf_to_markdown_cli-1.3.0.tar.gz
Size 9.8 MB
Tags Source
SHA-256 checksum
How to use checksums
8c463a3ce1d29fd4eba40aa75fe54b29b034db890bf7c9955e4f575ff22807db
BLAKE2b-256 checksum
How to use checksums
18b73fceb92fc6d50b959cd19332c6485d3dcfa40b68374534bc7569834eb7fe
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

Release files / pdf_to_markdown_cli-1.3.0-py3-none-any.whl

Download URL pdf_to_markdown_cli-1.3.0-py3-none-any.whl
Size 47.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a1636069c2f4b2f60ef8d6c12f7a23b37e5ad957a435e5696b46a9fc8a635a56
BLAKE2b-256 checksum
How to use checksums
3a0c7a88ca23eae18146898295d35609eac5c0818a6db11d4092c808df2b6d87
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

Release history Release notifications | RSS feed

1.6.0

2 release files

1.5.0

2 release files

1.4.0

2 release files

This release

1.3.0 This release

2 release files

1.2.0

2 release files

1.1.0

2 release files

1.0.1

2 release files

1.0.0

2 release files

0.5.2

2 release files

0.5.1

2 release files

0.5.0

2 release files

0.4.0

2 release files

0.2.1

2 release files

0.2.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page