Revealjs Options
Revealjs is an open source HTML presentation framework. To learn more about Revealjs see https://revealjs.com/.
See the Revealjs format user guide for more details on creating Revealjs output with Quarto.
format: revealjs
Format Options
theme |
Theme name, theme scss file, or a mix of both. |
css |
One or more CSS style sheets. |
identifier-prefix |
Specify a prefix to be added to all identifiers and internal links in HTML and DocBook output, and to footnote numbers in Markdown and Haddock output. This is useful for preventing duplicate identifiers when generating fragments to be included in other pages. |
email-obfuscation |
Specify a method for obfuscating
|
html-q-tags |
Use |
quarto-required |
A semver version range describing the supported quarto versions for this document or project. Examples:
|
Table of Contents
toc |
Include an automatically generated table of contents (or, in the case of Note that if you are producing a PDF via |
toc-depth |
Specify the number of section levels to include in the table of contents. The default is 3 |
toc-title |
The title used for the table of contents. |
Numbering
number-sections |
Number section headings rendered output. By default, sections are not numbered. Sections with class |
number-depth |
By default, all headings in your document create a numbered section. You customize numbering depth using the For example, to only number sections immediately below the chapter level, use this:
|
number-offset |
Offset for section headings in output (offsets are 0 by default) The first number is added to the section number for top-level headings, the second for second-level headings, and so on. So, for example, if you want the first top-level heading in your document to be numbered “6”, specify |
shift-heading-level-by |
Shift heading levels by a positive or negative integer. For example, with |
Slides
incremental |
Make list items in slide shows display incrementally (one by one). The default is for lists to be displayed all at once. |
slide-level |
Specifies that headings with the specified level create slides. Headings above this level in the hierarchy are used to divide the slide show into sections; headings below this level create subheads within a slide. Valid values are 0-6. If a slide level of 0 is specified, slides will not be split automatically on headings, and horizontal rules must be used to indicate slide boundaries. If a slide level is not specified explicitly, the slide level will be set automatically based on the contents of the document |
slide-number |
Display the page number of the current slide
Can optionally be set as a string that specifies the number formatting:
|
show-slide-number |
Contexts in which the slide number appears ( |
title-slide-attributes |
Additional attributes for the title slide of a reveal.js presentation as a map of attribute names and values. For example
(Note that the data- prefix is required here, as it isn’t added automatically.) |
title-slide-style |
The title slide style. Use |
center-title-slide |
Vertical centering of title slide |
show-notes |
Make speaker notes visible to all viewers |
rtl |
Change the presentation direction to be RTL |
Slide Content
logo |
Logo image (placed in bottom right corner of slides) |
footer |
Footer to include on all slides. Can also be set per-slide by including a div with class |
scrollable |
|
smaller |
|
output-location |
Location of output relative to the code that generated it. The possible values are as follows:
Note that this option is supported only for the |
Slide Tools
overview |
Enable the slide overview mode |
menu |
Configuration for revealjs menu. |
chalkboard |
Configuration for revealjs chalkboard. |
multiplex |
Configuration for reveal presentation multiplexing. |
Transitions
transition |
Transition style for slides backgrounds. ( |
transition-speed |
Slide transition speed ( |
background-transition |
Transition style for full page slide backgrounds. ( |
fragments |
Turns fragments on and off globally |
auto-animate |
Globally enable/disable auto-animate (enabled by default) |
auto-animate-easing |
Default CSS easing function for auto-animation. Can be overridden per-slide or per-element via attributes. |
auto-animate-duration |
Duration (in seconds) of auto-animate transition. Can be overridden per-slide or per-element via attributes. |
auto-animate-unmatched |
Auto-animate unmatched elements. Can be overridden per-slide or per-element via attributes. |
auto-animate-styles |
CSS properties that can be auto-animated (positional styles like top, left, etc. are always animated). |
Print to PDF
pdf-max-pages-per-slide |
Slides that are too tall to fit within a single page will expand onto multiple pages. You can limit how many pages a slide may expand to using this option. |
pdf-separate-fragments |
Prints each fragment on a separate slide |
pdf-page-height-offset |
Offset used to reduce the height of content within exported PDF pages. This exists to account for environment differences based on how you print to PDF. CLI printing options, like phantomjs and wkpdf, can end on precisely the total height of the document whereas in-browser printing has to end one pixel before. |
Media
preview-links |
Open links in an iframe preview overlay.
|
auto-play-media |
Autoplay embedded media ( |
preload-iframes |
Global override for preloading lazy-loaded iframes
|
view-distance |
Number of slides away from the current slide to pre-load resources for |
mobile-view-distance |
Number of slides away from the current slide to pre-load resources for (on mobile devices). |
parallax-background-image |
Parallax background image |
parallax-background-size |
Parallax background size (e.g. ‘2100px 900px’) |
parallax-background-horizontal |
Number of pixels to move the parallax background horizontally per slide. |
parallax-background-vertical |
Number of pixels to move the parallax background vertically per slide. |
Slide Layout
auto-stretch |
For slides with a single top-level image, automatically stretch it to fill the slide. |
width |
The “normal” width of the presentation, aspect ratio will be preserved when the presentation is scaled to fit different resolutions. Can be specified using percentage units. |
height |
The “normal” height of the presentation, aspect ratio will be preserved when the presentation is scaled to fit different resolutions. Can be specified using percentage units. |
margin |
For For |
min-scale |
Bounds for smallest possible scale to apply to content |
max-scale |
Bounds for largest possible scale to apply to content |
center |
Vertical centering of slides |
disable-layout |
Disables the default reveal.js slide layout (scaling and centering) |
code-block-height |
Sets the maximum height for source code blocks that appear in the presentation. |
Layout
cap-location |
Where to place figure and table captions ( |
fig-cap-location |
Where to place figure captions ( |
tbl-cap-location |
Where to place table captions ( |
classoption |
For LaTeX/PDF output, the options set for the document class. For HTML output using KaTeX, you can render display math equations flush left using |
grid |
Properties of the grid system used to layout Quarto HTML pages. |
max-width |
Adds a css |
margin-left |
For HTML output, sets the For LaTeX output, sets the left margin if For ConTeXt output, sets the left margin if For |
margin-right |
For HTML output, sets the For LaTeX output, sets the right margin if For ConTeXt output, sets the right margin if For |
margin-top |
For HTML output, sets the For LaTeX output, sets the top margin if For ConTeXt output, sets the top margin if For |
margin-bottom |
For HTML output, sets the For LaTeX output, sets the bottom margin if For ConTeXt output, sets the bottom margin if For |
Code
code-fold |
Collapse code into an HTML
|
code-summary |
Summary text to use for code blocks collapsed using |
code-overflow |
Choose how to handle code overflow, when code lines are too wide for their container. One of:
|
code-line-numbers |
Include line numbers in code block output ( For revealjs output only, you can also specify a string to highlight specific lines (and/or animate between sets of highlighted lines).
|
code-copy |
Enable a code copy icon for code blocks.
|
code-link |
Enables hyper-linking of functions within code blocks to their online documentation. Code linking is currently implemented only for the knitr engine (via the downlit package). A limitation of downlit currently prevents code linking if |
code-annotations |
The style to use when displaying code annotations. Set this value to false to hide code annotations. |
highlight-style |
Specifies the coloring style to be used in highlighted source code. Instead of a STYLE name, a JSON file with extension |
syntax-definitions |
KDE language syntax definition files (XML) |
indented-code-classes |
Specify classes to use for all indented code blocks |
Execution
Execution options should be specified within the execute
key. For example:
execute:
echo: false
warning: false
eval |
Evaluate code cells (if
|
echo |
Include cell source code in rendered output.
|
output |
Include the results of executing the code in the output. Possible values:
|
warning |
Include warnings in rendered output. |
error |
Include errors in the output (note that this implies that errors executing code will not halt processing of the document). |
include |
Catch all for preventing any output (code or results) from being included in output. |
cache |
Cache results of computations (using the knitr cache for R documents, and Jupyter Cache for Jupyter documents). Note that cache invalidation is triggered by changes in chunk source code (or other cache attributes you’ve defined).
|
freeze |
Control the re-use of previous computational output when rendering.
|
Figures
fig-align |
Figure horizontal alignment ( |
fig-cap-location |
Where to place figure captions ( |
fig-width |
Default width for figures generated by Matplotlib or R graphics. Note that with the Jupyter engine, this option has no effect when provided at the cell level; it can only be provided with document or project metadata. |
fig-height |
Default height for figures generated by Matplotlib or R graphics. Note that with the Jupyter engine, this option has no effect when provided at the cell level; it can only be provided with document or project metadata. |
fig-format |
Default format for figures generated by Matplotlib or R graphics ( |
fig-dpi |
Default DPI for figures generated by Matplotlib or R graphics. Note that with the Jupyter engine, this option has no effect when provided at the cell level; it can only be provided with document or project metadata. |
fig-asp |
The aspect ratio of the plot, i.e., the ratio of height/width. When The |
fig-responsive |
Whether to make images in this document responsive. |
Tables
tbl-colwidths |
Apply explicit table column widths for markdown grid tables and pipe tables that are more than Some formats (e.g. HTML) do an excellent job automatically sizing table columns and so don’t benefit much from column width specifications. Other formats (e.g. LaTeX) require table column sizes in order to correctly flow longer cell content (this is a major reason why tables > 72 columns wide are assigned explicit widths by Pandoc). This can be specified as:
|
tbl-cap-location |
Where to place table captions ( |
df-print |
Method used to print tables in Knitr engine documents:
The default printing method is |
Links
link-external-icon |
Show a special icon next to links that leave the current site. |
link-external-newwindow |
Open external links in a new browser window or tab (rather than navigating the current tab). |
link-external-filter |
A regular expression that can be used to determine whether a link is an internal link. For example, the following will treat links that start with http://www.quarto.org as internal links (and others will be considered external):
|
References
bibliography |
Document bibliography (BibTeX or CSL). May be a single file or a list of files |
csl |
Citation Style Language file to use for formatting references. |
citations-hover |
Enables a hover popup for citation that shows the reference information. |
citeproc |
Turn on built-in citation processing. To use this feature, you will need to have a document containing citations and a source of bibliographic data: either an external bibliography file or a list of |
citation-abbreviations |
JSON file containing abbreviations of journals that should be used in formatted bibliographies when
|
Footnotes
footnotes-hover |
Enables a hover popup for footnotes that shows the footnote contents. |
reference-location |
Specify location for footnotes. Also controls the location of references, if
|
Crossrefs
crossref |
Configuration for crossref labels and prefixes. |
crossrefs-hover |
Enables a hover popup for cross references that shows the item being referenced. |
Citation
citation |
Citation information for the document itself specified as CSL YAML in the document front matter. For more on supported options, see Citation Metadata. |
Language
lang |
Identifies the main language of the document using IETF language tags (following the BCP 47 standard), such as This affects most formats, and controls hyphenation in PDF output when using LaTeX (through |
language |
YAML file containing custom language translations |
dir |
The base script direction for the document ( For bidirectional documents, native pandoc When using LaTeX for bidirectional documents, only the |
Includes
include-before-body |
Include contents at the beginning of the document body (e.g. after the A string value or an object with key “file” indicates a filename whose contents are to be included An object with key “text” indicates textual content to be included |
include-after-body |
Include content at the end of the document body immediately after the markdown content. While it will be included before the closing A string value or an object with key “file” indicates a filename whose contents are to be included An object with key “text” indicates textual content to be included |
include-in-header |
Include contents at the end of the header. This can be used, for example, to include special CSS or JavaScript in HTML documents. A string value or an object with key “file” indicates a filename whose contents are to be included An object with key “text” indicates textual content to be included |
resources |
Path (or glob) to files to publish with this document. |
metadata-files |
Read metadata from the supplied YAML (or JSON) files. This option can be used with every input format, but string scalars in the YAML file will always be parsed as Markdown. Generally, the input will be handled the same as in YAML metadata blocks. Values in files specified later in the list will be preferred over those specified earlier. Metadata values specified inside the document, or by using |
Metadata
keywords |
List of keywords to be included in the document metadata. |
pagetitle |
Sets the title metadata for the document |
title-prefix |
Specify STRING as a prefix at the beginning of the title that appears in the HTML header (but not in the title as it appears at the beginning of the body) |
description-meta |
Sets the description metadata for the document |
author-meta |
Sets the author metadata for the document |
date-meta |
Sets the date metadata for the document |
Rendering
from |
Format to read from. Extensions can be individually enabled or disabled by appending +EXTENSION or -EXTENSION to the format name (e.g. markdown+emoji). |
output-file |
Output file to write to |
output-ext |
Extension to use for generated output file |
template |
Use the specified file as a custom template for the generated document. |
template-partials |
Include the specified files as partials accessible to the template for the generated content. |
standalone |
Produce output with an appropriate header and footer (e.g. a standalone HTML, LaTeX, TEI, or RTF file, not a fragment) |
embed-resources |
Produce a standalone HTML file with no external dependencies, using |
self-contained-math |
Embed math libraries (e.g. MathJax) within |
filters |
Specify executables or Lua scripts to be used as a filter transforming the pandoc AST after the input is parsed and before the output is written. |
shortcodes |
Specify Lua scripts that implement shortcode handlers |
keep-md |
Keep the markdown file generated by executing code |
keep-ipynb |
Keep the notebook file generated from executing code. |
ipynb-filters |
Filters to pre-process ipynb files before rendering to markdown |
ipynb-shell-interactivity |
Specify which nodes should be run interactively (displaying output from expressions) |
plotly-connected |
If true, use the “notebook_connected” plotly renderer, which downloads its dependencies from a CDN and requires an internet connection to view. |
extract-media |
Extract images and other media contained in or linked from the source document to the path DIR, creating it if necessary, and adjust the images references in the document so they point to the extracted files. Media are downloaded, read from the file system, or extracted from a binary container (e.g. docx), as needed. The original file paths are used if they are relative paths not containing … Otherwise filenames are constructed from the SHA1 hash of the contents. |
resource-path |
List of paths to search for images and other resources. |
default-image-extension |
Specify a default extension to use when image paths/URLs have no extension. This allows you to use the same source for formats that require different kinds of images. Currently this option only affects the Markdown and LaTeX readers. |
abbreviations |
Specifies a custom abbreviations file, with abbreviations one to a line. This list is used when reading Markdown input: strings found in this list will be followed by a nonbreaking space, and the period will not produce sentence-ending space in formats like LaTeX. The strings may not contain spaces. |
dpi |
Specify the default dpi (dots per inch) value for conversion from pixels to inch/ centimeters and vice versa. (Technically, the correct term would be ppi: pixels per inch.) The default is |
html-table-processing |
If |
Text Output
strip-comments |
Strip out HTML comments in the Markdown source, rather than passing them on to Markdown, Textile or HTML output as raw HTML. This does not apply to HTML comments inside raw HTML blocks when the |
ascii |
Use only ASCII characters in output. Currently supported for XML and HTML formats (which use entities instead of UTF-8 when this option is selected), CommonMark, gfm, and Markdown (which use entities), roff ms (which use hexadecimal escapes), and to a limited degree LaTeX (which uses standard commands for accented characters when possible). roff man output uses ASCII by default. |
Library
revealjs-url |
Directory containing reveal.js files. |