garrick
/
bulma


			
							<!-- Generated by pkgdown: do not edit by hand -->
<!DOCTYPE html>
<html>
  <head>
  <meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>Bulma Document Renderer — bulma_document • bulma</title>

<!-- jquery -->
<script src="https://code.jquery.com/jquery-3.1.0.min.js" integrity="sha384-nrOSfDHtoPMzJHjVTdCopGqIqeYETSXhZDFyniQ8ZHcVy08QesyHcnOUpMpqnmWq" crossorigin="anonymous"></script>
<!-- Bootstrap -->

<link href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>

<!-- Font Awesome icons -->
<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.6.3/css/font-awesome.min.css" rel="stylesheet" integrity="sha384-T8Gy5hrqNKT+hzMclPo118YTQO6cYprQmhrYwIiQ/3axmI1hQomh7Ud2hPOy8SP1" crossorigin="anonymous">

<!-- clipboard.js -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/1.7.1/clipboard.min.js" integrity="sha384-cV+rhyOuRHc9Ub/91rihWcGmMmCXDeksTtCihMupQHSsi8GIIRDG0ThDc3HGQFJ3" crossorigin="anonymous"></script>

<!-- sticky kit -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/sticky-kit/1.1.3/sticky-kit.min.js" integrity="sha256-c4Rlo1ZozqTPE2RLuvbusY3+SU1pQaJC0TjuhygMipw=" crossorigin="anonymous"></script>

<!-- pkgdown -->
<link href="../pkgdown.css" rel="stylesheet">
<script src="../pkgdown.js"></script>


<meta property="og:title" content="Bulma Document Renderer — bulma_document" />

<meta property="og:description" content="Bulma Document Renderer" />
<meta name="twitter:card" content="summary" />


<!-- mathjax -->
<script src='https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script>

<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->


  </head>

  <body>
    <div class="container template-reference-topic">
      <header>
      <div class="navbar navbar-default navbar-fixed-top" role="navigation">
  <div class="container">
    <div class="navbar-header">
      <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar">
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
      </button>
      <span class="navbar-brand">
        <a class="navbar-link" href="../index.html">bulma</a>
        <span class="label label-default" data-toggle="tooltip" data-placement="bottom" title="Released package">0.0.0.9000</span>
      </span>
    </div>

    <div id="navbar" class="navbar-collapse collapse">
      <ul class="nav navbar-nav">
        <li>
  <a href="../index.html">
    <span class="fa fa-home fa-lg"></span>
     
  </a>
</li>
<li>
  <a href="../reference/index.html">Reference</a>
</li>
      </ul>
      
      <ul class="nav navbar-nav navbar-right">
        
      </ul>
      
    </div><!--/.nav-collapse -->
  </div><!--/.container -->
</div><!--/.navbar -->

      
      </header>

<div class="row">
  <div class="col-md-9 contents">
    <div class="page-header">
    <h1>Bulma Document Renderer</h1>
    
    <div class="hidden name"><code>bulma_document.Rd</code></div>
    </div>

    <div class="ref-description">
    
    <p>Bulma Document Renderer</p>
    
    </div>

    <pre class="usage"><span class='fu'>bulma_document</span>(<span class='no'>...</span>, <span class='kw'>css</span> <span class='kw'>=</span> <span class='kw'>NULL</span>, <span class='kw'>fig_width</span> <span class='kw'>=</span> <span class='fl'>10</span>, <span class='kw'>fig_height</span> <span class='kw'>=</span> <span class='fl'>7</span>,
  <span class='kw'>fig_retina</span> <span class='kw'>=</span> <span class='fl'>2</span>, <span class='kw'>keep_md</span> <span class='kw'>=</span> <span class='fl'>FALSE</span>, <span class='kw'>dev</span> <span class='kw'>=</span> <span class='st'>"png"</span>, <span class='kw'>pandoc_args</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
  <span class='kw'>extra_dependencies</span> <span class='kw'>=</span> <span class='kw'>NULL</span>)</pre>
    
    <h2 class="hasAnchor" id="arguments"><a class="anchor" href="#arguments"></a>Arguments</h2>
    <table class="ref-arguments">
    <colgroup><col class="name" /><col class="desc" /></colgroup>
    <tr>
      <th>...</th>
      <td><p>Arguments passed on to <code><a href='http://www.rdocumentation.org/packages/rmarkdown/topics/html_document_base'>rmarkdown::html_document_base</a></code></p><dl class='dl-horizontal'>
  <dt>smart</dt><dd><p>Produce typographically correct output, converting straight
quotes to curly quotes, --- to em-dashes, -- to en-dashes, and ... to
ellipses.</p></dd>
  <dt>theme</dt><dd><p>Visual theme ("default", "cerulean", "journal", "flatly",
"readable", "spacelab", "united", "cosmo", "lumen", "paper", "sandstone",
"simplex", or "yeti"). Pass <code>NULL</code> for no theme (in this case you can
use the <code>css</code> parameter to add your own styles).</p></dd>
  <dt>self_contained</dt><dd><p>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).</p></dd>
  <dt>lib_dir</dt><dd><p>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</code> appended to it.</p></dd>
  <dt>mathjax</dt><dd><p>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</code> to exclude MathJax entirely.</p></dd>
  <dt>pandoc_args</dt><dd><p>Additional command line options to pass to pandoc</p></dd>
  <dt>template</dt><dd><p>Pandoc template to use for rendering. Pass "default" to use
the rmarkdown package default template; pass <code>NULL</code> 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</code> won't be available (see the Templates section below for
more details).</p></dd>
  <dt>dependency_resolver</dt><dd><p>A dependency resolver</p></dd>
  <dt>copy_resources</dt><dd><p>Copy resources</p></dd>
  <dt>extra_dependencies</dt><dd><p>Extra dependencies</p></dd>
  <dt>bootstrap_compatible</dt><dd><p>Bootstrap compatible</p></dd>
</dl></td>
    </tr>
    </table>
    
    <h2 class="hasAnchor" id="yaml-options"><a class="anchor" href="#yaml-options"></a>YAML options</h2>

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

  </div>
  <div class="col-md-3 hidden-xs hidden-sm" id="sidebar">
    <h2>Contents</h2>
    <ul class="nav nav-pills nav-stacked">
      <li><a href="#arguments">Arguments</a></li>
      
      <li><a href="#yaml-options">YAML options</a></li>
          </ul>

  </div>
</div>

      <footer>
      <div class="copyright">
  <p>Developed by Garrick Aden-Buie.</p>
</div>

<div class="pkgdown">
  <p>Site built with <a href="http://pkgdown.r-lib.org/">pkgdown</a>.</p>
</div>

      </footer>
   </div>

  
  </body>
</html>