kordoc
By chrisryugj·2,533
Parse Korean documents (HWP, HWPX, PDF, XLSX, DOCX, PPTX) to Markdown; fill forms, diff, render.
kordoc
모두 파싱해버리겠다 — Parse them all.
Korea's document hell is second to none. Built by a civil servant who survived seven years in it.
Convert HWP 3.x/5.x, HWPX, HWPML, PDF, XLS/XLSX, DOCX, PPTX and PNG/JPG/WebP to Markdown and structured data. Use it as a library, CLI or MCP server.
한국어 · Usage guide · Benchmarks · Changelog
- 📊 0.963 overall on the public PDF benchmark — opendataloader-bench, 200 documents. Ranked first against 12 published parsers in the 2026-09-29 comparison. Measurement details
- 🇰🇷 100% Korean document table structure match — all 10,461 visible tables from 2,429 original HWPX documents. 4.22.0 verification
If this saves you time, a GitHub ⭐ helps others find it.
▶ Click to play on YouTube. Narration is in Korean.
New video: kordoc 공개벤치 1위 마크 — public benchmark · 2026-09-27 · 1 min 31 sec · Korean
Install
Node.js 20+ · macOS / Linux / Windows
npm install kordocRun the CLI without installing it globally: npx kordoc. PDF/OCR dependencies are installed by default; omitting them with --omit=optional limits those features.
Connect an AI agent
npx -y kordoc setupRegisters MCP with installed clients such as Claude Desktop, Claude Code, Cursor and Codex. Restart the client to use 17 tools for parsing, comparison, generation, rendering and more.
Claude Code plugin:
/plugin marketplace add chrisryugj/kordoc
/plugin install kordoc@kordoc
Manual MCP setup and installation troubleshooting
Quick start
CLI
npx kordoc document.hwpx -o document.md
npx kordoc *.pdf --jobs 4 -d ./output
npx kordoc document.pdf --format json --pages 1-3
npx kordoc scan.pdf --ocr -o scan.md
npx kordoc generate report.md --preset report -o report.hwpx
npx kordoc fill --template gian -j values.json -o draft.hwpx--jobs converts files in parallel and increases memory use. Batch conversion details
For the report, plan, gaejosik and bangchim presets, a blockquote right after the # title (> …하고자 함) becomes the summary box (gaejosik puts it under the title box on the first body page when the cover is on, the default; with cover: false the first # is a chapter header and the quote stays a ※ note). Keep it to one sentence (commas allowed) within three lines; longer or multi-sentence summaries produce a warning. For ministry, > ▪ … blockquotes become performance summary boxes wherever they appear.
JavaScript / TypeScript
import { parse, markdownToHwpx } from "kordoc"
import { writeFile } from "node:fs/promises"
const result = await parse("document.hwpx")
if (result.success) {
console.log(result.markdown)
// result.blocks: structured data; result.metadata: document metadata
}
const hwpx = await markdownToHwpx("# Plan\n\nBody text", {
gongmun: { preset: "report" },
})
await writeFile("report.hwpx", Buffer.from(hwpx))Parse options, APIs, forms and rendering examples
Features
| Task | Capabilities |
|---|---|
| Read | Markdown, IR, page text, RAG chunks and local OCR |
| Compare and edit | Block/cell diffs, format-preserving HWPX/HWP patches |
| Create | Markdown → HWPX, government-document presets, tables, equations and charts |
| Fill forms | Fields, click-here controls, two draft templates and seal placement |
| Review | HWPX/HWP previews and region crops, validation, style checks and PII masking |
Extract Markdown for format-preserving patches with --keep-layout-tables. Unsupported edits are skipped with a reason. Full CLI and API reference
Validation
4.22.5 verification · 2026-10-17. Results use fixed corpora and reference criteria.
| Target | Population | Result |
|---|---|---|
| HWPX | 2,429 documents · 10,461 tables | Table structure match 10,461/10,461 · 100% |
| HWP 5.x ↔ HWPX | 1,131 pairs · 4,317 tables | Paired-document table structure match 100% |
| PDF text | 744 pairs | Character recall 99.872% · precision 99.670% · reading order 99.244% · word-boundary F1 99.037% |
| PDF tables | 708 pairs · 2,331 tables | Detection 99.87% · structure match 98.16% · cell F1 0.9918 |
| HWPX reflow | 25,581 multiline paragraphs | All line starts match 25,332/25,581 · 99.0266% |
| Nested PDF tables (text layer) | 29 documents · 101 tables | Structure and cell content 101/101 · 100% |
| Statute annexes | 272 documents · 346 tables | HWP 346/346, PDF 342/346 · 98.84% |
| All PDFs | 1,888 scored out of 2,070 documents | Text coverage 99.80% |
| OCR | 53 documents · 102 pages | CER 0.0412 · character recall 99.02% |
Table structure, cell content and visual fidelity are separate metrics. The nested-table 100% applies only to these 101 tables, not all PDF parsing or page layout. See benchmark details for scope, exclusions and the per-document comparison of every bench.
4.22.5 improvement verification (2026-10-17): ten alternating rounds increased exact line starts from 25,326 to 25,332/25,581 paragraphs, PDF exact table-cell content 0.990311→0.990677, and character recall 0.99865→0.99872. Fixes cover zero-width tabs, symbol advances, bullet reservations, line heights and split tables, plus PDF continuations, section headings and missing glyphs. Statute-annex cell F1 improved 0.99739→0.99778; exact structure remains 342/346. Additional five rounds, cross-effects and upstream review (Korean) · Earlier five rounds (Korean)
Merged corner cells are retained within the existing logical grid during empty-row folding. Six number glyphs in the reproduced PDF are now restored; HTML rule rendering and unregistered font glyphs remain documented limitations (Korean).
The external opendataloader-bench, 200 documents was verified on the same corpus with the 4.22.5 release candidate: overall 0.963 with defaults, 0.939 with OCR off. Options and reproduction
Recent updates
Latest release: 4.22.5 · 2026-10-17
| Version | Highlights |
|---|---|
| 4.22.5 | Fix zero-width tabs, symbol advances, bullet reservations, split tables and line heights; restore PDF partial cells, section headings and missing glyphs |
| 4.22.4 | Fix image, border, space-font, vertical baseline and quote layout; restore PDF bullet cells, notes, form headings and split list rows |
| 4.22.3 | Improve table, image and optional-hyphen reflow; restore PDF continuations and independent rows; retain merged corner cells during empty-row folding |
| 4.22.2 | Fix partial-edit positions, image wrapping and fixed-width spaces; preserve separate PDF title boxes and numbered rows; restore contact columns and shaded-row content |
| 4.22.1 | Fix mixed deskewed and high-resolution crop coordinates in figure-region OCR on PDFs with a text layer; full-scan deskew remains enabled |
| 4.22.0 | Nested PDF tables 94/101 → 101/101; preserve page-boundary cells, HWP captions and notes inside table cells. OCR line coordinates and model selection; lighter formula OCR installation |
| 4.21.33 | Endnote column flow, footnotes in split tables, cell spacing — body line positions matching 95.9% → 97.5%, cells 99.5% → 99.7% |
| 4.21.32 | Render and reflow page layout — table cells and floating objects that cross pages. Cell line positions matching 97.4% → 99.5%, body 87.2% → 95.9% |
| 4.21.31 | Render and reflow layout matching, tables kept in notes (#149), opt-in inline math (#150), security review fixes |
| 4.21.23 | OCR of text inside pictures in HWP and HWPX (ocr: true, #143) |
| 4.21.0 | Ministry document styles --agency, press release contact tables |
Use --ocr --ocr-lines --format json to export OCR line boxes and confidence. Select the detector and resolution with --ocr-det and --ocr-det-long-side. OCR lines and models
See the changelog for details on every release.
FAQ
How do I convert an HWP or HWPX file to Markdown?
npx kordoc document.hwp -o document.md. It reads the file directly, without Hancom Office. Convert many files at once with npx kordoc *.hwpx -d ./output.
How do I let Claude, Cursor or another AI agent read Korean documents?
Run npx -y kordoc setup to register the MCP server. The agent can then read, compare and fill HWP, PDF and Excel files from a file path.
Does it work on an air-gapped network?
Yes. KORDOC_OFFLINE=1 blocks all outbound traffic, and OCR runs on the local CPU with no API key. Offline deployment
Can I use it for RAG indexing?
--format chunks emits structure chunks with heading breadcrumbs plus standalone table chunks. Use --table-format gfm (API: tableFormat: "gfm") for tables without HTML. From Python or Java, use the Python SDK or Java SDK.
Documentation and security
- Usage guide: complete CLI, MCP tools, APIs and format support
- Java SDK · Python SDK: parse from Java and Python systems through a resident engine worker (worker protocol, Korean)
- Government-document generation · Architecture
- Offline deployment:
KORDOC_OFFLINE=1; MCP file scope withKORDOC_ROOT - Security policy · MIT license · Third-party notices
About the Author
A local civil servant in Korea. Built this after seven years of wrestling HWP files at the Gwangjin-gu District Office in Seoul. Validated on thousands of real government documents across five public-sector projects.
