Learn R Programming
tinytable (version 0.18.0)

theme_markdown: Markdown theme with optional ANSI color support and grid customization

Description

Markdown theme with optional ANSI color support and grid customization

Usage

theme_markdown(
  x,
  ansi = NULL,
  style = NULL,
  vline = NULL,
  hline = NULL,
  hline_header = NULL,
  ...
)

Value

A modified tinytable object.

Arguments

x

A tinytable object.

ansi

Logical. If TRUE, enables ANSI color codes for grid styling; if FALSE, disables them. Default is NULL (no change; ANSI is disabled unless previously enabled).

style

Character. Markdown style format. Can be "grid" or "gfm". Default is NULL.

vline

Logical. Enable/disable vertical lines. Default is TRUE.

hline

Logical. Enable/disable horizontal lines. Default is TRUE.

hline_header

Logical. Enable/disable the special header separator line below column names. Default is TRUE.

...

Additional arguments (ignored).

Details

When ansi = TRUE, colors and text styling (bold, italic, strikeout, underline) are applied using ANSI escape sequences for terminal display. ANSI colors require a terminal or application that supports ANSI escape sequences. Common supported terminals include: Terminal.app (macOS), iTerm2 (macOS), Windows Terminal, most Linux terminals, RStudio Console, and VS Code terminal. Colors may not display correctly in basic text editors or older terminals.