# @atjson/renderer-html 中文文档

规范地址：https://npmcn.com/package/%40atjson/renderer-html/

版本：0\.40\.0
npm 元数据更新时间：2026-08-12T13:42:49.742Z
中文译文更新时间：2026-11-07T02:10:56.922Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：39.3 kB，5 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：2 个
- peer 依赖：@atjson/document \>= 0\.29\.0 \< 1
- 首次发布：2019-07-24T16:42:14.383Z
- 最新版本发布：2026-08-12T13:42:49.484Z
- 近 30 天下载量：5115（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：118（近 12 个月 2 个）

## 中文简介

从 atjson 复制 HTML 文档

## 安装

```sh
npm install @atjson/renderer-html
```

也可以使用：`pnpm add @atjson/renderer-html`、`yarn add @atjson/renderer-html`、`bun add @atjson/renderer-html`

## README

# @ atjson/ landder-html 页面存档备份,存于互联网档案馆

取一个附加注释的文档并将其转换为 HTML 。 默认情况下,这将需要一个抵消文档并将其提交到 HTML.

## 扩展

HTML 渲染器有一个 `$` 方法,旨在方便扩展和写入自己的输出到HTML.

要将目前的HTML渲染器扩展至支持YouTube嵌入(即使用共享菜单时出现的那种),我们将使用以下代码:

```ts
import { YouTubeEmbed } from '@atjson/offset-annotations';
import HTMLRenderer from '@atjson/renderer-html';

export default MyHTMLRenderer extends HTMLRenderer {
  *YoutubeEmbed(embed: YouTubeEmbed) {
    return yield* this.$('iframe', {
      attributes: {
        width: embed.attributes.width,
        height: embed.attributes.height,
        src: embed.attributes.url,
        frameborder: '0',
        allow: 'accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture',
        allowfullscreen: true
      }
    });
  }
}
```

现在,当我们放进一个视频,喜欢 `https://www.youtube.com/watch?v=RrkL9e2w7gQ`,我们会得到以下:

```html
<iframe
  width="560"
  height="315"
  src="https://www.youtube.com/embed/RrkL9e2w7gQ"
  frameborder="0"
  allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture"
  allowfullscreen
></iframe>
```

## 常见问题

### @atjson/renderer-html 是什么？

从 atjson 复制 HTML 文档

### 如何安装 @atjson/renderer-html？

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

### @atjson/renderer-html 支持 TypeScript 吗？

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

### @atjson/renderer-html 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @atjson/renderer-html 可以商用吗？

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

### @atjson/renderer-html 的下载量有多少？

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

### @atjson/renderer-html 还在维护吗？

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