@aparte/plugin-marked

中文文档
0.32.1发布于 2026/11/02MITTypeScriptES Module构建来源已验证近 30 天下载 5302

Markdown rendering for aparté via marked — register it as the one-shot Markdown provider.

原始使用文档

@aparte/plugin-marked

Markdown rendering for aparté via marked. Registers the one-shot Markdown provider used for finished / re-rendered message bubbles.

npm install @aparte/plugin-marked @aparte/core marked
import { setupMarkedProvider } from '@aparte/plugin-marked';

setupMarkedProvider({ gfm: true, breaks: true }); // options are optional

@aparte/core and marked are peer dependencies. For token-by-token incremental rendering during streaming, add @aparte/plugin-streaming-markdown alongside this — or use marked for the stream too:

Stream with marked

import { setupMarkedStreamingProvider } from '@aparte/plugin-marked/streaming';

setupMarkedStreamingProvider(); // replaces setupMarkedProvider(); same options

marked formats the reply while it streams and once it is done, so a finished reply looks exactly as it did at its last chunk. The block being written is completed by Vercel's remend before marked reads it — **bold shows bold before its closing **, a link shows as a link from its first character — and drawn again at each chunk; the blocks above it are not. Every block goes through the config's sanitizer. remend is a dependency of this plugin, imported by the /streaming entry only.

ESM-only. Part of the aparté monorepo.

Maths

Install @aparte/plugin-katex and marked hands it every formula — $…$, $$…$$, \(…\), \[…\] — instead of reading the TeX as Markdown (\, and a*b*c mean something else to it). It turns on by itself when a math renderer is registered; MarkedProviderOptions.math forces it either way:

setupMarkedProvider({ math: false }); // leave dollars as text, whatever is registered

A single $ follows Pandoc's rule, so $5 and $10 stays text; a formula never crosses a blank line, code wins over it, and escaped brackets such as \[1\] stay brackets. While a reply streams, a formula is drawn as it arrives.

With maths on, rendering runs on a marked instance of the plugin's own, so an extension you added to the global marked with marked.use() does not apply: pass your marked options to setupMarkedProvider(options) instead.

版本与发布记录

@aparte/plugin-marked 共发布 65 个版本,首次发布于 2026/07/24;过去 12 个月发布了 65 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.32.1latest2026/11/024 天前
0.32.02026/11/024 天前
0.31.02026/11/024 天前
0.30.12026/11/014 天前
0.30.02026/11/014 天前
0.29.42026/11/015 天前

其他发布通道:alpha → 0.17.0。

关于 @aparte/plugin-marked 的常见问题

@aparte/plugin-marked 是什么?

Markdown rendering for aparté via marked — register it as the one-shot Markdown provider.

如何安装 @aparte/plugin-marked?

在项目目录运行 npm install @aparte/plugin-marked,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:marked(^18.0.0)、@aparte/core(>=0.32.1 <1.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@aparte/plugin-marked 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@aparte/plugin-marked 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@aparte/plugin-marked 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=18。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@aparte/plugin-marked 可以商用吗?

@aparte/plugin-marked 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@aparte/plugin-marked 的下载量有多少?

根据 npm 官方下载统计,@aparte/plugin-marked 在 2026/10/06 – 2026/11/04 这 30 天内被下载 5,302 次,日均约 177 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@aparte/plugin-marked 还在维护吗?

最新版本 0.32.1 发布于 2026/11/02(4 天前);至今共发布 65 个版本,其中过去 12 个月发布了 65 个;首次发布于 2026/07/24。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。