zousan_document: Convert to a html document for zousan.

Description Usage Arguments

Description

html document including some tools.

Usage

1
2
3
4
5
6
zousan_document(fig_width = 7, fig_height = 5, fig_retina = 2,
  fig_caption = TRUE, self_contained = FALSE, dev = "png",
  keep_md = FALSE, mathjax = "default",
  md_extensions = "-ascii_identifiers", template = "default",
  katex = FALSE, lightbox = TRUE, showhide = TRUE, bs_panel = TRUE,
  bs_label = TRUE, bs_badge = TRUE, list_addclass = TRUE, ...)

Arguments

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

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).

dev

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

keep_md

Keep the markdown file generated by knitting.

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.

md_extensions

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

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).

katex

Logical. If TRUE, then use katex instead of mathjax.

lightbox

Logical. If TRUE, then set lightbox automatically.

showhide

Logical. If TRUE, you could set show/hide button.

bs_panel

Logical. If TRUE, you could use Bootstrap panel.

bs_label

Logical. If TRUE, you could use Bootstrap label.

bs_badge

Logical. If TRUE, you could use Bootstrap badge.

list_addclass

Logical. If TRUE, you could add selector class to ul/ol list.

...

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


kazutan/zousan documentation built on May 20, 2019, 7:54 a.m.