ai-markdown
適用於 AI 應用程式的 Markdown 轉譯:增量串流、LaTeX 數學、GFM 與 CJK 排版。共用引擎與核心,React 與 Mantine 整合;Vue 開發中。
ai-markdown 是什麼?
適用於 AI 應用程式的 Markdown 轉譯:增量串流、LaTeX 數學、GFM 與 CJK 排版。共用引擎與核心,React 與 Mantine 整合;Vue 開發中。
ai-markdown 概覽
這是什麼
ai-markdown 是一個專為 AI 應用設計的 Markdown 渲染函式庫。它提供增量串流、LaTeX 數學公式、GFM(GitHub 風格的 Markdown)以及中日韓(CJK)排版。此函式庫包含共享的核心引擎,並提供 React 與 Mantine 整合;Vue 整合正在開發中。自 3.0.0 版起,React 與 Vue 適配器共用公開的 @ai-markdown/core 與 @ai-markdown/engine 套件。該函式庫專為處理串流 AI 回應而設計,能在使用者閱讀時內容持續變動,保留中間快照的意義,並有效管理重複工作。
主要功能
- GFM:表格、刪除線、任務清單、自動連結(透過
remark-gfm)。 - LaTeX 數學公式:行內
$…$與展示$$…$$(透過 KaTeX),並支援貨幣$的智慧預處理、括號分隔符(``)、管線跳脫以及 mhchem 指令。 - Mermaid 圖表:互動式 SVG,支援深色/淺色主題、原始碼切換、複製、在新視窗開啟(位於
@ai-markdown/react-mantine)。 - 語法高亮:附語言標籤的分頁、展開/收合、可選的未標記區塊語言偵測(透過
@ai-markdown/code-language-detector,位於@ai-markdown/react-mantine)。 - 中日韓友善:支援中日韓文的重點標記與刪除線解析、原始換行符渲染為斷行,以及可選的 pangu 自動間距。
- 串流感知:透過 context 傳遞
streaming旗標;自訂渲染器可在串流期間顯示游標、跳過動畫或停用複製按鈕。 - 串流游標:內建
streamingCursor插槽,在最後一個串流字元後顯示「正在生成」指示器。 - 流暢串流:將突發的 token 區塊以穩定的逐字元打字機效果呈現;提供三種預設模式(流暢、平衡、響應式),且附加幀可在安全閘門允許時使用增量解析。
- 跨區塊協調:
AIMarkdownDocuments包裝器讓分塊的聊天訊息共享documentId,使腳註、連結參考與圖片參考能跨區塊解析。 - 區塊層級記憶化:每個 markdown 區塊依原始身分記憶化;未變更的計畫在串流期間重複使用 React 元素。
- Emoji 短代碼:
:smile:→ 😄(透過remark-emoji)。 - 額外語法:
==highlight==、定義清單(PHP Markdown Extra)。
使用情境
ai-markdown 適用於需要渲染串流 Markdown 並支援數學公式、GFM 與中日韓文字的 AI 應用。它支援 AI 回應在使用者閱讀時持續變動的情境,例如聊天訊息的增量串流。該函式庫也處理含有多個渲染器的文件,透過 AIMarkdownDocuments 在邏輯區段間共享腳註與連結/圖片定義。
快速開始
請參閱儲存庫的 README 以取得安裝與快速開始指令。
授權與價格
授權為 MIT。此專案為開放原始碼。
內容整理自該專案公開的 README 與儲存庫資訊。