EVOLUTION-MANAGER
Edit File: markdownHTMLOptions.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><title>R: Markdown HTML rendering options</title> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <link rel="stylesheet" type="text/css" href="R.css" /> </head><body> <table width="100%" summary="page for markdownHTMLOptions {markdown}"><tr><td>markdownHTMLOptions {markdown}</td><td style="text-align: right;">R Documentation</td></tr></table> <h2>Markdown HTML rendering options</h2> <h3>Description</h3> <p><code>markdownHTMLOptions</code> returns a character vector listing all the options that are available for the HTML renderer in the <span class="pkg">markdown</span> package. As a convenience, the package default options were chosen to render well-formed stand-alone HTML pages when using <code><a href="markdownToHTML.html">markdownToHTML</a>()</code>. The default options are <code>'use_xhtml'</code>, <code>'smartypants'</code>, <code>'base64_images'</code>, <code>'mathjax'</code>, and <code>'highlight_code'</code>. </p> <h3>Usage</h3> <pre> markdownHTMLOptions(defaults = FALSE) </pre> <h3>Arguments</h3> <table summary="R argblock"> <tr valign="top"><td><code>defaults</code></td> <td> <p>If <code>TRUE</code>, then only the default options are returned. Otherwise all options are returned.</p> </td></tr> </table> <h3>Details</h3> <p>The HTML renderer provides several options described below. To turn these on globally in the <span class="pkg">markdown</span> package, simply place some or all of them in a character vector and assign to the global option <code>markdown.HTML.options</code> like so: </p> <p><code>options(markdown.HTML.options = markdownHTMLOptions())</code> </p> <p>To reset the options to package default, use: </p> <p><code>options(markdown.HTML.options = markdownHTMLOptions(default = TRUE))</code> </p> <p>To override the global option, pass the <code>options</code> as an argument: </p> <p><code>markdownToHTML(..., options = c('skip_images'))</code> </p> <p>Description of all options: </p> <dl> <dt><code>'skip_html'</code></dt><dd><p> suppress output of all HTML tags in the document.</p> </dd> <dt><code>'skip_style'</code></dt><dd><p> suppress output of HTML style tags.</p> </dd> <dt><code>'skip_images'</code></dt><dd><p> suppress output of HTML image tags.</p> </dd> <dt><code>'skip_links'</code></dt><dd><p> suppress output of HTML anchor tags.</p> </dd> <dt><code>'safelink'</code></dt><dd><p> only create links for known url types, e.g. http, ftp, http, etc.</p> </dd> <dt><code>'toc'</code></dt><dd><p> assigns an HTML id to each header of the form 'toc_ where ' (starting at 0), and creates the table of contents.</p> </dd> <dt><code>'hard_wrap'</code></dt><dd><p> adds an HTML br tag for every newline (excluding trailing) found within a paragraph.</p> </dd> <dt><code>'use_xhtml'</code></dt><dd><p> create XHMTL 1.0 compliant HTML tags.</p> </dd> <dt><code>'escape'</code></dt><dd><p> escape all HTML found within the <em>markdown</em>. Overrides all of the <code>'skip_*'</code> options mentioned above.</p> </dd> <dt><code>'smartypants'</code></dt><dd><p> translates plain ASCII punctuation characters into <em>smart</em> typographic punctuation HTML entities. </p> </dd> <dt><code>'fragment_only'</code></dt><dd><p> eliminates the inclusion of any HTML header or body tags, CSS, or Javascript components. </p> </dd> <dt><code>'base64_images'</code></dt><dd><p> Any local images linked with the <code>'<img>'</code> tag to the output HTML will automatically be converted to base64 and included along with output. </p> </dd> <dt><code>'mathjax'</code></dt><dd><p> includes appropriate Javascript libraries to render math markup.</p> </dd> <dt><code>'highlight_code'</code></dt><dd><p> includes appropriate Javascript libraries to highlight code chunks.</p> </dd> </dl> <p>See the EXAMPLES section to see the output of each option turned on or off. </p> <h3>Value</h3> <p>A <code>character</code> vector listing either all available options or just the default options. </p> <h3>See Also</h3> <p><a href="markdownToHTML.html">markdownToHTML</a> </p> <h3>Examples</h3> <pre> # List all available extensions: markdownHTMLOptions() # To turn on all HTML options globally: options(markdown.HTML.options = markdownHTMLOptions()) # To turn off all HTML options globally: options(markdown.HTML.options = NULL) # To turn on package default HTML options globally: options(markdown.HTML.options = markdownHTMLOptions(default = TRUE)) # HTML OPTIONS # The following examples are short, so we allways add the HTML option 'fragment_only' tOpt <- "fragment_only" # skip_html example mkd = '<style></style><img src="http://cran.rstudio.com/Rlogo.jpg"><a href="#">Hello</a>' cat(markdownToHTML(text = mkd, options = c(tOpt))) cat(markdownToHTML(text = mkd, options = c(tOpt, "skip_html"))) # skip_style example cat(markdownToHTML(text = mkd, options = c(tOpt))) cat(markdownToHTML(text = mkd, options = c(tOpt, "skip_style"))) # skip_images example cat(markdownToHTML(text = mkd, options = c(tOpt))) cat(markdownToHTML(text = mkd, options = c(tOpt, "skip_images"))) # skip_links example cat(markdownToHTML(text = mkd, options = c(tOpt))) cat(markdownToHTML(text = mkd, options = c(tOpt, "skip_links"))) # safelink example cat(markdownToHTML(text = '[foo](http://google.com "baz")', options = c(tOpt))) cat(markdownToHTML(text = '[foo](http://google.com "baz")', options = c(tOpt, "safelink"))) # toc example mkd <- paste(c("# Header 1", "p1", "## Header 2", "p2"), collapse = "\n") cat(markdownToHTML(text = mkd, options = c(tOpt))) cat(markdownToHTML(text = mkd, options = c(tOpt, "toc"))) # hard_wrap example cat(markdownToHTML(text = "foo\nbar\n", options = c(tOpt))) cat(markdownToHTML(text = "foo\nbar\n", options = c(tOpt, "hard_wrap"))) # use_xhtml example cat(markdownToHTML(text = "foo\nbar\n", options = c(tOpt, "hard_wrap"))) cat(markdownToHTML(text = "foo\nbar\n", options = c(tOpt, "hard_wrap", "use_xhtml"))) # escape example mkd = '<style></style><img src="http://cran.rstudio.com/Rlogo.jpg"><a href="#">Hello</a>' cat(markdownToHTML(text = mkd, options = c(tOpt, "skip_html"))) # overrides all 'skip_*' options cat(markdownToHTML(text = mkd, options = c(tOpt, "skip_html", "escape"))) # smartypants example cat(markdownToHTML(text = "1/2 (c)", options = c(tOpt))) cat(markdownToHTML(text = "1/2 (c)", options = c(tOpt, "smartypants"))) cat(smartypants(text = "1/2 (c)\n")) </pre> <hr /><div style="text-align: center;">[Package <em>markdown</em> version 1.1 <a href="00Index.html">Index</a>]</div> </body></html>