arl_html_vignette: HTML vignette format with Arl syntax highlighting
In arl: Embedded Lisp Dialect
arl_html_vignette R Documentation
HTML vignette format with Arl syntax highlighting
Description
A wrapper around html_vignette that passes
--syntax-definition to Pandoc so that {arl} code blocks
receive proper syntax highlighting.
Usage
arl_html_vignette(pandoc_args = NULL, check_title = TRUE, ...)
Arguments
pandoc_args
Additional Pandoc arguments (merged with the
syntax-definition argument added automatically).
check_title
Whether to check that the vignette title matches the
VignetteIndexEntry. Set to FALSE for pkgdown-only articles
that intentionally omit a VignetteIndexEntry.
...
Arguments passed to html_vignette.
Value
An R Markdown output format object.
arl documentation built on March 19, 2026, 5:09 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| arl_html_vignette | R Documentation |
HTML vignette format with Arl syntax highlighting
Description
A wrapper around html_vignette that passes
--syntax-definition to Pandoc so that {arl} code blocks
receive proper syntax highlighting.
Usage
arl_html_vignette(pandoc_args = NULL, check_title = TRUE, ...)
Arguments
pandoc_args |
Additional Pandoc arguments (merged with the syntax-definition argument added automatically). |
check_title |
Whether to check that the vignette title matches the
|
... |
Arguments passed to |
Value
An R Markdown output format object.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.