miku-docx2md は、Word の .docx ファイルを Markdown に変換するローカル実行ツールです。
見た目を Word どおりに再現するためのツールではありません。文章、見出し、リスト、表、リンクなどの文書構造を Markdown として読みやすく取り出すことを目的にしています。
この README は、概要と最短の使い方をまとめます。詳しい CLI option、画像 asset、debug 出力は docs/usage.md を参照してください。
.docx ファイルを Markdown に変換npm run cli -- ./sample.docx --out ./sample.md
summary も出力する例:
npm run cli -- ./sample.docx --out ./sample.md --summary --summary-out ./sample.summary.txt
画像 asset も出力する例:
npm run cli -- ./sample.docx --out ./sample.md --assets-dir ./sample.assets
debug comment も含める例:
npm run cli -- ./sample.docx --out ./sample.md --debug
進捗と処理時間の診断を stderr に出す例:
npm run cli -- ./sample.docx --out ./sample.md --verbose
CLI option の一覧、終了コード、asset 出力、manifest.json の詳細は docs/usage.md と npm run cli -- --help にまとめています。
miku-docx2md は、Word の見た目ではなく文書構造を優先します。
←M← と ↑M↑ の placeholder で簡略表現します。--debug 使用時のみ、unsupported 要素の trace を HTML comment として出します。| Content | Status |
|---|---|
| 段落 | 対応 |
| 見出し | 対応 |
| 太字、斜体、取り消し線、下線 | 一部対応 |
| 段落内改行 | 対応 |
| 外部リンク | 対応 |
| 解決可能な文書内リンク | 対応 |
| 箇条書き、番号付きリスト、ネスト | 対応 |
| 表 | 対応 |
| 表の結合セル | placeholder で簡略対応 |
| 埋め込み画像 | 解決可能なものを sidecar asset として出力 |
| Word の見た目の完全再現 | 非対応 |
npm run build
src/ts/ から Node.js runtime 用の dist/js/ を再生成します。dist/ は生成物なので Git 管理しません。CLI runtime bundle は npm run build:bundle、Web / adapter 向け runtime bundle は npm run build:runtime で生成します。
dist/ と bundle/ は生成物として Git 管理しません。workplace/ は sibling repository、検証用ファイル、生成確認用 artifact のための local scratch area です。workplace/.gitkeep だけを Git 管理します。.codex/skills/ と .vscode/mcp.json は local deployment / local editor configuration として Git 管理しません。ブラウザ UI と Single-file Web App 配布物は、分離済みの miku-docx2md-web が担当します。この repository は product core、CLI、Node.js runtime bundle を担当します。
npm run test:unit
Apache License 2.0
See LICENSE.