# @aufbau/editor 中文文档

规范地址：https://npmcn.com/package/%40aufbau/editor/

版本：0\.0\.19
npm 元数据更新时间：2026-11-11T23:11:39.949Z
中文译文更新时间：2026-11-13T05:14:21.477Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40aufbau/editor
原文对照：https://npmcn.com/package/%40aufbau/editor/?lang=original
项目主页：https://github.com/gleachkr/aufbau#readme
源码仓库：https://github.com/gleachkr/aufbau

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

- 包体积（解压后）：101 kB，4 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- 运行依赖：0 个
- peer 依赖：@aufbau/lsp \*，@aufbau/compiler \*，@codemirror/lint ^6，@codemirror/view ^6，@codemirror/state ^6，@codemirror/commands ^6，@codemirror/autocomplete ^6
- 首次发布：2026-07-14T11:30:48.304Z
- 最新版本发布：2026-11-11T23:11:39.571Z
- 近 30 天下载量：2230（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：84（近 12 个月 84 个）

## 中文简介

可嵌入交互式 Aufbau 验证编辑器作为网络组件.

## 安装

```sh
npm install @aufbau/editor
```

也可以使用：`pnpm add @aufbau/editor`、`yarn add @aufbau/editor`、`bun add @aufbau/editor`

## README

# `@aufbau/editor`

MM0理论和Aufbau证明的可嵌入浏览器编辑器组件. 汇编和诊断在WebAssembly在当地进行.

## 安装

```sh
npm install @aufbau/editor @aufbau/compiler \
  @codemirror/view @codemirror/state @codemirror/commands \
  @codemirror/lint
```

对于语言服务器徘徊、完成和验证搜索,也安装 可选软件包 :

```sh
npm install @aufbau/lsp @codemirror/autocomplete
```

## 使用量

导入包时登记其自定义元素 :

```js
import "@aufbau/editor";
```

```html
<aufbau-theory id="example" src="/example.mm0"></aufbau-theory>

<aufbau-proof theory="example" src="/example.auf"></aufbau-proof>
```

来源也可能是内含的:

```html
<aufbau-theory id="example">
  <script type="text/mm0">
    -- MM0 source
  </script>
</aufbau-theory>

<aufbau-proof theory="example">
  <script type="text/auf">
    -- Aufbau proof script
  </script>
</aufbau-proof>
```

具有相同特性的多个证明要素 `theory` 值在 DOM 中形成一个文档 秩序。 秩序。 使用 `readonly`, (中文(简体) ), `theme="light|dark|auto"`,或 `lsp="off"` 调整一个 个人证明要素。 该软件包还登记 `<aufbau-index>` (单位:千美元) 现场语句索引.

理论和证据可能 `import "other.mm0";` 编号 : `include "other.auf";`编辑 已命名文件相对于页面( 内入源) 或源文件 拥有 URL (`src` 来源),并获取 `.mm0` 带上它 `.auf` 一起来 当服务器有一个.

此软件包需要浏览器 DOM. 它不运行在平地节点下.

## 从 CDN 装入

组件不需要捆绑,也不需要建设步骤——导入地图就够了。 这个 `?external=` 参数将 CodeMirror 和 Aufbau 主题包保持为单一 共享实例而不是每个依赖者一份副本 :

```html
<script type="importmap">
  {
    "imports": {
      "@codemirror/state": "https://esm.sh/@codemirror/state",
      "@codemirror/view": "https://esm.sh/@codemirror/view?external=@codemirror/state",
      "@codemirror/commands": "https://esm.sh/@codemirror/commands?external=@codemirror/state,@codemirror/view",
      "@codemirror/lint": "https://esm.sh/@codemirror/lint?external=@codemirror/state,@codemirror/view",
      "@codemirror/autocomplete": "https://esm.sh/@codemirror/autocomplete?external=@codemirror/state,@codemirror/view",
      "@aufbau/compiler": "https://esm.sh/@aufbau/compiler",
      "@aufbau/lsp": "https://esm.sh/@aufbau/lsp",
      "@aufbau/editor": "https://esm.sh/@aufbau/editor?external=@aufbau/compiler,@aufbau/lsp,@codemirror/state,@codemirror/view,@codemirror/commands,@codemirror/lint,@codemirror/autocomplete"
    }
  }
</script>
<script type="module">
  import "@aufbau/editor";
</script>
```

语言服务器在 Web Worker 中运行,浏览器只能从中构建 一个同源的脚本,所以 `@aufbau/lsp` 靴子绑住它 `blob:` URL 当 它从一个CDN服务。 因此,需要一个内容-安全政策的网页 `worker-src blob:` 与CDN主机一起 `@aufbau/lsp` 读取。 丢弃 页:1 `@aufbau/lsp` 财务报告和审定财务报表 `@codemirror/autocomplete` 不包含要运行的条目 语言服务器;编辑器仍会编译并报告诊断.

拥有自己全球键盘快捷键的主机页面应注意 键键键在细胞泡中被打出其阴影根,重新瞄准 `<aufbau-*>` 主机元素 。 如果这些快捷键吞下普通字符,请停止 键盘事件 `composedPath()` 包含一个 `AUFBAU-` 元素在 页面的处理者看到他们.

## 常见问题

### @aufbau/editor 是什么？

可嵌入交互式 Aufbau 验证编辑器作为网络组件\.

### 如何安装 @aufbau/editor？

在项目目录运行 npm install @aufbau/editor，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@aufbau/compiler（\*）、@codemirror/lint（^6）、@codemirror/view（^6）、@codemirror/state（^6）、@codemirror/commands（^6）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @aufbau/editor 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/aufbau\_\_editor 是否存在。

### @aufbau/editor 支持 ESM 还是 CommonJS？

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

### @aufbau/editor 可以商用吗？

@aufbau/editor 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @aufbau/editor 的下载量有多少？

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

### @aufbau/editor 还在维护吗？

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