Skip to content

Commit

Permalink
publish typedocs
Browse files Browse the repository at this point in the history
  • Loading branch information
@asos-craigmorten @actions-user
asos-craigmorten authored and actions-user committed Aug 5, 2020
1 parent 79092b8 commit b288df0
Show file tree
Hide file tree
Showing 51 changed files with 542 additions and 546 deletions.
64 changes: 32 additions & 32 deletions docs/classes/_response_.response.html
View file

Large diffs are not rendered by default.

20 changes: 10 additions & 10 deletions docs/classes/_view_.view.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/cad1c51/src/view.ts#L35">view.ts:35</a></li>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/79092b8/src/view.ts#L35">view.ts:35</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -159,7 +159,7 @@ <h3>default<wbr>Engine</h3>
<div class="tsd-signature tsd-kind-icon">default<wbr>Engine<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/cad1c51/src/view.ts#L30">view.ts:30</a></li>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/79092b8/src/view.ts#L30">view.ts:30</a></li>
</ul>
</aside>
</section>
Expand All @@ -169,7 +169,7 @@ <h3>engine</h3>
<div class="tsd-signature tsd-kind-icon">engine<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/cad1c51/src/view.ts#L34">view.ts:34</a></li>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/79092b8/src/view.ts#L34">view.ts:34</a></li>
</ul>
</aside>
</section>
Expand All @@ -179,7 +179,7 @@ <h3>ext</h3>
<div class="tsd-signature tsd-kind-icon">ext<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/cad1c51/src/view.ts#L31">view.ts:31</a></li>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/79092b8/src/view.ts#L31">view.ts:31</a></li>
</ul>
</aside>
</section>
Expand All @@ -189,7 +189,7 @@ <h3>name</h3>
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/cad1c51/src/view.ts#L32">view.ts:32</a></li>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/79092b8/src/view.ts#L32">view.ts:32</a></li>
</ul>
</aside>
</section>
Expand All @@ -199,7 +199,7 @@ <h3>path</h3>
<div class="tsd-signature tsd-kind-icon">path<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/cad1c51/src/view.ts#L35">view.ts:35</a></li>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/79092b8/src/view.ts#L35">view.ts:35</a></li>
</ul>
</aside>
</section>
Expand All @@ -209,7 +209,7 @@ <h3>root</h3>
<div class="tsd-signature tsd-kind-icon">root<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/cad1c51/src/view.ts#L33">view.ts:33</a></li>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/79092b8/src/view.ts#L33">view.ts:33</a></li>
</ul>
</aside>
</section>
Expand All @@ -226,7 +226,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> lookup</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/cad1c51/src/view.ts#L122">view.ts:122</a></li>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/79092b8/src/view.ts#L122">view.ts:122</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -254,7 +254,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> render</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/cad1c51/src/view.ts#L145">view.ts:145</a></li>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/79092b8/src/view.ts#L145">view.ts:145</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -285,7 +285,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> resolve</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/cad1c51/src/view.ts#L98">view.ts:98</a></li>
<li>Defined in <a href="https://github.com/asos-craigmorten/opine/blob/79092b8/src/view.ts#L98">view.ts:98</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
12 changes: 4 additions & 8 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ <h2>Table of Contents</h2>
<a href="#getting-started" id="getting-started" style="color: inherit; text-decoration: none;">
<h2>Getting Started</h2>
</a>
<pre><code class="language-ts"><span class="hljs-keyword">import</span> { opine } <span class="hljs-keyword">from</span> <span class="hljs-string">&quot;https://deno.land/x/opine@main/mod.ts&quot;</span>;
<pre><code class="language-ts"><span class="hljs-keyword">import</span> { opine } <span class="hljs-keyword">from</span> <span class="hljs-string">&quot;https://deno.land/x/opine@0.20.2/mod.ts&quot;</span>;

<span class="hljs-keyword">const</span> app = opine();

Expand All @@ -113,13 +113,9 @@ <h2>Installation</h2>
<p>This is a <a href="https://deno.land/">Deno</a> module available to import direct from this repo and via the <a href="https://deno.land/x">Deno Registry</a>.</p>
<p>Before importing, <a href="https://deno.land/#installation">download and install Deno</a>.</p>
<p>You can then import Opine straight into your project:</p>
<pre><code class="language-ts"><span class="hljs-keyword">import</span> { opine } <span class="hljs-keyword">from</span> <span class="hljs-string">&quot;https://deno.land/x/opine@main/mod.ts&quot;</span>;</code></pre>
<p>If you want to use a specific version of Opine, just modify the import url to contain the version:</p>
<pre><code class="language-ts"><span class="hljs-keyword">import</span> { opine } <span class="hljs-keyword">from</span> <span class="hljs-string">&quot;https://deno.land/x/[email protected]/mod.ts&quot;</span>;</code></pre>
<p>Or if you want to use a specific commit of Opine, just modify the import url to contain the commit hash:</p>
<pre><code class="language-ts"><span class="hljs-keyword">import</span> { opine } <span class="hljs-keyword">from</span> <span class="hljs-string">&quot;https://deno.land/x/opine@c21f8d6/mod.ts&quot;</span>;</code></pre>
<pre><code class="language-ts"><span class="hljs-keyword">import</span> { opine } <span class="hljs-keyword">from</span> <span class="hljs-string">&quot;https://deno.land/x/[email protected]/mod.ts&quot;</span>;</code></pre>
<p>Opine is also available on <a href="https://nest.land/package/opine">nest.land</a>, a package registry for Deno on the Blockchain.</p>
<pre><code class="language-ts"><span class="hljs-keyword">import</span> { opine } <span class="hljs-keyword">from</span> <span class="hljs-string">&quot;https://x.nest.land/opine@0.14.0/mod.ts&quot;</span>;</code></pre>
<pre><code class="language-ts"><span class="hljs-keyword">import</span> { opine } <span class="hljs-keyword">from</span> <span class="hljs-string">&quot;https://x.nest.land/opine@0.20.2/mod.ts&quot;</span>;</code></pre>
<a href="#features" id="features" style="color: inherit; text-decoration: none;">
<h2>Features</h2>
</a>
Expand All @@ -139,7 +135,7 @@ <h2>Documentation</h2>
</a>
<ul>
<li><a href="https://github.com/asos-craigmorten/opine/blob/main/.github/API/api.md">Opine Docs</a> - usually the best place when getting started ✨</li>
<li><del><a href="https://asos-craigmorten.github.io/opine/">Opine Type Docs</a></del> - Unavailable while awaiting GitHub&#39;s support of alternatively named default branches.</li>
<li><a href="https://asos-craigmorten.github.io/opine/">Opine Type Docs</a></li>
<li><a href="https://doc.deno.land/https/deno.land/x/opine/mod.ts">Opine Deno Docs</a></li>
<li><a href="https://expressjs.com/en/4x/api.html">ExpressJS API Docs</a></li>
<li><a href="https://github.com/asos-craigmorten/opine/blob/main/LICENSE.md">License</a></li>
Expand Down
Loading

0 comments on commit b288df0

Please sign in to comment.