@asciidoctor/reveal.js

中文文档
6.0.1发布于 2026/11/05MITES Module构建来源已验证近 30 天下载 4000

Ascidoctor.js的转换器 用 AsciiDoc 写幻灯片!

中文使用文档
文档目录5 节
  1. 安装
  2. 命令行
  3. Java 脚本 API
  4. 文档
  5. 许可证

显示。 js 转换器为 Asciidodor.js

A express.js 转换器用于 Ascidoctor.js (英语) 将 AsciiDoc 文档转换为 HTML5 演示文稿,设计由 显示. js 说明框架.

安装

要求数 节点.js 20。 。 。 . asciidoctor 需要的同伴依赖关系(任何 >=4.2.1 <5.0.0 在转换器旁边安装:

npm i --save asciidoctor @asciidoctor/reveal.js

命令行

npx asciidoctor-revealjs presentation.adoc      # writes presentation.html
npx asciidoctor-revealjs -o - presentation.adoc # write to stdout

运行 npx asciidoctor-revealjs --help 用于完整选项列表.

Java 脚本 API

Ascidoctor.js 4.0是一个无害环境管理软件包,其转换功能是同步的,所以使用 import 财务报告和审定财务报表 await数字 :

import { convertFile } from 'asciidoctor'
import { register } from '@asciidoctor/reveal.js'

register() // registers the revealjs / reveal.js backends and the highlight.js adapter

await convertFile('presentation.adoc', { safe: 'safe', backend: 'revealjs' })

文档

关于设置指令和用于编写演示文稿的AsciiDoc语法,参见 文档。 。 。 .

许可证

麻省理工学院.

版本与发布记录

@asciidoctor/reveal.js 共发布 14 个版本,首次发布于 2019/12/27;过去 12 个月发布了 3 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
6.0.1latest2026/11/052 天前
6.0.02026/11/025 天前
6.0.0-beta.2testing2026/07/303 个月前
5.2.02024/12/041.9 年前
5.1.02023/12/122 年前
5.0.12023/06/253 年前

关于 @asciidoctor/reveal.js 的常见问题

@asciidoctor/reveal.js 是什么?

Ascidoctor.js的转换器 用 AsciiDoc 写幻灯片!

如何安装 @asciidoctor/reveal.js?

在项目目录运行 npm install @asciidoctor/reveal.js,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:asciidoctor(>=4.2.1 <5.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。它还提供命令行工具 asciidoctor-revealjs,可以用 npx asciidoctor-revealjs 直接运行。

@asciidoctor/reveal.js 支持 TypeScript 吗?

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

@asciidoctor/reveal.js 支持 ESM 还是 CommonJS?

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

@asciidoctor/reveal.js 需要什么版本的 Node.js?

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

@asciidoctor/reveal.js 可以商用吗?

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

@asciidoctor/reveal.js 的下载量有多少?

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

@asciidoctor/reveal.js 还在维护吗?

最新版本 6.0.1 发布于 2026/11/05(2 天前);至今共发布 14 个版本,其中过去 12 个月发布了 3 个;首次发布于 2019/12/27。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。