# @asciidoctor/docbook-converter 中文文档

规范地址：https://npmcn.com/package/%40asciidoctor/docbook-converter/

版本：3\.0\.0
npm 元数据更新时间：2024-09-02T09:44:37.496Z
中文译文更新时间：2026-11-08T10:29:13.500Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：112 kB，5 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：未声明
- Node.js 要求：\>=8\.11
- 运行依赖：0 个
- peer 依赖：@asciidoctor/core \>= 3\.0 \< 4\.0
- 首次发布：2019-04-01T06:52:04.762Z
- 最新版本发布：2024-09-02T09:44:37.256Z
- 近 30 天下载量：1803（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：4（近 12 个月 0 个）

## 中文简介

Ascidoctor.js 的 DocBook 转换器

## 安装

```sh
npm install @asciidoctor/docbook-converter
```

也可以使用：`pnpm add @asciidoctor/docbook-converter`、`yarn add @asciidoctor/docbook-converter`、`bun add @asciidoctor/docbook-converter`

## README

# Ascidoctor.js 的 DocBook 转换器

[![Build](https://github.com/asciidoctor/asciidoctor-docbook.js/actions/workflows/build.yml/badge.svg)](https://github.com/asciidoctor/asciidoctor-docbook.js/actions/workflows/build.yml) [![npm version](http://img.shields.io/npm/v/@asciidoctor/docbook-converter.svg)](https://www.npmjs.com/package/@asciidoctor/docbook-converter)

## 安装

```sh
$ npm i @asciidoctor/core @asciidoctor/docbook-converter
```

## 使用量

### 国 际

如果你正在使用 [Ascidoctor.js CLI (英语)](https://github.com/asciidoctor/asciidoctor-cli.js) 然后,你可以使用这个 `--require` 选项以装入 DocBook 转换器 :

```
$ asciidoctor --require @asciidoctor/docbook-converter --backend docbook doc.adoc
```

上述命令将生成一个名为的文件 _医生.xml_ 使用 DocBook 转换器.

### API 密码

也可以使用API将AsciiDoc的内容转换为DocBook.

#### 无害环境管理(进口)

ECMAScript模块是包装JavaScript代码的官方标准格式. 我们建议使用 `import` 指令 :

```js
import Asciidoctor from '@asciidoctor/core'
import docbookConverter from '@asciidoctor/docbook-converter'

const asciidoctor = Asciidoctor() // instantiate Asciidoctor
docbookConverter.register() // register the DocBook converter

const content = `= DocBook
Author Name
v1.0, 2020-04-13
:doctype: book
:doctitle: Awesome Asciidoctor
:docdate: 2020-01-01

== First section

Once upon a time...`

const docbook = asciidoctor.convert(content, { backend: 'docbook5', standalone: true })
//console.log(docbook)
```

**关键是:** 在注册 DocBook 转换器之前, 请先将 Asciidodor 立即进行 .

**注:** 自兹 `@asciidoctor/core` 尚未作为 ECMAScript 模块发布,您将使用 Webpack 、 Rollup 或 Parcel 等 Web 捆绑器使用 `import` 指令.

#### 普通JS( 必需)

```js
const asciidoctor = require('@asciidoctor/core')()
const docbookConverter = require('@asciidoctor/docbook-converter')

docbookConverter.register() // register the DocBook converter
```

#### UMD 图像

此外,我们还提供 [通用模块定义](https://github.com/umdjs/umd) 导出一个名为全局对象 `AsciidoctorDocBook`。 。 。 . Ascidoctor.js 装入后,您需要使用 `register`数字 :

```js
/* global Asciidoctor, AsciidoctorDocBook */
const asciidoctor = Asciidoctor()
AsciidoctorDocBook.register() // register the DocBook converter
```

## 常见问题

### @asciidoctor/docbook-converter 是什么？

Ascidoctor\.js 的 DocBook 转换器

### 如何安装 @asciidoctor/docbook-converter？

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

### @asciidoctor/docbook-converter 支持 TypeScript 吗？

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

### @asciidoctor/docbook-converter 支持 ESM 还是 CommonJS？

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

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

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

### @asciidoctor/docbook-converter 可以商用吗？

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

### @asciidoctor/docbook-converter 的下载量有多少？

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

### @asciidoctor/docbook-converter 还在维护吗？

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