246 lines
5.4 KiB
HTML
246 lines
5.4 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset='UTF-8'>
|
|
<title>CoffeeScript API Documentation</title>
|
|
<script src='../../javascript/application.js'></script>
|
|
<script src='../../javascript/search.js'></script>
|
|
<link rel='stylesheet' href='../../stylesheets/application.css' type='text/css'>
|
|
</head>
|
|
<body>
|
|
<div id='base' data-path='../../'></div>
|
|
<div id='header'>
|
|
<div id='menu'>
|
|
<a href='../../extra/README.md.html' title='Yatta'>
|
|
Yatta
|
|
</a>
|
|
»
|
|
<a href='../../alphabetical_index.html' title='Index'>
|
|
Index
|
|
</a>
|
|
»
|
|
<span class='title'>Tools</span>
|
|
»
|
|
<span class='title'>Markdown</span>
|
|
</div>
|
|
</div>
|
|
<div id='content'>
|
|
<h1>
|
|
Class:
|
|
Tools.Markdown
|
|
</h1>
|
|
<table class='box'>
|
|
<tr>
|
|
<td>Defined in:</td>
|
|
<td>node_modules/grunt-codo/node_modules/codo/lib/tools/markdown.coffee</td>
|
|
</tr>
|
|
</table>
|
|
<h2>Overview</h2>
|
|
<div class='docstring'>
|
|
<p>It looks like all the markdown libraries for node doesn't get
|
|
GitHub flavored markdown right. This helper class post-processes
|
|
the best available output from the marked library to conform to
|
|
GHM. In addition the allowed tags can be limited.</p>
|
|
</div>
|
|
<div class='tags'>
|
|
</div>
|
|
<h2>Variables Summary</h2>
|
|
<dl class='constants'>
|
|
<dt id='limitedTags-variable'>
|
|
limitedTags
|
|
=
|
|
</dt>
|
|
<dd>
|
|
<pre><code class='coffeescript'>'a,abbr,acronym,b,big,cite,code,del,em,i,ins,sub,sup,span,small,strike,strong,q,tt,u'</code></pre>
|
|
|
|
</dd>
|
|
</dl>
|
|
<h2>Class Method Summary</h2>
|
|
<ul class='summary'>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#convert-static'>
|
|
.
|
|
(void)
|
|
<b>convert</b><span>(markdown, limit = false, allowed = Markdown.limitedTags)</span>
|
|
</a>
|
|
</span>
|
|
<span class='desc'>
|
|
Convert markdown to Html.
|
|
</span>
|
|
</li>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#limit-static'>
|
|
.
|
|
(String)
|
|
<b>limit</b><span>(html, allowed)</span>
|
|
</a>
|
|
</span>
|
|
<span class='desc'>
|
|
Strips all unwanted tag from the html
|
|
</span>
|
|
</li>
|
|
</ul>
|
|
<h2>Class Method Details</h2>
|
|
<div class='methods'>
|
|
<div class='method_details'>
|
|
<p class='signature' id='convert-static'>
|
|
.
|
|
(void)
|
|
<b>convert</b><span>(markdown, limit = false, allowed = Markdown.limitedTags)</span>
|
|
<br>
|
|
</p>
|
|
<div class='docstring'>
|
|
<p>Convert markdown to Html. If the param <code>limit</code>
|
|
is true, then all unwanted elements are stripped from the
|
|
result and also all existing newlines.</p>
|
|
</div>
|
|
<div class='tags'>
|
|
<h3>Parameters:</h3>
|
|
<ul class='param'>
|
|
<li>
|
|
<span class='name'>markdown</span>
|
|
<span class='type'>
|
|
(
|
|
<tt>String</tt>
|
|
)
|
|
</span>
|
|
—
|
|
<span class='desc'>the markdown markup </span>
|
|
</li>
|
|
<li>
|
|
<span class='name'>limit</span>
|
|
<span class='type'>
|
|
(
|
|
<tt>Boolean</tt>
|
|
)
|
|
</span>
|
|
—
|
|
<span class='desc'>if elements should be limited </span>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class='method_details'>
|
|
<p class='signature' id='limit-static'>
|
|
.
|
|
(String)
|
|
<b>limit</b><span>(html, allowed)</span>
|
|
<br>
|
|
</p>
|
|
<div class='docstring'>
|
|
<p>Strips all unwanted tag from the html</p>
|
|
</div>
|
|
<div class='tags'>
|
|
<h3>Parameters:</h3>
|
|
<ul class='param'>
|
|
<li>
|
|
<span class='name'>html</span>
|
|
<span class='type'>
|
|
(
|
|
<tt>String</tt>
|
|
)
|
|
</span>
|
|
—
|
|
<span class='desc'>the Html to clean </span>
|
|
</li>
|
|
<li>
|
|
<span class='name'>allowed</span>
|
|
<span class='type'>
|
|
(
|
|
<tt>String</tt>
|
|
)
|
|
</span>
|
|
—
|
|
<span class='desc'>the comma separated list of allowed tags </span>
|
|
</li>
|
|
</ul>
|
|
<h3>Returns:</h3>
|
|
<ul class='return'>
|
|
<li>
|
|
<span class='type'></span>
|
|
(
|
|
<tt>String</tt>
|
|
)
|
|
—
|
|
<span class='desc'>the cleaned Html </span>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id='footer'>
|
|
August 12, 14 06:33:02 by
|
|
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
|
|
Codo
|
|
</a>
|
|
2.0.9
|
|
✲
|
|
Press H to see the keyboard shortcuts
|
|
✲
|
|
<a href='http://twitter.com/netzpirat' target='_parent'>@netzpirat</a>
|
|
✲
|
|
<a href='http://twitter.com/_inossidabile' target='_parent'>@_inossidabile</a>
|
|
</div>
|
|
<iframe id='search_frame'></iframe>
|
|
<div id='fuzzySearch'>
|
|
<input type='text'>
|
|
<ol></ol>
|
|
</div>
|
|
<div id='help'>
|
|
<p>
|
|
Quickly fuzzy find classes, mixins, methods, file:
|
|
</p>
|
|
<ul>
|
|
<li>
|
|
<span>T</span>
|
|
Open fuzzy finder dialog
|
|
</li>
|
|
</ul>
|
|
<p>
|
|
Control the navigation frame:
|
|
</p>
|
|
<ul>
|
|
<li>
|
|
<span>L</span>
|
|
Toggle list view
|
|
</li>
|
|
<li>
|
|
<span>C</span>
|
|
Show class list
|
|
</li>
|
|
<li>
|
|
<span>I</span>
|
|
Show mixin list
|
|
</li>
|
|
<li>
|
|
<span>F</span>
|
|
Show file list
|
|
</li>
|
|
<li>
|
|
<span>M</span>
|
|
Show method list
|
|
</li>
|
|
<li>
|
|
<span>E</span>
|
|
Show extras list
|
|
</li>
|
|
</ul>
|
|
<p>
|
|
You can focus and blur the search input:
|
|
</p>
|
|
<ul>
|
|
<li>
|
|
<span>S</span>
|
|
Focus search input
|
|
</li>
|
|
<li>
|
|
<span>Esc</span>
|
|
Blur search input
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html> |