mirror of
https://github.com/rstudio/shiny.git
synced 2026-04-29 03:00:45 -04:00
150 lines
10 KiB
HTML
150 lines
10 KiB
HTML
<!DOCTYPE html>
|
|
<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title>Insert inline Markdown — markdown • shiny</title><!-- favicons --><link rel="icon" type="image/png" sizes="16x16" href="../favicon-16x16.png"><link rel="icon" type="image/png" sizes="32x32" href="../favicon-32x32.png"><link rel="apple-touch-icon" type="image/png" sizes="180x180" href="../apple-touch-icon.png"><link rel="apple-touch-icon" type="image/png" sizes="120x120" href="../apple-touch-icon-120x120.png"><link rel="apple-touch-icon" type="image/png" sizes="76x76" href="../apple-touch-icon-76x76.png"><link rel="apple-touch-icon" type="image/png" sizes="60x60" href="../apple-touch-icon-60x60.png"><!-- jquery --><script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script><!-- Bootstrap --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/css/bootstrap.min.css" integrity="sha256-bZLfwXAP04zRMK2BjiO8iu9pf4FbLqX6zitd+tIvLhE=" crossorigin="anonymous"><script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js" integrity="sha256-nuL8/2cJ5NDSSwnKD8VqreErSWHtnEP9E7AySL+1ev4=" crossorigin="anonymous"></script><!-- bootstrap-toc --><link rel="stylesheet" href="../bootstrap-toc.css"><script src="../bootstrap-toc.js"></script><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous"><!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script><!-- headroom.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script><!-- pkgdown --><link href="../pkgdown.css" rel="stylesheet"><script src="../pkgdown.js"></script><meta property="og:title" content="Insert inline Markdown — markdown"><meta property="og:description" content="This function accepts
|
|
Markdown-syntax text and returns
|
|
HTML that may be included in Shiny UIs."><meta property="og:image" content="/logo.png"><!-- mathjax --><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script><!--[if lt IE 9]>
|
|
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
|
|
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
|
|
<![endif]--></head><body data-spy="scroll" data-target="#toc">
|
|
|
|
|
|
<div class="container template-reference-topic">
|
|
<header><div class="navbar navbar-default navbar-fixed-top" role="navigation">
|
|
<div class="container">
|
|
<div class="navbar-header">
|
|
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false">
|
|
<span class="sr-only">Toggle navigation</span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
</button>
|
|
<span class="navbar-brand">
|
|
<a class="navbar-link" href="../index.html">shiny</a>
|
|
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">1.7.4.9003</span>
|
|
</span>
|
|
</div>
|
|
|
|
<div id="navbar" class="navbar-collapse collapse">
|
|
<ul class="nav navbar-nav"><li>
|
|
<a href="../reference/index.html">Reference</a>
|
|
</li>
|
|
<li>
|
|
<a href="../news/index.html">Changelog</a>
|
|
</li>
|
|
</ul><ul class="nav navbar-nav navbar-right"><li>
|
|
<a href="https://github.com/rstudio/shiny/" class="external-link">
|
|
<span class="fab fa-github fa-lg"></span>
|
|
|
|
</a>
|
|
</li>
|
|
</ul></div><!--/.nav-collapse -->
|
|
</div><!--/.container -->
|
|
</div><!--/.navbar -->
|
|
|
|
|
|
|
|
</header><div class="row">
|
|
<div class="col-md-9 contents">
|
|
<div class="page-header">
|
|
<h1>Insert inline Markdown</h1>
|
|
<small class="dont-index">Source: <a href="https://github.com/rstudio/shiny/blob/HEAD/R/shiny.R" class="external-link"><code>R/shiny.R</code></a></small>
|
|
<div class="hidden name"><code>markdown.Rd</code></div>
|
|
</div>
|
|
|
|
<div class="ref-description">
|
|
<p>This function accepts
|
|
<a href="https://en.wikipedia.org/wiki/Markdown" class="external-link">Markdown</a>-syntax text and returns
|
|
HTML that may be included in Shiny UIs.</p>
|
|
</div>
|
|
|
|
<div id="ref-usage">
|
|
<div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">markdown</span><span class="op">(</span><span class="va">mds</span>, extensions <span class="op">=</span> <span class="cn">TRUE</span>, .noWS <span class="op">=</span> <span class="cn">NULL</span>, <span class="va">...</span><span class="op">)</span></span></code></pre></div>
|
|
</div>
|
|
|
|
<div id="arguments">
|
|
<h2>Arguments</h2>
|
|
<dl><dt>mds</dt>
|
|
<dd><p>A character vector of Markdown source to convert to HTML. If the
|
|
vector has more than one element, a single-element character vector of
|
|
concatenated HTML is returned.</p></dd>
|
|
|
|
|
|
<dt>extensions</dt>
|
|
<dd><p>Enable Github syntax extensions; defaults to <code>TRUE</code>.</p></dd>
|
|
|
|
|
|
<dt>.noWS</dt>
|
|
<dd><p>Character vector used to omit some of the whitespace that would
|
|
normally be written around generated HTML. Valid options include <code>before</code>,
|
|
<code>after</code>, and <code>outside</code> (equivalent to <code>before</code> and <code>end</code>).</p></dd>
|
|
|
|
|
|
<dt>...</dt>
|
|
<dd><p>Additional arguments to pass to <code><a href="https://docs.ropensci.org/commonmark/reference/commonmark.html" class="external-link">commonmark::markdown_html()</a></code>.
|
|
These arguments are <em><a href="https://rlang.r-lib.org/reference/dyn-dots.html" class="external-link">dynamic</a></em>.</p></dd>
|
|
|
|
</dl></div>
|
|
<div id="value">
|
|
<h2>Value</h2>
|
|
|
|
|
|
<p>a character vector marked as HTML.</p>
|
|
</div>
|
|
<div id="details">
|
|
<h2>Details</h2>
|
|
<p>Leading whitespace is trimmed from Markdown text with <code><a href="https://glue.tidyverse.org/reference/trim.html" class="external-link">glue::trim()</a></code>.
|
|
Whitespace trimming ensures Markdown is processed correctly even when the
|
|
call to <code>markdown()</code> is indented within surrounding R code.</p>
|
|
<p>By default, <a href="https://docs.ropensci.org/commonmark/reference/extensions.html" class="external-link">Github extensions</a> are enabled, but this
|
|
can be disabled by passing <code>extensions = FALSE</code>.</p>
|
|
<p>Markdown rendering is performed by <code><a href="https://docs.ropensci.org/commonmark/reference/commonmark.html" class="external-link">commonmark::markdown_html()</a></code>. Additional
|
|
arguments to <code>markdown()</code> are passed as arguments to <code>markdown_html()</code></p>
|
|
</div>
|
|
|
|
<div id="ref-examples">
|
|
<h2>Examples</h2>
|
|
<div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="va">ui</span> <span class="op"><-</span> <span class="fu"><a href="fluidPage.html">fluidPage</a></span><span class="op">(</span></span></span>
|
|
<span class="r-in"><span> <span class="fu">markdown</span><span class="op">(</span><span class="st">"</span></span></span>
|
|
<span class="r-in"><span><span class="st"> # Markdown Example</span></span></span>
|
|
<span class="r-in"><span><span class="st"></span></span></span>
|
|
<span class="r-in"><span><span class="st"> This is a markdown paragraph, and will be contained within a `<p>` tag</span></span></span>
|
|
<span class="r-in"><span><span class="st"> in the UI.</span></span></span>
|
|
<span class="r-in"><span><span class="st"></span></span></span>
|
|
<span class="r-in"><span><span class="st"> The following is an unordered list, which will be represented in the UI as</span></span></span>
|
|
<span class="r-in"><span><span class="st"> a `<ul>` with `<li>` children:</span></span></span>
|
|
<span class="r-in"><span><span class="st"></span></span></span>
|
|
<span class="r-in"><span><span class="st"> * a bullet</span></span></span>
|
|
<span class="r-in"><span><span class="st"> * another</span></span></span>
|
|
<span class="r-in"><span><span class="st"></span></span></span>
|
|
<span class="r-in"><span><span class="st"> [Links](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a) work;</span></span></span>
|
|
<span class="r-in"><span><span class="st"> so does *emphasis*.</span></span></span>
|
|
<span class="r-in"><span><span class="st"></span></span></span>
|
|
<span class="r-in"><span><span class="st"> To see more of what's possible, check out [commonmark.org/help](https://commonmark.org/help).</span></span></span>
|
|
<span class="r-in"><span><span class="st"> "</span><span class="op">)</span></span></span>
|
|
<span class="r-in"><span><span class="op">)</span></span></span>
|
|
</code></pre></div>
|
|
</div>
|
|
</div>
|
|
<div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar">
|
|
<nav id="toc" data-toggle="toc" class="sticky-top"><h2 data-toc-skip>Contents</h2>
|
|
</nav></div>
|
|
</div>
|
|
|
|
|
|
<footer><div class="copyright">
|
|
<p></p><p>Developed by Winston Chang, Joe Cheng, JJ Allaire, Carson Sievert, Barret Schloerke, Yihui Xie, Jeff Allen, Jonathan McPherson, Alan Dipert, Barbara Borges.</p>
|
|
</div>
|
|
|
|
<div class="pkgdown">
|
|
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p>
|
|
</div>
|
|
|
|
</footer></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</body></html>
|
|
|