moon_reader | R Documentation |
This output format produces an HTML file that contains the Markdown source
(knitted from R Markdown) and JavaScript code to render slides. tsukuyomi()
is an alias of moon_reader()
.
moon_reader(
css = c("default", "default-fonts"),
self_contained = FALSE,
seal = TRUE,
yolo = FALSE,
chakra = "https://remarkjs.com/downloads/remark-latest.min.js",
nature = list(),
anchor_sections = FALSE,
...
)
tsukuyomi(...)
css |
A vector of CSS file paths. Two default CSS files
(‘default.css’ and ‘default-fonts.css’) are provided in this
package, which was borrowed from https://remarkjs.com. If the character
vector |
self_contained |
Whether to produce a self-contained HTML file by embedding all external resources into the HTML file. See the ‘Note’ section below. |
seal |
Whether to generate a title slide automatically using the YAML
metadata of the R Markdown document (if |
yolo |
Whether to insert the Mustache Karl (TM)
randomly in the slides. |
chakra |
A path to the remark.js library (can be either local or
remote). Please note that if you use the default remote latest version of
remark.js, your slides will not work when you do not have Internet access.
They might also be broken after a newer version of remark.js is released.
If these issues concern you, you should download remark.js locally (e.g.,
via |
nature |
(Nature transformation) A list of configurations to be passed
to |
anchor_sections , ... |
For |
Tsukuyomi is a genjutsu to trap the target in an illusion on eye contact.
If you are unfamiliar with CSS, please see the xaringan wiki on Github providing CSS slide modification examples.
Do not stare at Karl's picture for too long after you turn on the
yolo
mode. I believe he has Sharingan.
For the option self_contained = TRUE
, it encodes images as base64 data in
the HTML output file. The image path should not contain the string ")"
when the image is written with the syntax 
or background-image: url(PATH)
, and should not contain the string "/>"
when it is written
with the syntax <img src="PATH" />
. Rendering slides in the
self-contained mode can be time-consuming when you have remote resources
(such as images or JS libraries) in your slides because these resources
need to be downloaded first. We strongly recommend that you download
remark.js (via summon_remark()
) and use a local copy instead of the
default chakra
argument when self_contained = TRUE
, so remark.js does
not need to be downloaded each time you compile your slides.
When the slides are previewed via inf_mr()
, self_contained
will be temporarily changed to FALSE
even if the author of the slides set
it to TRUE
. This will make it faster to preview slides locally (by
avoiding downloading remote resources explicitly and base64 encoding them).
You can always click the Knit button in RStudio or call
rmarkdown::render()
to render the slides in the self-contained mode
(these approaches will respect the self_contained
setting).
Each page has its own countdown timer (when the option countdown
is set
in nature
), and the timer is (re)initialized whenever you navigate to a
new page. If you need a global timer, you can use the presenter's mode
(press P).
https://naruto.fandom.com/wiki/Tsukuyomi
# rmarkdown::render('foo.Rmd', 'xaringan::moon_reader')
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.