wicked/tmp/wiki/Public.API.md

Generates github wiki compatible API documentation from your project's jsdocs and adds them to your wiki.

<!-- GENERATED WITH WICKED. Don't edit this file directly, instead run wicked again to regenerate API docs -->
<div class="jsdoc-githubify">
<h1 class="page-title">Namespace: Public</h1>
<section>
<header>
<h2>
Public
</h2>
</header>
<article>
<div class="container-overview">
<div class="description"><p>Public wicked API</p></div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy">
<li>
<a href="https://github.com/thlorenz/wicked/blob/master/index.js">index.js</a>
<span>, </span>
<a href="https://github.com/thlorenz/wicked/blob/master/index.js#L3">lineno 3</a>
</li>
</ul></dd>
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<h4 class="name" id="wicked"><span class="type-signature">&lt;static> </span>wicked<span class="signature">(root)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Generates jsdoc wiki pages for project of current working directory and updates github wiki with them.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>root</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>of the project</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy">
<li>
<a href="https://github.com/thlorenz/wicked/blob/master/index.js">index.js</a>
<span>, </span>
<a href="https://github.com/thlorenz/wicked/blob/master/index.js#L7">lineno 7</a>
</li>
</ul></dd>
</dl>
</dd>
</dl>
</article>
</section>
</div>
<br>
<h6><em>Generated with <a href="https://github.com/thlorenz/wicked">wicked</a>.</em></h6>