Skip to content

包总览 ​

本页按包展示当前 docx-kit monorepo 的运行时、工具、预设和主题,与插件参考文档互补。

核心运行时包 ​

包用途使用场景
docx-kit聚合包希望统一导入 API 的应用开发者的默认选择
@docxkit/core核心构建器、编译器、DSL、样式与工具需要精简运行时或构建高级集成
@docxkit/errors共享错误类与错误码处理生成与预览错误,无需引入核心引擎
@docxkit/types共享类型定义仅需要类型的包或应用
@docxkit/markdown将 Markdown 转换为文档 DSL使用 Markdown 输入复用文档样式、主题与插件
@docxkit/renderer浏览器预览渲染需要浏览器内 .docx 预览或嵌入 Office Online

扩展与工具 ​

包用途核心能力
@docxkit/loader动态加载插件支持 inline、npm、URL 与本地插件来源
@docxkit/pdk插件开发工具包插件渲染测试与可复用测试上下文
@docxkit/registry插件注册表搜索发现为 docx-kit 发布的插件
@docxkit/create-plugin插件脚手架按约定目录结构创建插件包

AI 与 Agent 包 ​

包用途核心能力
@docxkit/ai适合 AI 的模板系统报告、发票、简历、信函模板与提示词构建
@docxkit/mcpMCP 服务端向 AI Agent 和助手提供文档生成工具

内置插件包 ​

包功能
@docxkit/plugin-cross-reference书签文字、编号与页码引用
@docxkit/plugin-bibliography数字编号文献列表与引用
@docxkit/plugin-glossary排序分组的术语和缩略语表
@docxkit/plugin-badge状态标签
@docxkit/plugin-barcode一维条形码
@docxkit/plugin-callout提示块
@docxkit/plugin-changelog更新日志表格
@docxkit/plugin-code-block源代码排版
@docxkit/plugin-cover-page报告与文档封面
@docxkit/plugin-data-table结构化对象数组表格
@docxkit/plugin-divider章节分隔线
@docxkit/plugin-echarts图表渲染
@docxkit/plugin-invoice账单文档
@docxkit/plugin-letterhead品牌信头
@docxkit/plugin-meeting-minutes会议纪要
@docxkit/plugin-page-number页码域
@docxkit/plugin-property-table键值表格
@docxkit/plugin-qrcode二维码
@docxkit/plugin-checklist分组任务清单,支持图形与 Word 原生复选框
@docxkit/plugin-figure带题注与来源的图片
@docxkit/plugin-metric-card多列指标摘要
@docxkit/plugin-signature-block审批与签名布局
@docxkit/plugin-timeline里程碑时间线
@docxkit/plugin-toc目录域
@docxkit/plugin-watermark水印文字

每个插件的完整选项参考见插件章节。

预设包 ​

包样式方向
@docxkit/preset-classic正式公文样式
@docxkit/preset-modern适合商务文档的默认样式
@docxkit/preset-academic论文与学术写作排版

主题包 ​

包主题方向
@docxkit/theme-minimal中性简约配色
@docxkit/theme-ocean蓝色主导的配色系统
@docxkit/theme-warm琥珀色与暖色配色系统

推荐入口 ​

  • 应用开发选择 docx-kit。
  • 适配器、插件或受限运行时包选择 @docxkit/core。
  • 浏览器预览选择 @docxkit/renderer。
  • 扩展生态选择 @docxkit/pdk 与 @docxkit/create-plugin。
  • AI 驱动的文档流程选择 @docxkit/ai 或 @docxkit/mcp。

Released under the MIT License.