Skip to content
Snippets Groups Projects

Markdown rendering for R

Build Status

Overview

Markdown is a plain-text formatting syntax that can be converted to XHTML or other formats. This package provides R bindings to the Hoedown markdown rendering library.

The R function markdownToHTML renders a markdown file to HTML. Options controlling HTML output and supported markdown extensions can be optionally specified.

The package also exports the underlying Hoedown C extension API which enables creating and calling custom renderers using the renderMarkdown function.

To learn more about markdown syntax see: http://en.wikipedia.org/wiki/Markdown

This package is adapted from the markdown package written by JJ Allaire and others at RStudio.

License

The rhoedown package is licensed under the GPLv2. See these files for additional details:

  • inst/COPYING - Markdown package license (GPLv2)
  • inst/NOTICE - Copyright notices for additional included software