md_bullet {gluedown}R Documentation

Markdown bullet list

Description

take a character vector and return a glue vector of valid bullet list items. When printed together, these bullet list items create a bullet list. This container block is rendered as the ⁠<ul>⁠ HTML tag, with each element of the vector creating a separate ⁠<li>⁠ tag.

Usage

md_bullet(x, marker = c("*", "-", "+"))

Arguments

x

The vector of bullet point list items.

marker

The bullet list marker to use; one of -, +, or *.

Details

A list is a sequence of one or more list items of the same type. The list items may be separated by any number of blank lines.

Two list items are of the same type if they begin with a list marker of the same type. Two list markers are of the same type if (a) they are bullet list markers using the same character (-, +, or *)...

Value

A glue vector with length equal to x.

See Also

Other container block functions: md_list(), md_order(), md_quote(), md_task()

Examples

md_bullet(state.name[1:5])
md_bullet(sample(state.name, 5), marker = "+")

[Package gluedown version 1.0.9 Index]