insert_yaml: Insert the required code for the specified toc type.

In accessrmd: Improving the Accessibility of 'rmarkdown' Documents

Insert the required code for the specified toc type.

Description

Inserts YAML header for floating toc if toc is TRUE.

Usage

insert_yaml(toc, header, text, lan, theme = "default", highlight = "null")

Arguments

toc	TOC status, FALSE (the default) or TRUE.
header	Metadata items wrapped with 'tags$header()'.
text	Raw text required for Rmarkdown body.
lan	lang attribute value.
theme	Text styling to apply. Current valid value is "default" only. All other themes present accessibility errors on testing.
highlight	Currently only "null" is a valid, due to accessibility errors found in all built-in highlight options.

Value

An assembled html output page containing the required toc code.

accessrmd documentation built on May 3, 2022, 5:07 p.m.