Reveal.js configuration¶

Use configure() to pass any option to Reveal.initialize(). See the reveal.js config reference for all keys.

PyReveal also provides typed helpers for common options. See Reveal.js feature support.

Quick setup¶

from pyreveal import Presentation, Slide, SlideNumber, Theme, Transition

deck = (
    Presentation("Talk", theme=Theme.WHITE, transition=Transition.SLIDE)
    .navigation(hash=True, progress=True)
    .deep_links(hash=True)
    .slide_numbers(SlideNumber.H_DOT_V)
    .presentation_size(1280, 720)
)

slide = Slide()
slide.id = "intro"
slide.title = "Hello"
deck.add(slide)

Helper methods¶

Method	Purpose
`navigation()`	Controls, progress, touch, overview, keyboard
`deep_links()`	Hash URLs and slide deep linking
`slide_numbers()`	Slide number format
`scroll_view()`	Scrollable deck layout
`print_view()`	Print-optimized layout
`presentation_size()`	Base width/height and scale bounds
`preview_links()`	Global link lightbox previews
`auto_slide(interval_ms, …)`	Deck-wide auto-advance (kiosk mode)
`auto_progression(…)`	Alias for `auto_slide()`
`parallax_background(image, …)`	Deck-wide parallax scrolling background
`keyboard_bindings(bindings, …)`	Custom keyboard shortcut map
`configure(**options)`	Any other reveal.js option

Scroll view¶

deck.scroll_view()

Auto-slide (kiosk)¶

Advance every slide on a timer. Per-slide Slide(auto_slide=…) still overrides individual slides.

deck.auto_slide(5000)                    # every 5 seconds
deck.auto_slide(3000, loop=True)         # loop the deck
deck.auto_slide(False)                   # disable globally
deck.auto_progression(5000)              # same as auto_slide()

Parallax background¶

Deck-wide parallax uses reveal.js parallaxBackground* options. Per-slide parallax is still available via slide.bg(…, parallax=…).

deck.parallax_background(
    "assets/parallax.jpg",
    size="2100px 900px",
    horizontal=200,
    vertical=50,
)

Custom keyboard bindings¶

Override default shortcuts with a key-code map. Use None to disable a key, and KeyboardBinding for typed actions:

from pyreveal import KeyboardBinding, Presentation

deck.keyboard_bindings(
    {13: KeyboardBinding.NEXT, 32: None, 66: "togglePause"},
    condition="focused",
)

See reveal.js keyboard bindings for key codes.

Raw configure passthrough¶

deck.configure(hash=True, progress=True, slideNumber="h.v", controls=True)

Theme and transition¶

Use typed enums. See Choices:

Setting	How to set
Theme	`Presentation(theme=Theme.DRACULA)` or `set_theme(Theme.DRACULA)`
Transition	`Presentation(transition=Transition.FADE)` or `set_transition(Transition.FADE)`

configure(transition="zoom") overrides the presentation default at render time.

Export¶

# Simple: creates parent directories
deck.save("output/talk/deck.html")

# Show PDF export URL after save
deck.save("output/talk/deck.html", pdf_hint=True)

# Build the print URL manually
Presentation.pdf_print_url("output/talk/deck.html")
# -> output/talk/deck.html?print-pdf

# Legacy: fixed output folder name
deck.save_to_file("deck.html", output_dir="build/my-talk")

# HTML string only
html = deck.html()

Open the ?print-pdf URL in Chromium and print to PDF. See the PDF export guide.

save() copies reveal.js assets into the output folder by default.

Extra CSS¶

deck.stylesheet("custom.css")
deck.css("section { font-size: 28px; }")