Skip to contents

Backslash escape all punctuation

Source: R/md-escape.R
md_escape.Rd

Take a character vector containing punctuation and return a glue vector with every punctuation mark prepended with double escape backslashes.

Usage

md_escape(x)

Arguments

x

A character vector of strings containing punctuation that might accidentally be considered markdown syntax.

Value

A character string with all [:punct:] properly escaped with prepended backslashes.

Details

When trying to format text containing markdown syntax characters, it's necessary to "escape" those characters so that they are ignored by formatting.

Any ASCII punctuation character may be backslash-escaped... Escaped characters are treated as regular characters and do not have their usual Markdown meanings.

See also

Other inline functions: md_autolink(), md_bold(), md_code(), md_convert(), md_disallow(), md_hardline(), md_image(), md_issue(), md_italic(), md_link(), md_softline(), md_strike(), md_text()

Examples

md_escape("# six seasons and a movie")
#> \# six seasons and a movie