# @asciidoctor/tabs 中文文档

规范地址：https://npmcn.com/package/%40asciidoctor/tabs/

版本：1\.0\.0-beta\.6
npm 元数据更新时间：2023-08-01T03:23:54.334Z
中文译文更新时间：2026-11-06T22:34:54.223Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：34 kB，7 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- Node.js 要求：\>=16\.0\.0
- 运行依赖：0 个
- 首次发布：2022-10-01T19:41:32.355Z
- 最新版本发布：2023-08-01T03:23:54.216Z
- 近 30 天下载量：45381（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：18（近 12 个月 0 个）

## 中文简介

Ascidoctor.js 扩展名,将标签块添加到 AsciiiDoc 语法中.

## 安装

```sh
npm install @asciidoctor/tabs
```

也可以使用：`pnpm add @asciidoctor/tabs`、`yarn add @asciidoctor/tabs`、`bun add @asciidoctor/tabs`

## README

# 辅助标签

Ascidoctor.js 扩展名,将标签块添加到 AsciiiDoc 语法中.

## 安装

此软件包取决于 `asciidoctor` 软件包(qq 2. 2. 2. 0, < 3. 0.0),但并未宣布它是依赖关系. 因此,在安装这个包时必须安装这个包.

```console
$ npm i asciidoctor @asciidoctor/tabs
```

## 语法

标签集使用附加在标签样式附加说明的示例块中的描述列表(dlist)来定义.

```asciidoc
[tabs]
====
Tab A:: Contents of Tab A.

Tab B::
+
Contents of Tab B.

Tab C::
+
--
Contents of Tab C.

Contains more than one block.
--
====
```

您可以选择将块分隔器的长度从典型的 4 个字符扩展至 6 个,以避免与标签块内的任何示例块相冲突(或只是风格问题).

```asciidoc
[tabs]
======
Tab A::
+
====
Example block in Tab A.
====

Tab B:: Just text.
======
```

使用这种技术,也可以创建嵌入式制表器.

```asciidoc
[tabs]
======
Tab A::
+
Selecting Tab A reveals a tabset with Tab Y and Tab Z.
+
[tabs]
====
Tab Y:: Contents of Tab Y, nested inside Tab A.
Tab Z:: Contents of Tab Z, nested inside Tab A.
====

Tab B:: Just text.
======
```

## 使用量

### 国 际

```console
$ npx asciidoctor -r @asciidoctor/tabs tabs.adoc
```

这个 `asciidoctor` 命令在需要软件包时自动登记标签扩展.

### API 密码

与 Asciidodor.js API 有两种方式使用扩展. 无论哪种情况,你都必须需要Asciidodor.js模块(`asciidoctor`在需要这个之前.

您可以调用导出 `register` 没有参数将扩展注册为全局扩展.

```js
const Asciidoctor = require('asciidoctor')()

require('@asciidoctor/tabs').register()

Asciidoctor.convertFile('tabs.adoc', { safe: 'safe' })
```

或者你可以通过注册实例 `register` 将扩展的登记方法纳入范围登记.

```js
const Asciidoctor = require('asciidoctor')()

const registry = Asciidoctor.Extensions.create()
require('@asciidoctor/tabs').register(registry)

Asciidoctor.convertFile('tabs.adoc', { extension_registry: registry, safe: 'safe' })
```

您还可以要求 `@asciidoctor/tabs/extensions` 访问 `Extensions` 课. 附于该对象的有: `Block`, (中文(简体) ), `Docinfo.Style`,以及 `Docinfo.Behavior` 扩展课程. 您可以使用这些课程注册备注标签扩展名 .

## 版权和许可证

版权 (C) 2018年至今 丹·艾伦(OpenDevise Inc.)和该项目的个人贡献者. 该软件的使用根据麻省理工学院许可证的规定准予.

## 常见问题

### @asciidoctor/tabs 是什么？

Ascidoctor\.js 扩展名,将标签块添加到 AsciiiDoc 语法中\.

### 如何安装 @asciidoctor/tabs？

在项目目录运行 npm install @asciidoctor/tabs，或使用 pnpm add / yarn add / bun add。

### @asciidoctor/tabs 支持 TypeScript 吗？

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

### @asciidoctor/tabs 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @asciidoctor/tabs 需要什么版本的 Node\.js？

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

### @asciidoctor/tabs 可以商用吗？

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

### @asciidoctor/tabs 的下载量有多少？

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

### @asciidoctor/tabs 还在维护吗？

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