md: Interpret input text as Markdown-formatted text

Description Usage Arguments Value Figures Function ID See Also Examples

View source: R/helpers.R

Description

Markdown! It's a wonderful thing. We can use it in certain places (e.g., footnotes, source notes, the table title, etc.) and expect it to render to HTML as Markdown does. There is the html() helper that allows you to ferry in HTML but this function md()... it's almost like a two-for-one deal (you get to use Markdown plus any HTML fragments at the same time).

Usage

1

Arguments

text

The text that is understood to contain Markdown formatting.

Value

A character object of class from_markdown. It's tagged as being Markdown text and it will undergo conversion to HTML.

Figures

Function ID

7-1

See Also

Other Helper Functions: adjust_luminance(), cell_borders(), cell_fill(), cell_text(), cells_body(), cells_column_labels(), cells_column_spanners(), cells_footnotes(), cells_grand_summary(), cells_row_groups(), cells_source_notes(), cells_stub_grand_summary(), cells_stub_summary(), cells_stubhead(), cells_stub(), cells_summary(), cells_title(), currency(), default_fonts(), escape_latex(), google_font(), gt_latex_dependencies(), html(), pct(), px(), random_id()

Examples

1
2
3
4
5
6
7
8
9
# Use `exibble` to create a gt table;
# when adding a title, use the `md()`
# helper to use Markdown formatting
tab_1 <-
  exibble %>%
  dplyr::select(currency, char) %>%
  gt() %>%
  tab_header(
    title = md("Using *Markdown*"))

gt documentation built on May 12, 2021, 9:05 a.m.

Related to md in gt...