Getting started with altdown

This vignette shows off a few Quarto callout blocks, and how they render on a site built with altdoc’s quarto_website tool, which lets Quarto handle vignettes directly instead of converting them to plain Markdown first.

greet() and add() below are not part of the real package API; they are toy functions injected during the site build for this showcase (see the reference index).

library(altdown)

Saying hello

Note

greet() is a toy demo function; it just pastes together a friendly string. Nothing fancy.

greet("altdoc")

[1] "Hello, altdoc!"

You can also shout the greeting:

greet("altdoc", loud = TRUE)

[1] "HELLO, ALTDOC!"

Tip

Set loud = TRUE when you really mean it.

Adding numbers

add(2, 40)

[1] 42

Warning

Like greet(), add() is a toy stand-in: it does no input validation, so passing non-numeric arguments raises a base R error rather than a friendly one.

add("2", 40)

Error in `x + y`:
! non-numeric argument to binary operator