markdown v0.9

0

Monthly downloads

0th

Percentile

'Markdown' Rendering for R

Provides R bindings to the 'Sundown' 'Markdown' rendering library (<https://github.com/vmg/sundown>). 'Markdown' is a plain-text formatting syntax that can be converted to 'XHTML' or other formats. See <http://en.wikipedia.org/wiki/Markdown> for more information about 'Markdown'.

Readme

Markdown rendering for R

Build Status Downloads from the RStudio CRAN mirror

Overview

Markdown is a plain-text formatting syntax that can be converted to XHTML or other formats. This package provides R bindings to the Sundown 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 Sundown 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 referred to as R Markdown v1 when combined with knitr. The primary output format is HTML. We do not plan to add new features to this package in the future, and please consider this package to be in the maintenance mode only. In 2014, we introduced R Markdown v2, which is based on Pandoc and knitr, and supports much more types of output formats. Please see https://rmarkdown.rstudio.com for details.

License

The markdown 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

Functions in markdown

Name Description
markdownExtensions Markdown extensions
markdown Markdown rendering for R
rpubsUpload Upload an HTML file to RPubs
smartypants smartypants: ASCII punctuation to HTML entities
markdownHTMLOptions Markdown HTML rendering options
markdownToHTML Render markdown to HTML
registeredRenderers List of Registered Markdown Renderers
renderMarkdown Render markdown to an HTML fragment
rendererExists Testing for existence of a markdown renderer
rendererOutputType Fetch the Renderer Output Type
No Results!

Vignettes of markdown

Name
markdown-examples.Rmd
markdown-output.Rmd
No Results!

Last month downloads

Details

Type Package
License GPL-2
URL https://github.com/rstudio/markdown
BugReports https://github.com/rstudio/markdown/issues
VignetteBuilder knitr
RoxygenNote 6.0.1
NeedsCompilation yes
Packaged 2018-12-06 16:24:51 UTC; yihui
Repository CRAN
Date/Publication 2018-12-07 00:50:11 UTC

Include our badge in your README

[![Rdoc](http://www.rdocumentation.org/badges/version/markdown)](http://www.rdocumentation.org/packages/markdown)