# @aparte/plugin-katex 中文文档

规范地址：https://npmcn.com/package/%40aparte/plugin-katex/

版本：1\.0\.0
npm 元数据更新时间：2026-11-07T09:16:49.950Z
中文译文更新时间：2026-11-07T21:49:02.280Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40aparte/plugin-katex
原文对照：https://npmcn.com/package/%40aparte/plugin-katex/?lang=original
项目主页：https://apartejs.dev/guides/math/
源码仓库：https://github.com/apartejs/aparte

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：28.9 kB，13 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=18
- 运行依赖：0 个
- peer 依赖：katex \>=0\.18\.2 \<1\.0\.0，@aparte/core \>=1\.0\.0 \<2\.0\.0
- 首次发布：2026-10-28T19:07:14.317Z
- 最新版本发布：2026-11-07T09:16:49.649Z
- 近 30 天下载量：2391（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：15（近 12 个月 15 个）

## 中文简介

通过 KaTeX 分取的数学—— 流出时绘制的公式, 在任何 Markdown 提供者下 .

## 安装

```sh
npm install @aparte/plugin-katex
```

也可以使用：`pnpm add @aparte/plugin-katex`、`yarn add @aparte/plugin-katex`、`bun add @aparte/plugin-katex`

## README

# @aparte/ plugin- katex (英语)

数学用于 [独立](https://github.com/apartejs/aparte) 通过 [卡特克语Name](https://katex.org/)每一个 `$…$`, (中文(简体) ), `$$…$$`, (中文(简体) ), `\(…\)` 财务报告和审定财务报表 `\[…\]` 在一个答复中被绘制为一个公式——而答复流, 由马克当供应商识别数学.

![A formula drawn from a display block, with the prices around it left as text, in an aparté chat](https://apartejs.dev/shots/katex.png)

```bash
npm install @aparte/plugin-katex @aparte/core katex
```

```ts
import 'katex/dist/katex.min.css';
import { setupKatex } from '@aparte/plugin-katex';

setupKatex();
```

`@aparte/core` 财务报告和审定财务报表 `katex` 为: **同行依赖关系**。KaTeX 样式表由您导入:它的 字体是您捆绑者解析的相对 URL。 没有它,每个公式就显示两次,插件 在控制台上说过一次.

## 哪个 Markdown 提供者

在Markdown读到之前,必须先识别数学 `\,` 财务报告和审定财务报表 `a*b*c` 意味着别的东西 马克倒地. `@aparte/plugin-marked` (一发和 `/streaming`和 `@aparte/plugin-streaming-markdown` 一旦该插件注册, 便自行识别 . 通过排放提供自己的手数 `<code class="language-math math-inline">TeX</code>`,或 `<pre><code class="language-math math-display">` 对一个街区来说,标记语句已经产生了.

单人 `$` 遵守潘多克的规则,所以价格仍然是价格: `$5 and $10` 为文本.

## 当一个回复流

运出时绘制出一个公式. 一个KaTeX尚不能解析.. `\frac{1}{` - 保留最后一个 画它可以, 所以没有什么闪出红色中游。 一旦答复完成,一个公式 仍然不分析它的TeX,悄悄地,以KaTeX的信息作为工具提示.

## 选项

`setupKatex(options?, config?)` 带 `KatexOptions`数字 :

| 选项 | 默认 |  |
| --- | --- | --- |
| `live` | `true` | `false` 关闭后绘制公式 |
| `katex` | `{}` | KaTeX 自己的选项 : `macros`, (中文(简体) ), `leqno`, (中文(简体) ), `fleqn`, (中文(简体) ), `output`. |
| `maxLength` | `4000` | 更长的公式显示为 TeX |

插件所保存的,随便 `katex` 说: `trust` 实值 `false` (无) `\href`,没有 `\htmlClass`, (中文(简体) ), `maxSize` 财务报告和审定财务报表 `maxExpand` 被封顶,以及 `macros` 为每个公式复制,所以 `\gdef` 在一个 回复无法到达下一个 .

## 两个切入点

`@aparte/plugin-katex` 在第一个公式上加载 KaTeX。 如果你宁愿把它交出来.. 您自己的建筑, CDN 复制件—— 使用不从 `katex`数字 :

```ts
import katex from 'katex';
import { setupKatexWith } from '@aparte/plugin-katex/core';

setupKatexWith(katex);
```

`setupKatexWith` 以实例为例,或函数返回承诺,以及任何对象 形状像 `KatexLike` 联合国 `renderToString`) (中文(简体) ). 这两个功能都返回了处置者.

仅限无害环境管理.

## 常见问题

### @aparte/plugin-katex 是什么？

通过 KaTeX 分取的数学—— 流出时绘制的公式, 在任何 Markdown 提供者下 \.

### 如何安装 @aparte/plugin-katex？

在项目目录运行 npm install @aparte/plugin-katex，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：katex（\>=0\.18\.2 \<1\.0\.0）、@aparte/core（\>=1\.0\.0 \<2\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @aparte/plugin-katex 支持 TypeScript 吗？

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

### @aparte/plugin-katex 支持 ESM 还是 CommonJS？

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

### @aparte/plugin-katex 需要什么版本的 Node\.js？

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

### @aparte/plugin-katex 可以商用吗？

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

### @aparte/plugin-katex 的下载量有多少？

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

### @aparte/plugin-katex 还在维护吗？

最新版本 1\.0\.0 发布于 2026/11/07（今天）；至今共发布 15 个版本，其中过去 12 个月发布了 15 个；首次发布于 2026/10/29。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。