# @borodin/mdgram 中文文档 规范地址：https://npmcn.com/package/%40borodin/mdgram/ 版本：1\.2\.0 npm 元数据更新时间：2026-07-03T16:58:12.113Z 中文译文更新时间：2026-11-08T11:50:56.897Z 软件包许可：MIT 本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。 原始 npm 页面：https://www.npmjs.com/package/%40borodin/mdgram 原文对照：https://npmcn.com/package/%40borodin/mdgram/?lang=original 项目主页：https://github.com/Borodin/mdgram#readme 源码仓库：https://github.com/Borodin/mdgram ## 关键信息（来自 npm 元数据） - 包体积（解压后）：69 kB，7 个文件 - 模块格式：ESM + CJS - TypeScript 类型：包内自带 - Node.js 要求：\>=18 - 运行依赖：1 个 - 首次发布：2026-04-22T18:15:43.249Z - 最新版本发布：2026-07-03T16:58:11.793Z - 近 30 天下载量：3608（2026-10-09 至 2026-11-07，npm 官方下载统计） - 已发布版本数：5（近 12 个月 5 个） ## 中文简介 向下流马克到Telegram HTML 转换器 ## 安装 ```sh npm install @borodin/mdgram ``` 也可以使用：`pnpm add @borodin/mdgram`、`yarn add @borodin/mdgram`、`bun add @borodin/mdgram` ## README # 页:1 将 Markdown 流到 Telegram HTML 转换器 。 安全地将不完整的Markdown(从LLMs中切入)在每一步都转换成有效的Telegram HTML. 支持两种经典的Telegram HTML(`mdgram`)和 Bot API 10.1 丰富的 HTML 格式(`mdgramRich`) (中文(简体) ). ## 安装 ```bash npm install @borodin/mdgram ``` ## 使用量 ### 经典电报 HTML ```ts import { mdgram } from "@borodin/mdgram"; mdgram("Hello **world**"); // "Hello world" // Handles incomplete markdown (streaming) mdgram("Hello **wor"); // "Hello wor" ``` ### 丰富的 HTML( API 10. 1+) ```ts import { mdgramRich } from "@borodin/mdgram"; mdgramRich("# Title\n\n- item 1\n- item 2"); // "

Title

\n" // LaTeX mdgramRich("Euler's formula: $e^{i\\pi} + 1 = 0$"); // "Euler's formula: e^{i\pi} + 1 = 0" // Streaming — every prefix is valid Rich HTML mdgramRich("$e^{i\\pi"); // "e^{i\pi}" ``` 使用 `sendRichMessage` 编号 : `sendRichMessageDraft` 发送 Rich HTML 到 Telegram. #### `paragraphMode: "br"` - 为没有工作的客户工作 `

` 边距 某些Telegram 客户端正在提供 `

` 没有垂直边距, 因此相邻 段落可视合并。 在客户端解决之前,你可以选择一个 `

`\- 在所有客户端看起来相同的基于布局 : ```ts mdgramRich("First.\n\nSecond.", { paragraphMode: "br" }); // "First.

Second." (default "p" mode: "

First.

\n

Second.

") ``` `

` 仅在相邻段落之间插入;带块的边界 元素(标题、列表、表格等)保持不变。 默认 `"p"` 模式 遵循 Rich HTML 规格. ## 支持的格式 ### `mdgram` – 经典的Telegram HTML | 标记 | 产出 | | --- | --- | | `**bold**` | `bold` | | `*italic*` | `italic` | | `` `code` `` | `code` | | ` ```lang\n...\n``` ` | `
...
` | | `[text](url)` | `text` | | `~~strike~~` | `strike` | | `||spoiler||` | `spoiler` | | `> quote` | `
quote
` | | `# heading` | `heading` | | `- item` 编号 : `1. item` | `• item` 编号 : `1. item` | ### `mdgramRich` — 丰富的 HTML( 超集) 一切从 `mdgram`,加上: | 标记 | 产出 | | --- | --- | | `# H1` . `###### H6` | `

` . `

` | | `- item` 编号 : `1. item` | `