reveal.js converter for Asciidoctor.js
A reveal.js converter for Asciidoctor.js that transforms an AsciiDoc document into an HTML5 presentation designed to be executed by the reveal.js presentation framework.
Install
Requires Node.js >= 20 . asciidoctor is a required peer dependency (any >=4.2.1 <5.0.0 release), so install it alongside the converter:
npm i --save asciidoctor @asciidoctor/reveal.js
Command line
npx asciidoctor-revealjs presentation.adoc # writes presentation.html
npx asciidoctor-revealjs -o - presentation.adoc # write to stdout
Run npx asciidoctor-revealjs --help for the full option list.
JavaScript API
Asciidoctor.js 4.0 is an ESM package and its conversion functions are asynchronous, so use import and 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' })
Documentation
For setup instructions and the AsciiDoc syntax used to write a presentation, see the documentation .
License
MIT.
@asciidoctor/reveal.js 是什么？ A reveal.js converter for Asciidoctor.js. Write your slides in 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 和提交记录判断。