renderMarkdown transforms the markdown text provided by the
user in either the file or text variable. The transformation is
either written to the output file or returned to the user. The default
rendering target is "HTML".
a character string giving the pathname of the file to read from.
If it is omitted from the argument list, then it is presumed that the
text argument will be used instead.
output
a character string giving the pathname of the file to write to.
If it is omitted (NULL), then it is presumed that the user expects
the results returned as a character vector.
text
a character vector containing the markdown text to
transform (each element of this vector is treated as a line in a file).
renderer
the name of the renderer that will be used to transform the
file or text.
renderer.options
options that are passed to the renderer. For
HTML renderer options see markdownHTMLOptions.
extensions
options that are passed to the markdown engine. See
markdownExtensions.
encoding
the encoding of the input file; see file
Details
markdown uses (and ships with) the popular Sundown library provided by
GitHub. C stubs are available to implement new renderers.
Value
renderMarkdown returns NULL invisibly when output is to a
file, and either character (with the UTF-8 encoding) or raw
vector depending on the renderer output type.