gluedown (version 1.0.2)

md_chunk: Markdown code block

Description

Take a character vector of lines and return a glue vector

Usage

md_chunk(x, type = c("tick", "tilde", "indent"), ...)

Arguments

x

A character vector of lines to be wrapped concatenated into a single block, possibly created by readLines() or deparse().

type

The type of code block to be created. Either "tick", "tilde" (which call md_fence()) or "indent" (which calls md_indent()).

...

Arguments to be passed to md_fence() or md_indent().

Value

A glue object of length 1, with elements of x formatted via md_fence() or md_indent().

Details

Turn a character vector of lines into a single code block either indented or fenced in tildes or backticks. This markdown leaf block can be rendered as nested HTML <code> and <pre> tags. This function either calls md_fence() or md_indent() based on the type argument.

See Also

Other leaf block functions: md_blank(), md_fence(), md_heading(), md_indent(), md_paragraph(), md_reference(), md_rule(), md_setext(), md_table()

Examples

# NOT RUN {
md_chunk("$ sudo apt install r-base-dev", info = "bash")
md_chunk(c("library(ggplot2)", "ggplot(mpg)+", "geom_point(aes(displ, hwy))"), type = "tilde")
md_indent(
  n = c(4, 4, 6),
  x = c(
    "library(dplyr)",
    "starwars %>%",
    "filter(species == 'Droid')"
  )
)
# }