repository·main·Indexed 43 days ago
https://github.com/asciidoctor/asciidoctor-reveal.jsA reveal.js converter for Asciidoctor.js (version 6.0.0-beta.2) that transforms AsciiDoc documents into HTML5 presentations. It provides a CLI tool, a JavaScript API, and support for custom CSS, docinfo injection, speaker notes, and metadata attributes for source code, checklists, quotes, STEM blocks, and media.
To avoid managing a local reveal.js directory, you can point the :revealjsdir: attribute to a CDN like jsDelivr.
Warning:
Example attribute usage:
:revealjsdir: https://cdn.jsdelivr.net/npm/reveal.jsWhen implementing rate limiters, keep the following considerations in mind:
capacity to prevent infinite accumulation.per_client).Date.now() call across different replicas, as clocks will drift.Retry-After header so well-behaved clients can implement back-off logic instead of repeatedly hammering the API.429 (Too Many Requests) error rates rather than just standard 5xx errors.The converter allows you to apply visual customizations specifically to the title slide, such as background colors, images, videos, iframes, or transitions.
To use these settings, you must adapt the standard reveal.js data- attributes by replacing the data- prefix with title-slide-. For example, to set a background image, use the title-slide-image attribute instead of data-background-image.
Vertical slides are created by nesting sections. When a slide contains sub-sections (e.g., === Sub-section), reveal.js renders the sub-sections vertically below the parent slide.
== Slide 6
Top slide
=== Slide 6.1
This is a vertical sub-slideSteps (known as fragments in reveal.js) allow you to highlight or incrementally reveal individual elements on a slide. Every element assigned the fragment role or the step option will be revealed one-by-one during the presentation sequence before moving to the next slide.
Recommendation: While you can use the fragment role on any element, it is recommended to use the step option to declare a fragment. This ensures better portability and avoids CSS conflicts when using other Asciidoctor converters.
== Topic
[%step]
* this
* is
* revealed
* graduallyAurora is built using CSS custom properties (design tokens). You can rebrand the entire presentation by overriding these tokens in a :customcss: file or by editing aurora.css directly.
Key token categories include:
--aurora-bg, --aurora-surface, --aurora-ink, and semantic colors like --aurora-coral (caution) or --aurora-lime (tip).--aurora-font-display), body (--aurora-font-body), and code (--aurora-font-code).--aurora-radius and shadow settings.--r-* properties.Auto-animate settings are configured using Asciidoctor attributes and options, which are mapped to HTML data-* attributes.
%auto-animate).auto-animate-easing=ease-in-out).:notitle: attribute now correctly suppresses the title slide. If you have :notitle: set in your document and wish to see a title slide, you must remove this attribute.asciidoctor-reveal.js presentations, footnote numbering is scoped to the individual slide. The numbering will reset to 1 at the start of every new slide.Because slide-header and slide-footer are inserted into the <section> of every slide (both horizontal and vertical), they are best used for content that should appear on every slide, such as:
The appearance of a presentation can be controlled at three different levels of specificity using these attributes:
:revealjs_theme:: Selects a built-in, ready-made stylesheet provided by reveal.js (e.g., black, white, league). This is the base layer.:revealjs_customtheme:: Replaces the built-in theme entirely with a file or URL of your own. Use this when you are authoring or reusing a complete, standalone theme.:customcss:: Adds an extra stylesheet on top of the active theme (built-in or custom). It is loaded after the theme, making it ideal for small tweaks like adjusting margins or colors for a single presentation.