# @drghaliasri/butex 中文文档 规范地址：https://npmcn.com/package/%40drghaliasri/butex/ 版本：8\.1\.2 npm 元数据更新时间：2026-11-13T16:17:54.089Z 中文译文更新时间：2026-11-14T09:42:58.253Z 软件包许可：ISC 本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。 原始 npm 页面：https://www.npmjs.com/package/%40drghaliasri/butex 原文对照：https://npmcn.com/package/%40drghaliasri/butex/?lang=original ## 关键信息（来自 npm 元数据） - 包体积（解压后）：29.5 MB，48 个文件 - 模块格式：ESM + CJS - TypeScript 类型：包内自带 - Node.js 要求：\>=20 - 运行依赖：1 个 - peer 依赖：react ^18\.0\.0 \|\| ^19\.0\.0，mathjax ^4\.1\.0，react-dom ^18\.0\.0 \|\| ^19\.0\.0 - 首次发布：2026-06-16T21:48:18.214Z - 最新版本发布：2026-11-13T16:17:53.854Z - 近 30 天下载量：2092（2026-10-13 至 2026-11-11，npm 官方下载统计） - 已发布版本数：64（近 12 个月 64 个） ## 中文简介 阿拉伯语友好数学符号的 MathJax 扩展层( XeLaTeX 类风俗超越了 Plain MathJax) ## 安装 ```sh npm install @drghaliasri/butex ``` 也可以使用：`pnpm add @drghaliasri/butex`、`yarn add @drghaliasri/butex`、`bun add @drghaliasri/butex` ## README # BuTeX 设备 **BuTeX 设备** (单位:千美元)`@drghaliasri/butex`提供 **阿拉伯数学打字和结构化等式/文件编辑** 在数学贾克斯4。 它载着一个AST第一等式编辑器 **文档** 模型,反应编辑/预览以及无国籍的节点文档工作者. MathJax是一个 **外部同行依赖**,而不是作为销售商的上游源树捆绑. 见 [MathJax的上游来源](https://github.com/mathjax/MathJax-src) 用于参考执行; [软件包.json](https://npmcn.com/package/%40drghaliasri/butex/package.json) 指定运行时间对等关系. ## 安装 ```bash npm install @drghaliasri/butex mathjax # Add these if using the React editors: npm install react react-dom ``` 节点.js **20岁以上** 用于工具/工人使用。 数学Jax `^4.1.0` 是一个对等依赖; React and ReactDOM 18/19 是可选的对等关系. [软件包.json](https://npmcn.com/package/%40drghaliasri/butex/package.json) 定义当前版本、支持的导入和 CLI 名称. ## 公共入境点 | 导入/ 可执行文件 | 已执行用途 | | --- | --- | | `@drghaliasri/butex` | 核心阿拉伯语 MathJax 宏, `parseBuTeX`,注册,数学岛渲染 | | `@drghaliasri/butex/react` | 独立 `ButexEditor` 等式编辑器 | | `@drghaliasri/butex/document` | `DocumentJson`,命令,导入/导出,大纲,验证,diff | | `@drghaliasri/butex/react-document` | `ButexDocumentEditor` 编辑器 | | `@drghaliasri/butex/react-document-preview` | 轻量级只读 `ButexDocumentPreview` | | `butex-document` | 无国籍的Stdin/经认证的HTTP工人 | 已完成 **文件2 — 文件** 移民使第一代编辑退休,并将所维护的模型,工人和React编辑推广到上面的未转录名称. 这些是现在 **8.0.3 国家** 软件包接口,不等待迁移分支 API。 见 [修复后校验](https://npmcn.com/package/%40drghaliasri/butex/docs/development/document-migration-postfix-20261108.md) 证据和释放资格. ## MathJax 设置 使用数学Jax **页:1** `tex-chtml.js` 或者说 `tex-svg.js`,匹配 `chtml` 编号 : `svg` 输出模式。 配置 `butex-arabic-math` TeX 软件包和调用 `registerBuTeX` 在 MathJax 启动完成之前 。 使用 `registerBuTeXSvgTextWrapper` sVG特定阿拉伯语文本行为的启动初始化后. ```ts import { registerBuTeX, injectBuTeXStyles } from '@drghaliasri/butex'; // Inside your host's MathJax startup.ready integration: registerBuTeX(MathJax); injectBuTeXStyles(); // Then complete the chosen MathJax component's startup. ``` 见 [数学/投降架构](https://npmcn.com/package/%40drghaliasri/butex/docs/architecture/equations.md) 用于初始化和语义/视觉的RTL规则. `parseBuTeX` 是一个小型的阿拉伯友好表面预处理器, **没有** a 通用的 LaTeX 结构化的 AST 解析器. ## 文档模型基础 ```ts import { createEmptyDocument, fromDocumentJson, toDocumentJson, validateDocument, } from '@drghaliasri/butex/document'; const document = createEmptyDocument(); const validation = validateDocument(document); const saved = toDocumentJson(document); const restored = fromDocumentJson(saved); ``` 使用 `ButexDocumentEditor` 从 `@drghaliasri/butex/react-document` 用于交互式编辑器; 使用 `ButexDocumentPreview` 从 `@drghaliasri/butex/react-document-preview` 以显示只读快照. 重命名启用的图/表标签 `update_float_meta` 也更新匹配 `\ref`编号 :`\eqref` 在同一编辑中,整个文档中的符号; 取消或清除标签时,引用内容保持不变. **主办方责任:** 认证,文章权限,不可改变的修订,图像上传/存储,编译和出版. BuTeX 提供纯文档转换和编辑 UI,从没有文章数据库或MCP授权绕行. 见 [文档](https://npmcn.com/package/%40drghaliasri/butex/docs/architecture/document.md), (中文(简体) ), [反应整合](https://npmcn.com/package/%40drghaliasri/butex/docs/architecture/react-editor.md),以及 [员工](https://npmcn.com/package/%40drghaliasri/butex/docs/architecture/worker.md)。 。 。 . ## 开发和演示 ```bash npm ci npm run build npm run typecheck npm run lint npm test ``` 方程式编辑演示为 `demo/editor-app/`; 现代文档编辑器是 `demo/document-editor-app/`; 第一代演示被Canonical路径上推广的现代演示所取代. 读取 [地方发展](https://npmcn.com/package/%40drghaliasri/butex/docs/development/local.md) 财务报告和审定财务报表 [核查](https://npmcn.com/package/%40drghaliasri/butex/docs/development/verification.md)。 。 。 . ## 书籍撰写——仅提议 这个 [BuTeX 书籍设计](https://npmcn.com/package/%40drghaliasri/butex/docs/proposals/book-editor.md) 财务报告和审定财务报表 [Al-Bayan融合计划](https://github.com/Pontmousse/albayan/blob/develop/docs/proposals/book-authoring.md) 描述未来的多章编辑、范围参考和整本导出。 这些计划中的书籍/编辑/工人API **今天不要开船**。 。 。 . ## 文档 - [建筑](https://npmcn.com/package/%40drghaliasri/butex/docs/architecture/README.md) 执行的一揽子合同和东道国合同 - [发展](https://npmcn.com/package/%40drghaliasri/butex/docs/development/README.md) ——建设,浏览器测试和发布 - [提议](https://npmcn.com/package/%40drghaliasri/butex/docs/proposals/README.md) 编写和完成文件移徙证据 - [存档](https://npmcn.com/package/%40drghaliasri/butex/docs/archive/README.md) ——历史设计记录 Npm 沥青球包括 `dist/` 而这个读取; `docs/` 住在这里 [GitLab 仓库](https://gitlab.com/drghaliasri/butex)。 。 。 . ## 许可证 见许可证栏 [软件包.json](https://npmcn.com/package/%40drghaliasri/butex/package.json)。 。 。 . ## 常见问题 ### @drghaliasri/butex 是什么？ 阿拉伯语友好数学符号的 MathJax 扩展层\( XeLaTeX 类风俗超越了 Plain MathJax\) ### 如何安装 @drghaliasri/butex？ 在项目目录运行 npm install @drghaliasri/butex，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：mathjax（^4\.1\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。它还提供命令行工具 butex-document，可以用 npx butex-document 直接运行。 ### @drghaliasri/butex 支持 TypeScript 吗？ 支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。 ### @drghaliasri/butex 支持 ESM 还是 CommonJS？ 同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。 ### @drghaliasri/butex 需要什么版本的 Node\.js？ package\.json 的 engines 字段要求 Node\.js \>=20。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。 ### @drghaliasri/butex 可以商用吗？ @drghaliasri/butex 使用 ISC 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。 ### @drghaliasri/butex 的下载量有多少？ 根据 npm 官方下载统计，@drghaliasri/butex 在 2026/10/13 – 2026/11/11 这 30 天内被下载 2,092 次，日均约 70 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。 ### @drghaliasri/butex 还在维护吗？ 最新版本 8\.1\.2 发布于 2026/11/14（今天）；至今共发布 64 个版本，其中过去 12 个月发布了 64 个；首次发布于 2026/06/17。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。