R: Specify Table of Contents options

yml_toc {ymlthis}

R Documentation

Specify Table of Contents options

Description

It's generally better to specify Table of Contents in the output function you are using so you have a clearer idea of your options (e.g. html_document(toc = TRUE, toc_float = TRUE)). However, you can also generally specify at the top level of YAML.

Usage

yml_toc(
  .yml,
  toc = yml_blank(),
  toc_depth = yml_blank(),
  toc_title = yml_blank(),
  ...
)

Arguments

`.yml`	a `yml` object created by `yml()`, `as_yml()`, or returned by a `⁠yml_*()⁠` function
`toc`	Logical. Use a Table of Contents?
`toc_depth`	An integer. The depth of headers to use in the TOC. Note that the actual YAML field is `toc-depth`.
`toc_title`	The title of the TOC. Note that the actual YAML field is `toc-title`.
`...`	additional named R objects, such as characters or lists, to transform into YAML

Value

a yml object

Other yml: asis_yaml_output(), bib2yml(), draw_yml_tree(), has_field(), read_json(), use_yml_defaults(), use_yml_file(), use_yml(), yml_author(), yml_blogdown_opts(), yml_bookdown_opts(), yml_citations(), yml_clean(), yml_distill_opts(), yml_latex_opts(), yml_output(), yml_pagedown_opts(), yml_params(), yml_pkgdown(), yml_reference(), yml_replace(), yml_resource_files(), yml_rsconnect_email(), yml_rticles_opts(), yml_runtime(), yml_site_opts(), yml_vignette()

Examples


yml() %>%
 yml_toc(toc = TRUE, toc_depth = 1, toc_title = "Article Outline")