html_uswds_vignette: HTML Vignette Output Based on the US Web Design Standards

Description Usage Arguments Value Author(s) Examples

View source: R/html_uswds_vignette.R

Description

This function is a variation of html_uswds formats to create HTML vignette from R Markdown. It is intended to generate single HTML pages that are based on the US Web Design Standards and focussed on package vignettes. Attempts have been made to reduce file size while maintaining the style design principles outlined in the web design standards.

Usage

1
2
html_uswds_vignette(highlight = NULL, css = NULL, keep_md = FALSE,
  ...)

Arguments

css

Additional CSS file to be merged in the document. It will NOT overwrite the CSS from the themes.

...

Additional arguments passed to html_document.

Value

R Markdown output format to pass to render.

Author(s)

Josh M London

Examples

1
2
3
4
5
6
## Not run: 
doc = system.file("rmarkdown", "templates", "usweb",
                  "skeleton", "skeleton.Rmd", package = "uswebr")
rmarkdown::render(doc, html_uswds_vignette(), output_dir = tempdir())

## End(Not run)

jmlondon/uswebr documentation built on May 19, 2019, 1:54 p.m.