Skip to main content

Reveal Embed

Description

This plugin creates various embeds for slides generated using reveal.js. It currently supports embeding into a Docusaurus site. In order to add support for other platforms or site generators, you can add a new Jinja template into the plugins/embed_reveal_templates directory.

Options

parametertyperequireddefaultdescription
frontmatterMapping[str, str]falseN\AThe frontmatter to add to the output file.
widthstrfalse100%The width of the embed.
heightstrfalse500pxThe height of the embed.
linkstrfalseN\AThe text for the hyperlink to the presentation. If not specified, no link will be rendered.
targetstrtrueN\AThe target template to use.
extensionstrfalseN\AThe extension of the output file.
buildMapping[str, str]trueN\AWhat slides to embed as a mapping of name to final static location.

Example:

embed_slides:
plugin: reveal_embed
options:
target: docusaurus
extension: mdx
link: Open the slides in a new tab
width: 100%
height: 300px
frontmatter:
title: Lecture 1
id: lecture1
build:
Compute: Compute