highlight_string: Highlight a character vector

Description Usage Arguments

View source: R/package.R

Description

This function uses Andre Simon's highlight package to highlight code in \Sexpr[stage=render]{length(highlite:::choices(highlite:::package_file("langDefs")))} programming languages, markup languages and configuration files. Available output formats include ‘HTML’, ‘ANSI escape codes’, ‘TeX’, ‘LaTeX’ and ‘SVG’.

Usage

1
2
3
highlight_string(code, language = "r", output = "ESC_ANSI",
  theme = "solarized-light", theme_path = package_file("themes"),
  language_path = package_file("langDefs"))

Arguments

code

[character()]
The code to highlight. Multiple lines will be joined by newlines.

language

[character(1)] default: ‘r’
The language, one of \Sexpr[stage=render, results=rd]{highlite:::choices_rd(highlite:::choices(highlite:::package_file("langDefs")))} with the default language_path.

output

[character(1)] default: ‘ESC_ANSI’
The output type, one of \Sexpr[stage=render, results=rd]{highlite:::choices_rd(names(highlite:::output_types()))}.

theme

[character(1)] default: ‘solarized-light’
The theme, one of \Sexpr[stage=render, results=rd]{highlite:::choices_rd(highlite:::choices(highlite:::package_file("themes")))} with the default theme_path.

theme_path

[character(1)]
The directory containing highlight themes.

language_path

[character(1)]
The directory containing highlight language definitions.


jimhester/highlite documentation built on May 19, 2019, 10:32 a.m.