md_fence: Markdown fenced code block

In gluedown: Wrap Vectors in Markdown Formatting

Markdown fenced code block

Description

Turn a character vector of lines into a single code block with lines bookended with a code fence of backticks or tildes. This markdown leaf block can be rendered as HTML ⁠<code>⁠ tags inside ⁠<pre>⁠ tags.

Usage

md_fence(x, char = c("`", "~"), info = "r")

Arguments

x	A character vector of lines to be wrapped concatenated into a single block, possibly created by possibly created by readLines() or deparse().
char	The character to use in the code fence; either backtick characters... or tildes (~). Defaults to backticks.
info	The info string text to follow the initial code fence, typically a code for the language of the lines of x. Defaults to r.

Details

A code fence is a sequence of at least three consecutive backtick characters ... or tildes (~). (Tildes and backticks cannot be mixed.) A fenced code block begins with a code fence, indented no more than three spaces.

The line with the opening code fence may optionally contain some text following the code fence; this is trimmed of leading and trailing whitespace and called the info string...

The content of the code block consists of all subsequent lines, until a closing code fence of the same type as the code block began with (backticks or tildes), and with at least as many backticks or tildes as the opening code fence...

A fenced code block may interrupt a paragraph, and does not require a blank line either before or after.

The content of a code fence is treated as literal text, not parsed as inlines. The first word of the info string is typically used to specify the language of the code sample, and rendered in the class attribute of the code tag. However, this spec does not mandate any particular treatment of the info string (see the info argument).

Value

A character vector wrapped on either side by code fences.

See Also

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

Examples

md_fence(deparse(sd))
md_fence(c("library(dplyr)", "starwars %>%", "  filter(species == 'Droid')"))

gluedown documentation built on May 29, 2024, 11:42 a.m.