Print a heading — heading • rock

This is just a convenience function to print a markdown or HTML heading at a given 'depth'.

Usage

heading(
  ...,
  headingLevel = rock::opts$get("defaultHeadingLevel"),
  output = "markdown",
  cat = TRUE
)

Arguments

...: The heading text: pasted together with no separator.
headingLevel: The level of the heading; the default can be set with e.g. rock::opts$set(defaultHeadingLevel=1).
output: Whether to output to HTML ("html") or markdown (anything else).
cat: Whether to cat (print) the heading or just invisibly return it.

Value

The heading, invisibly.

Examples

heading("Hello ", "World", headingLevel=5);
#> 
#> 
#> ##### Hello World
#> 
### This produces: "\n\n##### Hello World\n\n"