bulma: Bulma CSS framework basic template

Description Usage Arguments Details YAML Frontmatter Examples

View source: R/bulma.r

Description

Template for creating an R markdown document using the Bulma CSS framework style

Usage

1
2
3
4
5
6
bulma(number_sections = FALSE, fig_width = 7, fig_height = 5,
  fig_retina = if (!fig_caption) 2, fig_caption = FALSE, dev = "png",
  toc = FALSE, toc_depth = 3, smart = TRUE, self_contained = TRUE,
  highlight = "default", mathjax = "default", extra_dependencies = NULL,
  css = NULL, includes = NULL, keep_md = FALSE, lib_dir = NULL,
  md_extensions = NULL, pandoc_args = NULL, ...)

Arguments

number_sections

TRUE to number section headings

fig_width

Default width (in inches) for figures

fig_height

Default width (in inches) for figures

fig_retina

Scaling to perform for retina displays (defaults to 2, which currently works for all widely used retina displays). Set to NULL to prevent retina scaling. Note that this will always be NULL when keep_md is specified (this is because fig_retina relies on outputting HTML directly into the markdown document).

fig_caption

TRUE to render figures with captions

dev

Graphics device to use for figure output (defaults to png)

toc

TRUE to include a table of contents in the output

toc_depth

Depth of headers to include in table of contents

smart

Produce typographically correct output, converting straight quotes to curly quotes, — to em-dashes, – to en-dashes, and ... to ellipses.

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 it's size).

highlight

Syntax highlighting style. Supported styles include "default", "tango", "pygments", "kate", "monochrome", "espresso", "zenburn", "haddock", and "textmate". Pass NULL to prevent syntax highlighting.

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.

extra_dependencies, ...

Additional function arguments to pass to the base R Markdown HTML output formatter

css

One or more css files to include

includes

Named list of additional content to include within the document (typically created using the includes function).

keep_md

Keep the markdown file generated by knitting.

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.

md_extensions

Markdown extensions to be added or removed from the default definition or R Markdown. See the rmarkdown_format for additional details.

pandoc_args

Additional command line options to pass to pandoc

Details

Based on the Bulma CSS framework.

Figure: bulma example

YAML Frontmatter

The following example shows all possible YAML frontmatter options:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
---
title: "INSERT_TITLE_HERE"
author: "AUTHOR"
navlink: "[NAVTITLE](http://NAVLINK/)"
og:
  type: "article"
  title: "opengraph title"
  url: "optional opengraph url"
  image: "optional opengraph image link"
footer:
  - content: '[link1](http://example.com/) • [link2](http://example.com/)<br/>'
  - content: 'Copyright blah blah'
date: "`r Sys.Date()`"
output: markdowntemplates::bulma
---

Examples

1
2
3
4
## Not run: 
rmarkdown::render("source.Rmd", clean=TRUE, quiet=TRUE, output_file="output.html")

## End(Not run)

hrbrmstr/markdowntemplates documentation built on June 3, 2018, 12:10 p.m.