doc: update typedoc and README.md

This commit is contained in:
harttle
2019-08-26 23:31:53 +08:00
parent c2ba1e1f1a
commit d3f3d81e2e
82 changed files with 3276 additions and 863 deletions
+34 -1
View File
@@ -85,6 +85,7 @@
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_render_render_.render.html#rendertemplates" class="tsd-kind-icon">render<wbr>Templates</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_render_render_.render.html#rendertemplatessync" class="tsd-kind-icon">render<wbr>Templates<wbr>Sync</a></li>
</ul>
</section>
</div>
@@ -102,7 +103,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/5f7d1d7/src/render/render.ts#L7">render/render.ts:7</a></li>
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/c2ba1e1/src/render/render.ts#L7">render/render.ts:7</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -121,6 +122,35 @@
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="rendertemplatessync" class="tsd-anchor"></a>
<h3>render<wbr>Templates<wbr>Sync</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">render<wbr>Templates<wbr>Sync<span class="tsd-signature-symbol">(</span>templates<span class="tsd-signature-symbol">: </span><a href="../interfaces/_template_itemplate_.itemplate.html" class="tsd-signature-type">ITemplate</a><span class="tsd-signature-symbol">[]</span>, ctx<span class="tsd-signature-symbol">: </span><a href="_context_context_.context.html" class="tsd-signature-type">Context</a>, emitter<span class="tsd-signature-symbol">?: </span><a href="_render_emitter_.emitter.html" class="tsd-signature-type">Emitter</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/harttle/liquidjs/blob/c2ba1e1/src/render/render.ts#L19">render/render.ts:19</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>templates: <a href="../interfaces/_template_itemplate_.itemplate.html" class="tsd-signature-type">ITemplate</a><span class="tsd-signature-symbol">[]</span></h5>
</li>
<li>
<h5>ctx: <a href="_context_context_.context.html" class="tsd-signature-type">Context</a></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> emitter: <a href="_render_emitter_.emitter.html" class="tsd-signature-type">Emitter</a><span class="tsd-signature-symbol"> =&nbsp;new Emitter()</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
@@ -144,6 +174,9 @@
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_render_render_.render.html#rendertemplates" class="tsd-kind-icon">render<wbr>Templates</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_render_render_.render.html#rendertemplatessync" class="tsd-kind-icon">render<wbr>Templates<wbr>Sync</a>
</li>
</ul>
</li>
</ul>