1#' Markdown rendering for R
2#'
3#' \pkg{Markdown} is a plain-text formatting syntax that can be converted to
4#' XHTML or other formats. This package provides R bindings to the Sundown
5#' (\url{https://github.com/vmg/sundown}) markdown rendering library.
6#'
7#' The R function \code{\link{markdownToHTML}} renders a markdown file to HTML
8#' (respecting the specified \code{\link{markdownExtensions}} and
9#' \code{\link{markdownHTMLOptions}}).
10#'
11#' The package also exports the underlying Sundown C extension API which enables
12#' creating and calling custom renderers using the \code{\link{renderMarkdown}}
13#' function.
14#'
15#' To learn more about markdown syntax see:
16#'
17#' \url{http://en.wikipedia.org/wiki/Markdown}
18#' @name markdown
19#' @docType package
20#' @author JJ Allaire, Jeffrey Horner, Vicent Marti, and Natacha Porte
21#'
22#'   Maintainer: Yihui Xie <xie@@yihui.name>
23#' @seealso \code{\link{markdownToHTML}} \code{\link{renderMarkdown}}
24#' @useDynLib markdown, .registration = TRUE
25#' @keywords package
26NULL
27