Bulma Document Renderer

bulma_document(..., css = NULL, fig_width = 10, fig_height = 7,
  fig_retina = 2, keep_md = FALSE, dev = "png", pandoc_args = NULL,
  extra_dependencies = NULL)

Arguments

...

...	Arguments passed on to `rmarkdown::html_document_base` smart Produce typographically correct output, converting straight quotes to curly quotes, --- to em-dashes, -- to en-dashes, and ... to ellipses. theme Visual theme ("default", "cerulean", "journal", "flatly", "readable", "spacelab", "united", "cosmo", "lumen", "paper", "sandstone", "simplex", or "yeti"). Pass `NULL` for no theme (in this case you can use the `css` parameter to add your own styles). self_contained Produce a standalone HTML file with no external dependencies, using data: URIs to incorporate the contents of linked scripts, stylesheets, images, and videos. Note that even for self contained documents MathJax is still loaded externally (this is necessary because of its size). lib_dir Directory to copy dependent HTML libraries (e.g. jquery, bootstrap, etc.) into. By default this will be the name of the document with `_files` appended to it. mathjax Include mathjax. The "default" option uses an https URL from a MathJax CDN. The "local" option uses a local version of MathJax (which is copied into the output directory). You can pass an alternate URL or pass `NULL` to exclude MathJax entirely. pandoc_args Additional command line options to pass to pandoc template Pandoc template to use for rendering. Pass "default" to use the rmarkdown package default template; pass `NULL` to use pandoc's built-in template; pass a path to use a custom template that you've created. Note that if you don't use the "default" template then some features of `html_document` won't be available (see the Templates section below for more details). dependency_resolver A dependency resolver copy_resources Copy resources extra_dependencies Extra dependencies bootstrap_compatible Bootstrap compatible

Arguments passed on to rmarkdown::html_document_base

smart: Produce typographically correct output, converting straight quotes to curly quotes, --- to em-dashes, -- to en-dashes, and ... to ellipses.
theme: Visual theme ("default", "cerulean", "journal", "flatly", "readable", "spacelab", "united", "cosmo", "lumen", "paper", "sandstone", "simplex", or "yeti"). Pass NULL for no theme (in this case you can use the css parameter to add your own styles).
self_contained: Produce a standalone HTML file with no external dependencies, using data: URIs to incorporate the contents of linked scripts, stylesheets, images, and videos. Note that even for self contained documents MathJax is still loaded externally (this is necessary because of its size).
lib_dir: Directory to copy dependent HTML libraries (e.g. jquery, bootstrap, etc.) into. By default this will be the name of the document with _files appended to it.
mathjax: Include mathjax. The "default" option uses an https URL from a MathJax CDN. The "local" option uses a local version of MathJax (which is copied into the output directory). You can pass an alternate URL or pass NULL to exclude MathJax entirely.
pandoc_args: Additional command line options to pass to pandoc
template: Pandoc template to use for rendering. Pass "default" to use the rmarkdown package default template; pass NULL to use pandoc's built-in template; pass a path to use a custom template that you've created. Note that if you don't use the "default" template then some features of html_document won't be available (see the Templates section below for more details).
dependency_resolver: A dependency resolver
copy_resources: Copy resources
extra_dependencies: Extra dependencies
bootstrap_compatible: Bootstrap compatible

YAML options

You can pass additional options to the underlying template via the bulma YAML item. The following options can be specified there.

hero: Classes applied to the hero containing the title
hero_button: Classes applied to the header_links buttons
hero_links: Links that will be displayed under title as buttons. Formatted as a list, each element having entries for name, url, and icon. Icons use Font Awesome; see fa_icon() for help constructing the Font Awesome class. The full Font Awesome class name is required.

---
bulma:
  hero: ["info"]
  hero_button: ["is-secondary", "is-outlined"]
  hero_links:
    - name: Github
      url: https://github.com/
      icon: '`r bulma::fa_icon("github")`'
    - name: Twitter
      url: https://twitter.com
      icon: "fab fa-twitter"
---

Bulma Document Renderer

Arguments

YAML options

Contents