API

slide_mode_settings(; theme=nothing, footer_left=" ", footer_center="", kwargs...)

Install the PlutoSlides style and scripts in the notebook. Call it once, in its own cell.

General

• theme: a built-in theme name (see available_themes) or a NamedTuple/Dict of keyword overrides. Explicit keywords always win over the theme.
• footer_left, footer_center: footer contents.
• h3_title=true: give ### headings their own slide.
• max_width="98%": maximum width of the notebook content.
• font_family=nothing: CSS font-family stack applied everywhere.
• font_size=19: base font size in px (everything scales with it); nothing keeps Pluto's.

PDF export

• pdf_aspect="a4": printed slide shape (width/height): a number, "16:9", (297, 210), "a4", "letter" or "screen" (the browser window's ratio).
• pdf_stretch=0.8: multiplier on the printed slide height only. A printed slide is never shorter than the live one, whatever these two work out to: it is laid out at the window's width, so a shorter page would cut its bottom off rather than scale it down.

Logos (slide mode only)

• logo: one item or a vector: URL/path String, Resource, LocalResource, md"...", HTML...
• logo_position="top-right": "top-left", "top-right", "bottom-left", "bottom-right", "top-center", "bottom-center", or manual coordinates (top="15%", left="4em") (keys top, bottom, left, right, transform; (x, y) means (left=x, top=y)).
• logo_height, logo_opacity, logo_offset_x, logo_offset_y: scalar or one per logo. Numbers are px. Offsets only apply to anchored logos.

Colors: color_subtitle_bg="#3333B3" (structural color), color_band_text, color_title_bg, color_title_right_bg, color_controls_bg, color_footer_left_bg, color_footer_center_bg, color_footer_right_bg, color_h1, color_h3, color_h3_border, color_h3_bg, color_title_text, color_subtitle_text, color_footer_text, color_page_bg, color_text. Unset ones derive from color_subtitle_bg via mix_black (and, for color_h3_bg, mix_white).

Band style: band_overlay (CSS gradient over every band), band_radius, band_shadow, subtitle_border, footer_border, subtitle_align ("left"/"center"), show_title_band=true.

Examples

slide_mode_settings(footer_left="Jane Doe", footer_center=md"My talk")slide_mode_settings(theme=:Warsaw, band_radius="10px", band_shadow="none")slide_mode_settings(logo=["uni.png", "lab.svg"], logo_position=["top-right", "bottom-left"])

slide_mode_title(; title=nothing, author=nothing, figures=nothing, footnote=nothing, color=nothing)

A title slide. title, author and footnote accept any displayable content (String, md"...", HTML...); figures is one item or a vector (e.g. Resources) shown in a row. color sets the title band background (default: the theme's structural color).

Example

slide_mode_title(title="My talk", author=md"Jane Doe -- *INRAE*",    figures=[Resource("https://example.org/logo.png", :width => 100)])

slide_mode_button(; start_in_slide_mode_html=false, start_in_slide_mode_notebook=false, start_slide=0)

A button that toggles slide mode on and off. Needs slide_mode_settings in the notebook.

Set start_in_slide_mode_html=true to open the notebook's HTML export directly in slide mode, and start_in_slide_mode_notebook=true to do the same when it runs in Pluto. start_slide is the slide they open on, numbered as in the slide counter (0 = first).

pause()
pause(n::Integer)

Invisible marker for step-by-step reveals: content after it appears on the next step, or from step n onwards (like Beamer's \pause[n]). Experimental.

Example

md"""Always visible$(pause(1))Shown from step 1"""

webpage(url; width="75%", ratio="50%", title="", offset=0, center=true)

Embed the web page at url in an <iframe>. ratio is the box height as a fraction of its width, offset crops that many px (or a CSS length) off the top of the page – a negative offset instead pushes the page down, leaving a gap – and center centers it horizontally.

myWebPage(url; kwargs...)

Deprecated alias for webpage.

available_themes() -> Vector{Symbol}
available_themes(; descriptions = true) -> Vector{Pair{Symbol,String}}

Names of the built-in themes for slide_mode_settings(theme = ...), optionally paired with a one-line description of each.

mix_black(color::AbstractString, p::Real) -> String

Return the given hex color mixed with black by fraction p in [0,1]. Supports #rgb and #rrggbb. On parse errors, returns the input color.

mix_white(color::AbstractString, p::Real) -> String

Return the given hex color mixed with white by fraction p in [0,1], i.e. a tint of it: p = 1 is white, p = 0 is the color itself. The counterpart of mix_black, used for the pale block behind h3 headings. Supports #rgb and #rrggbb. On parse errors, returns the input color.

PlutoUI.LocalResource(dir, path, html_attributes::Pair...)

LocalResource for the first file matching path found in dir or any of its subdirectories. Throws an ArgumentError if none is found.