chrisryugj/kordoc:README 来源编辑指南
基于 README、仓库元数据和许可证整理 chrisryugj/kordoc 的安装与核验路径。
项目定位
chrisryugj/kordoc 的 README 将项目描述为"모두 파싱해버리겠다 , HWP·HWPX·PDF·Office 문서를 Markdown으로. 양식 자동 채우기와 신구대조를 갖춘 CLI·MCP 서버 | Convert Korean documents (HWP, HWPX, PDF, Office) to Markdown , CLI and MCP server with form filling and diff"。本文只整理仓库能直接核验的内容,不把星标、Fork 或宣传语当成质量证明。README 在"kordoc"下的说明是:HWP 3.x/5.x, HWPX, HWPML, PDF, XLS, XLSX, DOCX, 이미지(PNG/JPG/WebP) , 관공서에서 쏟아지는 모든 문서를 파싱하고, 비교하고, 분석하고, 생성합니다.。这给出的首先是项目边界,而不是已经完成的生产验证。
适用场景
从 README 的"💡 kordoc으로 무엇을 할 수 있나요?"和相关条目看,读者可以先判断它是否解决自己的具体问题:📊 복잡한 표(Table) 복원 , 숫자로 잠금: 병합·중첩 표를 구조 그대로 살립니다. HWPX 코퍼스 291문서 표 1,673/1,673·셀 27,714/27,714 무손실(독립 추출기 대조 게이트 1.0), 동일문서 hwpx↔pdf 대조(6쌍 69표)는 매칭 98.6%·완전일치 65.2%. 선 없는 PDF 표도 감지해 복원하고, 법령 개정안 PDF의 신구조문대비표도 통째로 살립니다 (v3.16.2).。如果你的目标与这段说明不一致,就不应仅凭项目热度采用它。这里保留原项目名、命令和组件名,方便回到一手来源核对。 README 还列出了另一条可核对的信息:📄 어떤 문서든 마크다운으로: HWP3 (구버전), HWP(5.x), HWPX, HWPML, PDF, XLS, XLSX, DOCX 파일은 물론 PNG/JPG/WebP 이미지(자동 OCR)까지 즉시 Markdown으로 변환합니다. AI(LLM)가 문서를 읽고 분석하기 가장 좋은 상태로 만들어줍니다.。这类原文条目可以帮助读者设计试运行步骤,但不能代替自己的环境测试。
工作方式
README 把工作方式分散写在"⚡ 30초 설치 (AI 에이전트 연동)"等段落中。可确认的线索包括:대화형 마법사가: 1. 사용 중인 AI 클라이언트 번호 선택 (Claude Desktop / Cursor / Claude Code / Windsurf / VS Code / Gemini CLI / Zed / Antigravity / Codex , 설치된 건 [감지됨] 표시) 2. 설정 파일 자동 패치 → 클라이언트 재시작。这篇整理没有把未写出的架构、性能或安全边界补成结论;真正的运行链仍应结合仓库目录、配置文件和版本标签检查。
安装与第一次运行
第一次安装应从 README 给出的入口开始。当前可复核的命令是: npm install kordoc 如果仓库没有提供命令,本文不会替它编造安装步骤,而是建议先打开 README 的"⚡ 30초 설치 (AI 에이전트 연동)"部分,确认系统依赖、默认端口和首次初始化动作。
配置与日常使用
日常使用的细节取决于项目实际文档。README 的"⚡ 30초 설치 (AI 에이전트 연동)"段落提到:Windows 도 자동으로 cmd /c npx 래핑. 수동 JSON 편집 불필요. 재시작하면 15개 문서 도구 (parsedocument, parsetable, fillform, patchdocument, generatedocument 등) 활성화.。对于配置文件、环境变量、权限和数据目录,当前稿只记录来源明确的部分;未写明的默认值必须在测试环境中验证,并保留可回滚的配置副本。 同一部分还提到:🔍 신구대조표 자동 생성: 두 문서의 차이점을 분석하여 무엇이 바뀌었는지 한눈에 보여줍니다. (HWP와 HWPX 간의 비교도 가능!)。