{"id":40223136,"url":"https://github.com/vace/markdown-docx","last_synced_at":"2026-01-21T13:25:24.411Z","repository":{"id":288260451,"uuid":"967260891","full_name":"vace/markdown-docx","owner":"vace","description":"Convert Markdown files to DOCX format with support for both browser and Node.js environments.  将 Markdown 文件转换为 DOCX 格式，支持浏览器和 Node.js 环境。","archived":false,"fork":false,"pushed_at":"2026-01-11T13:59:24.000Z","size":3841,"stargazers_count":230,"open_issues_count":1,"forks_count":34,"subscribers_count":3,"default_branch":"main","last_synced_at":"2026-01-19T22:55:55.674Z","etag":null,"topics":["docx","markdown","markdown-converter","markdown-to-docx","md-docx"],"latest_commit_sha":null,"homepage":"https://md-docx.vace.me","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vace.png","metadata":{"files":{"readme":"README-zh.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-04-16T07:18:35.000Z","updated_at":"2026-01-17T06:15:10.000Z","dependencies_parsed_at":"2025-04-16T15:59:10.690Z","dependency_job_id":"89aa92e3-39d7-4595-99e4-38e4662f792d","html_url":"https://github.com/vace/markdown-docx","commit_stats":null,"previous_names":["vace/markdown-docx"],"tags_count":11,"template":false,"template_full_name":null,"purl":"pkg:github/vace/markdown-docx","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vace%2Fmarkdown-docx","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vace%2Fmarkdown-docx/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vace%2Fmarkdown-docx/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vace%2Fmarkdown-docx/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vace","download_url":"https://codeload.github.com/vace/markdown-docx/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vace%2Fmarkdown-docx/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28633757,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-21T04:47:28.174Z","status":"ssl_error","status_checked_at":"2026-01-21T04:47:22.943Z","response_time":86,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docx","markdown","markdown-converter","markdown-to-docx","md-docx"],"created_at":"2026-01-19T22:09:15.749Z","updated_at":"2026-01-21T13:25:24.399Z","avatar_url":"https://github.com/vace.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# markdown-docx\n\n将 Markdown 文件转换为 DOCX 格式，支持浏览器和 Node.js 环境。\n\n[![npm 版本](https://img.shields.io/npm/v/markdown-docx.svg)](https://www.npmjs.com/package/markdown-docx)\n[![许可协议](https://img.shields.io/npm/l/markdown-docx.svg)](https://github.com/vace/markdown-docx/blob/main/LICENSE)\n\n## 在线演示\n\n[Markdown 转 DOCX 转换器](https://md-docx.vace.me)\n\n## 功能特性\n\n![截图](./tests/screenshots.png)\n\n- 📝 高保真 Markdown 转 DOCX 格式\n- 🖼️ 支持图片（自动下载）\n- 📋 支持表格、列表、代码块等 Markdown 元素\n- 公式（LaTeX via KaTeX）：行内 `$...$`、块级 `$$...$$` 和围栏 ```math/latex/katex```；支持分数、根号、下标/上标、带限的求和/积分和矩阵\n- 🔗 支持超链接与脚注\n- 💅 可自定义样式\n- 🌐 同时支持浏览器与 Node.js 环境\n- 🖥️ 提供命令行工具\n\n## 安装\n\n```bash\n# 使用 npm\nnpm install markdown-docx\n\n# 使用 yarn\nyarn add markdown-docx\n\n# 使用 pnpm\npnpm add markdown-docx\n```\n\n## 基础用法\n\n### Node.js\n\n```javascript\nimport fs from 'node:fs/promises';\nimport markdownDocx, { Packer } from 'markdown-docx';\n\nasync function convertMarkdownToDocx() {\n  // 读取 Markdown 内容\n  const markdown = await fs.readFile('input.md', 'utf-8');\n\n  // 转换为 DOCX\n  const doc = await markdownDocx(markdown);\n\n  // 保存文件\n  const buffer = await Packer.toBuffer(doc);\n  await fs.writeFile('output.docx', buffer);\n\n  console.log('转换完成！');\n}\n\nconvertMarkdownToDocx();\n```\n\n### 浏览器环境\n\n```javascript\nimport markdownDocx, { Packer } from 'markdown-docx';\n\nasync function convertMarkdownToDocx(markdownText) {\n  // 转换为 DOCX\n  const doc = await markdownDocx(markdownText);\n\n  // 生成下载文件\n  const blob = await Packer.toBlob(doc);\n\n  // 创建下载链接\n  const url = URL.createObjectURL(blob);\n  const a = document.createElement('a');\n  a.href = url;\n  a.download = 'document.docx';\n  a.click();\n\n  // 清理资源\n  URL.revokeObjectURL(url);\n}\n\n// 示例：配合文本域使用\ndocument.getElementById('convert-btn').addEventListener('click', () =\u003e {\n  const markdown = document.getElementById('markdown-input').value;\n  convertMarkdownToDocx(markdown);\n});\n```\n\n## 高级用法\n\n### 使用 MarkdownDocx 类\n\n通过 `MarkdownDocx` 类实现更精细的控制：\n\n```javascript\nimport { MarkdownDocx, Packer } from 'markdown-docx';\nimport fs from 'node:fs/promises';\n\nasync function convertWithOptions() {\n  const markdown = await fs.readFile('input.md', 'utf-8');\n\n  // 创建带配置的转换器\n  const converter = new MarkdownDocx(markdown)\n\n  // 生成文档\n  const doc = await converter.toDocument({\n    title: '我的文档',\n    creator: 'markdown-docx',\n    description: '由 Markdown 生成'\n  });\n\n  // 保存文件\n  const buffer = await Packer.toBuffer(doc);\n  await fs.writeFile('output.docx', buffer);\n}\n```\n\n## 配置选项\n\n`MarkdownDocx` 构造函数和 `markdownDocx` 函数接收如下配置参数：\n\n| 选项 | 类型 | 默认值 | 说明 |\n|--------|------|---------|-------------|\n| `imageAdapter` | 函数 | 内置适配器 | 自定义图片处理器 |\n| `ignoreImage` | 布尔值 | `false` | 是否忽略图片 |\n| `ignoreFootnote` | 布尔值 | `false` | 是否忽略脚注 |\n| `ignoreHtml` | 布尔值 | `false` | 是否忽略内联 HTML |\n| `gfm` | 布尔值 | `true` | 启用 GitHub 风格 Markdown |\n| `theme` | 对象 | 默认主题 | 自定义颜色和大小的主题配置 |\n\n同时支持 [marked](https://marked.js.org/using_advanced) 库的额外配置选项。\n\n### 主题配置\n\n你可以通过提供主题配置来自定义生成文档的外观：\n\n示例：\n\n```ts\nconst docx = await markdownToDocx(markdownText, {\n  theme: {\n    // 颜色（十六进制值，不含 #）\n    heading1: \"5B21B6\",\n    heading2: \"7C3AED\",\n    heading3: \"8B5CF6\",\n    heading4: \"374151\",\n    heading5: \"374151\",\n    heading6: \"374151\",\n    link: \"00fb0a\",\n    code: \"EC4899\",\n    blockquote: \"6B7280\",\n    del: \"EF4444\",\n    heading1Size: 66,\n    heading2Size: 52,\n    heading3Size: 42,\n    spaceSize: 18,\n    codeSize: 20,\n    linkUnderline: false,\n  }\n})\n```\n\n所有主题属性都是可选的 - 你可以只覆盖想要自定义的属性。\n\n## 命令行工具\n\n提供 CLI 工具进行文件转换：\n\n```bash\n# 全局安装\nnpm install -g markdown-docx\n\n# 基础用法\nmarkdown-docx --input input.md --output output.docx\n\n# 简写形式\nmarkdown-docx -i input.md -o output.docx\n```\n\n未指定输出文件时，默认使用输入文件名并添加 `.docx` 后缀。\n\n## 支持的 Markdown 特性\n\n- 标题（H1-H6）\n- 段落与换行\n- 强调（粗体、斜体、删除线）\n- 列表（有序/无序）\n- 链接与图片\n- 引用块\n- 语法代码块\n- 表格\n- 水平分隔线\n- 脚注\n- 任务列表（复选框）\n- 数学公式（行内 `$...$`、块级 `$$...$$` 和围栏 ```math/latex/katex```）\n\n## 图片适配器\n\n内置自动下载图片的适配器，可通过实现 `ImageAdapter` 接口创建自定义适配器。\n适配器需包含 `getImage` 方法，接收图片 URL 并返回包含图片数据的 Promise。\n\n```ts\nconst imageAdapter: (token: Tokens.Image) =\u003e Promise\u003cnull | MarkdownImageItem\u003e\n```\n\n### 自定义图片尺寸\n\n您可以在 Markdown 图片的 title 属性中指定自定义尺寸，格式为 `宽度x高度`（例如 `600x400`, `30%x30%`）。这将覆盖图片的原始尺寸，在生成的 DOCX 文档中使用自定义尺寸渲染图片。这对于控制图片大小和避免超出 Word 的最大宽度限制非常有用。\n\n```markdown\n![Alt text](image.png \"600x400\")\n![Alt text](image.png \"30%x30%\")\n```\n\n自定义尺寸将应用于生成的 DOCX 文件中的图片，而原始图片数据保持不变。\n\n## 样式定制\n\n通过样式组件自定义 DOCX 外观：\n\n```javascript\nimport { styles, colors, classes, numbering } from 'markdown-docx';\n\n// 示例：修改超链接颜色\nstyles.default.hyperlink.run.color = '0077cc';\nstyles.markdown.code.run.color = '000000';\n```\n\n可参考 `src/styles` 目录下的文件编写自定义样式：\n\n- [styles.ts](./src/styles//styles.ts) - 文档默认样式\n- [colors.ts](./src/styles/colors.ts) - 颜色定义\n- [markdown.ts](./src/styles/markdown.ts) - Markdown 专用样式\n\n## 浏览器与 Node.js 差异\n\n根据运行环境自动选择图片适配器：\n\n- 浏览器环境使用 Fetch API\n- Node.js 环境使用内置 HTTP/HTTPS 模块\n\n## 示例\n\n更多示例请查看仓库中的 [tests 目录](https://github.com/vace/markdown-docx/tree/main/tests)。\n\n## 许可协议\n\n本项目基于 MIT 许可证，详见 LICENSE 文件。\n\n## 相关项目\n\n- [docx](https://github.com/dolanmiu/docx) - DOCX 生成底层库\n- [marked](https://github.com/markedjs/marked) - 本项目使用的 Markdown 解析器\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvace%2Fmarkdown-docx","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvace%2Fmarkdown-docx","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvace%2Fmarkdown-docx/lists"}