bulma/man/bulma_document.Rd

% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/bulma_document.R
\name{bulma_document}
\alias{bulma_document}
\title{Bulma Document Renderer}
\usage{
bulma_document(
  ...,
  css = NULL,
  fig_width = 10,
  fig_height = 7,
  fig_retina = 2,
  keep_md = FALSE,
  dev = "png",
  toc = FALSE,
  toc_depth = 3,
  mathjax = "default",
  pandoc_args = NULL,
  extra_dependencies = NULL,
  self_contained = TRUE
)
}
\arguments{
\item{...}{
  Arguments passed on to \code{\link[rmarkdown:html_document_base]{rmarkdown::html_document_base}}
  \describe{
    \item{\code{smart}}{Produce typographically correct output, converting straight
quotes to curly quotes, \code{---} to em-dashes, \code{--} to en-dashes, and
\code{...} to ellipses.}
    \item{\code{theme}}{Visual theme ("default", "cerulean", "cosmo", "cyborg", "darkly",
"flatly", "journal", "lumen", "readable", "sandstone", "simplex", "slate",
"spacelab", "superhero", "united", or "yeti"). Pass \code{NULL} for no
theme (in this case you can use the \code{css} parameter to add your own styles).
If Bootstrap 4+ is used (see \code{bootstrap_version} argument),
a handful of other themes are available ("lux", "minty", "pulse",
"sketchy", and "solar"). Moreover, with Bootstrap 4+, custom
\href{https://getbootstrap.com/docs/4.0/getting-started/theming/}{Bootstrap
themes} are supported via the \code{bs_theme_add_variables()} and
\code{bs_theme_add()} functions from the bootstraplib package
(use these functions from within the document).}
    \item{\code{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
\code{_files} appended to it.}
    \item{\code{template}}{Pandoc template to use for rendering. Pass "default" to use
the rmarkdown package default template; pass \code{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
\code{html_document} won't be available (see the Templates section below for
more details).}
    \item{\code{dependency_resolver}}{A dependency resolver}
    \item{\code{copy_resources}}{Copy resources}
    \item{\code{bootstrap_compatible}}{Bootstrap compatible}
    \item{\code{bootstrap_version}}{version of Bootstrap to use (relevant if \code{theme}
is not \code{NULL}). Currently three options are supported: Bootstrap version
3.x (\code{3}), Bootstrap version 4.x (\code{4}), and Bootstrap version 4.x
with additional JS/CSS to support BS3 style nav, navbar, and other component
styling (\code{"4+3"}). Use this version if you want to upgrade to Bootstrap 4
while maintaining the functionality of a document already written with
Bootstrap 3 in mind.}
  }}

\item{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
\code{NULL} to exclude MathJax entirely.}

\item{pandoc_args}{Additional command line options to pass to pandoc}

\item{extra_dependencies}{Extra dependencies}

\item{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).}
}
\description{
Bulma Document Renderer
}
\section{YAML options}{

You can pass additional options to the underlying template via the \code{bulma}
YAML item. The following options can be specified there.
\itemize{
\item{\code{hero}: Classes applied to the hero containing the title.}
\item{\code{hero_body}: Classes applied to the hero body container.}
\item{\code{hero_button}: Classes applied to the \code{header_links} buttons}
\item{\code{hero_links}: Links that will be displayed under title as buttons.
Formatted as a list, each element having entries for \code{name}, \code{url},
and \code{icon}. Icons use \href{https://fontawesome.com/icons}{Font Awesome};
see \code{\link[=fa_icon]{fa_icon()}} for help constructing the Font Awesome class. The
full Font Awesome class name is required.}
}\preformatted{---
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"
---
}
}