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.