# 0721c 中文文档

规范地址：https://npmcn.com/package/0721c/

版本：0\.3\.1
npm 元数据更新时间：2026-10-06T13:07:53.359Z
中文译文更新时间：2026-10-31T11:38:39.239Z
软件包许可：UNLICENSED

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

原始 npm 页面：https://www.npmjs.com/package/0721c
原文对照：https://npmcn.com/package/0721c/?lang=original

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

- 包体积（解压后）：260 kB，89 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22
- 运行依赖：3 个
- peer 依赖：vue \>=3\.5\.0 \<4，@nuxt/kit \>=3\.17\.0 \<5
- 首次发布：2026-10-05T08:19:53.645Z
- 最新版本发布：2026-10-06T13:07:53.191Z
- 已发布版本数：9（近 12 个月 9 个）

## 中文简介

GitHub发布提交，人工审查和可读的静态评论树

## 安装

```sh
npm install 0721c
```

也可以使用：`pnpm add 0721c`、`yarn add 0721c`、`bun add 0721c`

## README

# 0721c

基于 GitHub Issue 投稿评论、PR 审核评论、Actions 自动生成评论索引的前端评论系统。

读者点击网站上的“发表评论”或“回复”，在 GitHub 中填写正文。提交后，工作流将评论转成审核 PR 并关闭 Issue；维护者合并 PR 后，评论显示在网站上。

## 开始使用

安装到网站项目：

```sh
npm install 0721c
```

直接初始化评论仓库：

```sh
npx 0721c init ./blog-comments
```

准备一个公开的 GitHub 评论仓库，以及要接入评论的网站。评论仓库与网站源码仓库分别管理。

1.  [初始化评论仓库](https://npmcn.com/package/0721c/docs/INITIALIZATION.md)：安装工具、生成分支、上传并设置 Actions。
2.  接入网站：[Nuxt Content](https://npmcn.com/package/0721c/docs/NUXT_CONTENT.md) 或 [Vue / JavaScript](https://npmcn.com/package/0721c/docs/INTERFACE_CONTRACT.md)。
3.  从网站提交一条评论，在评论仓库审核 PR，合并后查看网站上的评论。
4.  按需设置[邮件通知](https://npmcn.com/package/0721c/docs/EMAIL_NOTIFICATIONS.md)，在文章收到评论或评论收到回复时发送提醒。

本地工具要求 Node.js 22 或更新版本、Git。Vue 组件要求 Vue 3.5，Nuxt 模块支持 Nuxt 3.17 至 4.x。 当前版本为 0.3.1，安装方式见初始化说明。

## Nuxt Content 接入示例

在 `nuxt.config.ts` 中指定评论仓库和文章路径：

```ts
export default defineNuxtConfig({
  modules: ['@nuxt/content', '0721c/nuxt'],
  comments0721c: {
    repository: 'OWNER/REPO',
    siteUrl: 'https://blog.example',
    content: { pathPrefixes: ['/article'] },
  },
});
```

在公共文章模板的正文后挂载组件，其中 `page` 是当前查询到的 Content 文档：

```vue
<ClientOnly>
  <ContentComments0721c :document="page" />
</ClientOnly>
```

组件从文档取得文章路径和标题。详细配置、Front Matter 和样式示例见 [Nuxt Content 接入](https://npmcn.com/package/0721c/docs/NUXT_CONTENT.md)。

## 自定义评论区文案

在 `comments0721c` 中设置 `messages`，统一覆盖网站提示：

```ts
messages: {
  error: '评论加载失败，请注意，评论系统需要确保当前网络环境能够连接 GitHub',
  stale: '刷新失败，请确保当前网络环境能够连接 GitHub',
}
```

未填写的键继续使用内置文案。完整配置见[自定义文案](https://npmcn.com/package/0721c/docs/NUXT_CONTENT.md#%E8%87%AA%E5%AE%9A%E4%B9%89%E6%8F%90%E7%A4%BA%E6%96%87%E6%A1%88)。

## 评论仓库

| 分支 | 用途 | 日常操作 |
| --- | --- | --- |
| `main` | 工作流、运行文件和配置 | 调整策略，更新运行文件 |
| `comments` | 已审核的评论记录 | 合并评论 PR，编辑或删除评论 |
| `index` | 前端读取的文章评论树 | 由工作流生成 |

例如文章 `/article/essay/2026-09-28-hello` 的数据保存在：

```text
comments 分支
article/essay/2026-09-28-hello/comments-37.json

index 分支
article/essay/2026-09-28-hello.json
```

评论记录按文章路径分目录，文件名为 `comments-<Issue 编号>.json`。网站读取 `index` 分支中当前文章的 JSON 文件。

## 文档

-   [初始化与部署](https://npmcn.com/package/0721c/docs/INITIALIZATION.md)：安装、上传、Actions 设置和首次使用。
-   [Nuxt Content 接入](https://npmcn.com/package/0721c/docs/NUXT_CONTENT.md)：配置、公共模板、文章筛选和样式。
-   [接口参考](https://npmcn.com/package/0721c/docs/INTERFACE_CONTRACT.md)：Vue 组件、JavaScript 客户端和 CLI。
-   [邮件通知](https://npmcn.com/package/0721c/docs/EMAIL_NOTIFICATIONS.md)：Resend 设置、发件地址、收件规则和通知排障。
-   [维护与排障](https://npmcn.com/package/0721c/docs/MAINTENANCE.md)：审核、删除、关闭评论、更新和故障定位。
-   [数据格式](https://npmcn.com/package/0721c/docs/PROTOCOL.md)：评论记录、回复树、投稿模板和配置文件。
-   [开发指南](https://npmcn.com/package/0721c/docs/IMPLEMENTATION.md)：源码结构、处理流程和修改方法。

## 常见问题

### 0721c 是什么？

GitHub发布提交，人工审查和可读的静态评论树

### 如何安装 0721c？

在项目目录运行 npm install 0721c，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 0721c，可以用 npx 0721c 直接运行。

### 0721c 支持 TypeScript 吗？

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

### 0721c 支持 ESM 还是 CommonJS？

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

### 0721c 需要什么版本的 Node\.js？

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

### 0721c 可以商用吗？

0721c 使用 UNLICENSED 许可。作者声明为 UNLICENSED，即不授予公开使用许可（与公共领域的 Unlicense 不同）。使用前需获得作者授权。以上为概括，不构成法律意见，请以许可原文为准。

### 0721c 还在维护吗？

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