Skip to content

Commit 86b0eae

Browse files
typhonrttyphonrt
committed
update doc index
1 parent 4778d40 commit 86b0eae

File tree

3 files changed

+36
-36
lines changed

3 files changed

+36
-36
lines changed

‎docs/2023/dom/index.html‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@
1010
<div class="col-content">
1111
<div class="tsd-page-title">
1212
<h2>Typescript Library Declarations (DOM)</h2></div>
13-
<div class="tsd-panel tsd-typography"><p>Provides comprehensive API docs for the Typescript built-in libs covering the <a href="https://typhonjs-typedoc.github.io/ts-lib-docs/2023/dom/">DOM</a>,
14-
<a href="https://typhonjs-typedoc.github.io/ts-lib-docs/2023/esm/">ES2023</a>, and
15-
<a href="https://typhonjs-typedoc.github.io/ts-lib-docs/2023/worker/">Web Worker</a> APIs. The DOM API docs also include the
13+
<div class="tsd-panel tsd-typography"><p>Provides comprehensive API docs for the Typescript built-in libs covering the <a href="https://typhonjs-typedoc.github.io/ts-lib-docs/2023/dom/">DOM</a>,
14+
<a href="https://typhonjs-typedoc.github.io/ts-lib-docs/2023/esm/">ES2023</a>, and
15+
<a href="https://typhonjs-typedoc.github.io/ts-lib-docs/2023/worker/">Web Worker</a> APIs. The DOM API docs also include the
1616
WebCodecs, WebGPU, and WebXR APIs.</p>
1717
<p>The docs are generated from the following sources:</p>
1818
<ul>
@@ -21,29 +21,29 @@ <h2>Typescript Library Declarations (DOM)</h2></div>
2121
<li>@webgpu/types (0.1.32)</li>
2222
<li>@types/webxr (0.5.2)</li>
2323
</ul>
24-
<p>The <code>@mdn/browser-compat-data</code> (5.3.1) package is cross-linked against all symbols and a web component
24+
<p>The <code>@mdn/browser-compat-data</code> (5.3.1) package is cross-linked against all symbols and a web component
2525
provides links to MDN docs <em>and</em> relevant specifications embedded in the API docs provided.</p>
2626
<hr>
27-
<p>If you are using TypeDoc to generate documentation there are several plugins available to link all TS built-in lib
27+
<p>If you are using TypeDoc to generate documentation there are several plugins available to link all TS built-in lib
2828
symbols to the hosted TS Lib docs. You can find the NPM package here: <a href="https://www.npmjs.com/package/@typhonjs-typedoc/ts-lib-docs">@typhonjs-typedoc/ts-lib-docs</a> </p>
2929
<p>Include the following in your <code>devDependencies</code> in <code>package.json</code>:</p>
30-
<pre><code class="language-json"><span class="hl-0">{</span><br><span class="hl-0"> </span><span class="hl-1">"devDependencies"</span><span class="hl-0">: {</span><br><span class="hl-0"> </span><span class="hl-1">"@typhonjs-typedoc/ts-lib-docs"</span><span class="hl-0">: </span><span class="hl-2">"2023.7.10"</span><span class="hl-0">,</span><br><span class="hl-0"> </span><span class="hl-1">"@typhonjs-typedoc/typedoc-theme-dmt"</span><span class="hl-0">: </span><span class="hl-2">"^0.1.0"</span><span class="hl-0">,</span><br><span class="hl-0"> </span><span class="hl-1">"typedoc"</span><span class="hl-0">: </span><span class="hl-2">"^0.24.8"</span><br><span class="hl-0"> }</span><br><span class="hl-0">}</span>
30+
<pre><code class="language-json"><span class="hl-0">{</span><br><span class="hl-0"> </span><span class="hl-1">"devDependencies"</span><span class="hl-0">: {</span><br><span class="hl-0"> </span><span class="hl-1">"@typhonjs-typedoc/ts-lib-docs"</span><span class="hl-0">: </span><span class="hl-2">"2023.7.12"</span><span class="hl-0">,</span><br><span class="hl-0"> </span><span class="hl-1">"@typhonjs-typedoc/typedoc-theme-dmt"</span><span class="hl-0">: </span><span class="hl-2">"^0.1.0"</span><span class="hl-0">,</span><br><span class="hl-0"> </span><span class="hl-1">"typedoc"</span><span class="hl-0">: </span><span class="hl-2">"^0.24.8"</span><br><span class="hl-0"> }</span><br><span class="hl-0">}</span>
3131
</code><button>Copy</button></pre>
3232
<p>The date of generation <code>&lt;year&gt;.&lt;month&gt;.&lt;day&gt;</code> is used instead of normal SEMVER.</p>
3333
<p>Then in your TypeDoc configuration / JSON include:</p>
3434
<pre><code class="language-json"><span class="hl-0">{</span><br><span class="hl-0"> </span><span class="hl-1">"plugin"</span><span class="hl-0">: [ </span><br><span class="hl-0"> </span><span class="hl-2">"@typhonjs-typedoc/typedoc-theme-dmt"</span><span class="hl-0">,</span><br><span class="hl-0"> </span><span class="hl-2">"@typhonjs-typedoc/ts-lib-docs/typedoc/ts-links/dom/2023"</span><span class="hl-0">,</span><br><span class="hl-0"> </span><span class="hl-2">"@typhonjs-typedoc/ts-lib-docs/typedoc/ts-links/esm/2023"</span><br><span class="hl-0"> ]</span><br><span class="hl-0">}</span>
3535
</code><button>Copy</button></pre>
36-
<p>You should choose either the "dom" or "worker" <code>ts-lib-docs</code> plugin and not both. The "worker" plugin is omitted from
36+
<p>You should choose either the "dom" or "worker" <code>ts-lib-docs</code> plugin and not both. The "worker" plugin is omitted from
3737
the above example.</p>
3838
<hr>
39-
<p>A brand new Typedoc theme <a href="https://www.npmjs.com/package/@typhonjs-typedoc/typedoc-theme-dmt">@typhonjs-typedoc/typedoc-theme-dmt</a> /
40-
(Default Modern Theme) / theme augmentation is used to generate the TS Lib docs. The biggest feature is a massive
41-
reduction in disk space utilized upwards of 90% for large documentation projects like this one along with an 80% speed
39+
<p>A brand new Typedoc theme <a href="https://www.npmjs.com/package/@typhonjs-typedoc/typedoc-theme-dmt">@typhonjs-typedoc/typedoc-theme-dmt</a> /
40+
(Default Modern Theme) / theme augmentation is used to generate the TS Lib docs. The biggest feature is a massive
41+
reduction in disk space utilized upwards of 90% for large documentation projects like this one along with an 80% speed
4242
improvement when generating docs. The DMT theme is not necessary to link your TypeDoc doc generation. </p>
4343
<hr>
44-
<p>Please note that the TS Lib API docs are presently hosted through Github pages while a permanent hosting location is
44+
<p>Please note that the TS Lib API docs are presently hosted through Github pages while a permanent hosting location is
4545
found. IE if this gets popular GH bandwidth concerns may come into play.</p>
46-
<p>You may open an issue at <a href="https://github.com/typhonjs-typedoc/ts-lib-docs">ts-lib-docs</a> repository for discussion /
46+
<p>You may open an issue at <a href="https://github.com/typhonjs-typedoc/ts-lib-docs">ts-lib-docs</a> repository for discussion /
4747
feedback.</p>
4848
</div></div>
4949
<div class="col-sidebar">

‎docs/2023/esm/index.html‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@
1010
<div class="col-content">
1111
<div class="tsd-page-title">
1212
<h2>Typescript Library Declarations (ES2023)</h2></div>
13-
<div class="tsd-panel tsd-typography"><p>Provides comprehensive API docs for the Typescript built-in libs covering the <a href="https://typhonjs-typedoc.github.io/ts-lib-docs/2023/dom/">DOM</a>,
14-
<a href="https://typhonjs-typedoc.github.io/ts-lib-docs/2023/esm/">ES2023</a>, and
15-
<a href="https://typhonjs-typedoc.github.io/ts-lib-docs/2023/worker/">Web Worker</a> APIs. The DOM API docs also include the
13+
<div class="tsd-panel tsd-typography"><p>Provides comprehensive API docs for the Typescript built-in libs covering the <a href="https://typhonjs-typedoc.github.io/ts-lib-docs/2023/dom/">DOM</a>,
14+
<a href="https://typhonjs-typedoc.github.io/ts-lib-docs/2023/esm/">ES2023</a>, and
15+
<a href="https://typhonjs-typedoc.github.io/ts-lib-docs/2023/worker/">Web Worker</a> APIs. The DOM API docs also include the
1616
WebCodecs, WebGPU, and WebXR APIs.</p>
1717
<p>The docs are generated from the following sources:</p>
1818
<ul>
@@ -21,29 +21,29 @@ <h2>Typescript Library Declarations (ES2023)</h2></div>
2121
<li>@webgpu/types (0.1.32)</li>
2222
<li>@types/webxr (0.5.2)</li>
2323
</ul>
24-
<p>The <code>@mdn/browser-compat-data</code> (5.3.1) package is cross-linked against all symbols and a web component
24+
<p>The <code>@mdn/browser-compat-data</code> (5.3.1) package is cross-linked against all symbols and a web component
2525
provides links to MDN docs <em>and</em> relevant specifications embedded in the API docs provided.</p>
2626
<hr>
27-
<p>If you are using TypeDoc to generate documentation there are several plugins available to link all TS built-in lib
27+
<p>If you are using TypeDoc to generate documentation there are several plugins available to link all TS built-in lib
2828
symbols to the hosted TS Lib docs. You can find the NPM package here: <a href="https://www.npmjs.com/package/@typhonjs-typedoc/ts-lib-docs">@typhonjs-typedoc/ts-lib-docs</a> </p>
2929
<p>Include the following in your <code>devDependencies</code> in <code>package.json</code>:</p>
30-
<pre><code class="language-json"><span class="hl-0">{</span><br><span class="hl-0"> </span><span class="hl-1">"devDependencies"</span><span class="hl-0">: {</span><br><span class="hl-0"> </span><span class="hl-1">"@typhonjs-typedoc/ts-lib-docs"</span><span class="hl-0">: </span><span class="hl-2">"2023.7.10"</span><span class="hl-0">,</span><br><span class="hl-0"> </span><span class="hl-1">"@typhonjs-typedoc/typedoc-theme-dmt"</span><span class="hl-0">: </span><span class="hl-2">"^0.1.0"</span><span class="hl-0">,</span><br><span class="hl-0"> </span><span class="hl-1">"typedoc"</span><span class="hl-0">: </span><span class="hl-2">"^0.24.8"</span><br><span class="hl-0"> }</span><br><span class="hl-0">}</span>
30+
<pre><code class="language-json"><span class="hl-0">{</span><br><span class="hl-0"> </span><span class="hl-1">"devDependencies"</span><span class="hl-0">: {</span><br><span class="hl-0"> </span><span class="hl-1">"@typhonjs-typedoc/ts-lib-docs"</span><span class="hl-0">: </span><span class="hl-2">"2023.7.12"</span><span class="hl-0">,</span><br><span class="hl-0"> </span><span class="hl-1">"@typhonjs-typedoc/typedoc-theme-dmt"</span><span class="hl-0">: </span><span class="hl-2">"^0.1.0"</span><span class="hl-0">,</span><br><span class="hl-0"> </span><span class="hl-1">"typedoc"</span><span class="hl-0">: </span><span class="hl-2">"^0.24.8"</span><br><span class="hl-0"> }</span><br><span class="hl-0">}</span>
3131
</code><button>Copy</button></pre>
3232
<p>The date of generation <code>&lt;year&gt;.&lt;month&gt;.&lt;day&gt;</code> is used instead of normal SEMVER.</p>
3333
<p>Then in your TypeDoc configuration / JSON include:</p>
3434
<pre><code class="language-json"><span class="hl-0">{</span><br><span class="hl-0"> </span><span class="hl-1">"plugin"</span><span class="hl-0">: [ </span><br><span class="hl-0"> </span><span class="hl-2">"@typhonjs-typedoc/typedoc-theme-dmt"</span><span class="hl-0">,</span><br><span class="hl-0"> </span><span class="hl-2">"@typhonjs-typedoc/ts-lib-docs/typedoc/ts-links/dom/2023"</span><span class="hl-0">,</span><br><span class="hl-0"> </span><span class="hl-2">"@typhonjs-typedoc/ts-lib-docs/typedoc/ts-links/esm/2023"</span><br><span class="hl-0"> ]</span><br><span class="hl-0">}</span>
3535
</code><button>Copy</button></pre>
36-
<p>You should choose either the "dom" or "worker" <code>ts-lib-docs</code> plugin and not both. The "worker" plugin is omitted from
36+
<p>You should choose either the "dom" or "worker" <code>ts-lib-docs</code> plugin and not both. The "worker" plugin is omitted from
3737
the above example.</p>
3838
<hr>
39-
<p>A brand new Typedoc theme <a href="https://www.npmjs.com/package/@typhonjs-typedoc/typedoc-theme-dmt">@typhonjs-typedoc/typedoc-theme-dmt</a> /
40-
(Default Modern Theme) / theme augmentation is used to generate the TS Lib docs. The biggest feature is a massive
41-
reduction in disk space utilized upwards of 90% for large documentation projects like this one along with an 80% speed
39+
<p>A brand new Typedoc theme <a href="https://www.npmjs.com/package/@typhonjs-typedoc/typedoc-theme-dmt">@typhonjs-typedoc/typedoc-theme-dmt</a> /
40+
(Default Modern Theme) / theme augmentation is used to generate the TS Lib docs. The biggest feature is a massive
41+
reduction in disk space utilized upwards of 90% for large documentation projects like this one along with an 80% speed
4242
improvement when generating docs. The DMT theme is not necessary to link your TypeDoc doc generation. </p>
4343
<hr>
44-
<p>Please note that the TS Lib API docs are presently hosted through Github pages while a permanent hosting location is
44+
<p>Please note that the TS Lib API docs are presently hosted through Github pages while a permanent hosting location is
4545
found. IE if this gets popular GH bandwidth concerns may come into play.</p>
46-
<p>You may open an issue at <a href="https://github.com/typhonjs-typedoc/ts-lib-docs">ts-lib-docs</a> repository for discussion /
46+
<p>You may open an issue at <a href="https://github.com/typhonjs-typedoc/ts-lib-docs">ts-lib-docs</a> repository for discussion /
4747
feedback.</p>
4848
</div></div>
4949
<div class="col-sidebar">

‎docs/2023/worker/index.html‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@
1010
<div class="col-content">
1111
<div class="tsd-page-title">
1212
<h2>Typescript Library Declarations (Web Worker)</h2></div>
13-
<div class="tsd-panel tsd-typography"><p>Provides comprehensive API docs for the Typescript built-in libs covering the <a href="https://typhonjs-typedoc.github.io/ts-lib-docs/2023/dom/">DOM</a>,
14-
<a href="https://typhonjs-typedoc.github.io/ts-lib-docs/2023/esm/">ES2023</a>, and
15-
<a href="https://typhonjs-typedoc.github.io/ts-lib-docs/2023/worker/">Web Worker</a> APIs. The DOM API docs also include the
13+
<div class="tsd-panel tsd-typography"><p>Provides comprehensive API docs for the Typescript built-in libs covering the <a href="https://typhonjs-typedoc.github.io/ts-lib-docs/2023/dom/">DOM</a>,
14+
<a href="https://typhonjs-typedoc.github.io/ts-lib-docs/2023/esm/">ES2023</a>, and
15+
<a href="https://typhonjs-typedoc.github.io/ts-lib-docs/2023/worker/">Web Worker</a> APIs. The DOM API docs also include the
1616
WebCodecs, WebGPU, and WebXR APIs.</p>
1717
<p>The docs are generated from the following sources:</p>
1818
<ul>
@@ -21,29 +21,29 @@ <h2>Typescript Library Declarations (Web Worker)</h2></div>
2121
<li>@webgpu/types (0.1.32)</li>
2222
<li>@types/webxr (0.5.2)</li>
2323
</ul>
24-
<p>The <code>@mdn/browser-compat-data</code> (5.3.1) package is cross-linked against all symbols and a web component
24+
<p>The <code>@mdn/browser-compat-data</code> (5.3.1) package is cross-linked against all symbols and a web component
2525
provides links to MDN docs <em>and</em> relevant specifications embedded in the API docs provided.</p>
2626
<hr>
27-
<p>If you are using TypeDoc to generate documentation there are several plugins available to link all TS built-in lib
27+
<p>If you are using TypeDoc to generate documentation there are several plugins available to link all TS built-in lib
2828
symbols to the hosted TS Lib docs. You can find the NPM package here: <a href="https://www.npmjs.com/package/@typhonjs-typedoc/ts-lib-docs">@typhonjs-typedoc/ts-lib-docs</a> </p>
2929
<p>Include the following in your <code>devDependencies</code> in <code>package.json</code>:</p>
30-
<pre><code class="language-json"><span class="hl-0">{</span><br><span class="hl-0"> </span><span class="hl-1">"devDependencies"</span><span class="hl-0">: {</span><br><span class="hl-0"> </span><span class="hl-1">"@typhonjs-typedoc/ts-lib-docs"</span><span class="hl-0">: </span><span class="hl-2">"2023.7.10"</span><span class="hl-0">,</span><br><span class="hl-0"> </span><span class="hl-1">"@typhonjs-typedoc/typedoc-theme-dmt"</span><span class="hl-0">: </span><span class="hl-2">"^0.1.0"</span><span class="hl-0">,</span><br><span class="hl-0"> </span><span class="hl-1">"typedoc"</span><span class="hl-0">: </span><span class="hl-2">"^0.24.8"</span><br><span class="hl-0"> }</span><br><span class="hl-0">}</span>
30+
<pre><code class="language-json"><span class="hl-0">{</span><br><span class="hl-0"> </span><span class="hl-1">"devDependencies"</span><span class="hl-0">: {</span><br><span class="hl-0"> </span><span class="hl-1">"@typhonjs-typedoc/ts-lib-docs"</span><span class="hl-0">: </span><span class="hl-2">"2023.7.12"</span><span class="hl-0">,</span><br><span class="hl-0"> </span><span class="hl-1">"@typhonjs-typedoc/typedoc-theme-dmt"</span><span class="hl-0">: </span><span class="hl-2">"^0.1.0"</span><span class="hl-0">,</span><br><span class="hl-0"> </span><span class="hl-1">"typedoc"</span><span class="hl-0">: </span><span class="hl-2">"^0.24.8"</span><br><span class="hl-0"> }</span><br><span class="hl-0">}</span>
3131
</code><button>Copy</button></pre>
3232
<p>The date of generation <code>&lt;year&gt;.&lt;month&gt;.&lt;day&gt;</code> is used instead of normal SEMVER.</p>
3333
<p>Then in your TypeDoc configuration / JSON include:</p>
3434
<pre><code class="language-json"><span class="hl-0">{</span><br><span class="hl-0"> </span><span class="hl-1">"plugin"</span><span class="hl-0">: [ </span><br><span class="hl-0"> </span><span class="hl-2">"@typhonjs-typedoc/typedoc-theme-dmt"</span><span class="hl-0">,</span><br><span class="hl-0"> </span><span class="hl-2">"@typhonjs-typedoc/ts-lib-docs/typedoc/ts-links/dom/2023"</span><span class="hl-0">,</span><br><span class="hl-0"> </span><span class="hl-2">"@typhonjs-typedoc/ts-lib-docs/typedoc/ts-links/esm/2023"</span><br><span class="hl-0"> ]</span><br><span class="hl-0">}</span>
3535
</code><button>Copy</button></pre>
36-
<p>You should choose either the "dom" or "worker" <code>ts-lib-docs</code> plugin and not both. The "worker" plugin is omitted from
36+
<p>You should choose either the "dom" or "worker" <code>ts-lib-docs</code> plugin and not both. The "worker" plugin is omitted from
3737
the above example.</p>
3838
<hr>
39-
<p>A brand new Typedoc theme <a href="https://www.npmjs.com/package/@typhonjs-typedoc/typedoc-theme-dmt">@typhonjs-typedoc/typedoc-theme-dmt</a> /
40-
(Default Modern Theme) / theme augmentation is used to generate the TS Lib docs. The biggest feature is a massive
41-
reduction in disk space utilized upwards of 90% for large documentation projects like this one along with an 80% speed
39+
<p>A brand new Typedoc theme <a href="https://www.npmjs.com/package/@typhonjs-typedoc/typedoc-theme-dmt">@typhonjs-typedoc/typedoc-theme-dmt</a> /
40+
(Default Modern Theme) / theme augmentation is used to generate the TS Lib docs. The biggest feature is a massive
41+
reduction in disk space utilized upwards of 90% for large documentation projects like this one along with an 80% speed
4242
improvement when generating docs. The DMT theme is not necessary to link your TypeDoc doc generation. </p>
4343
<hr>
44-
<p>Please note that the TS Lib API docs are presently hosted through Github pages while a permanent hosting location is
44+
<p>Please note that the TS Lib API docs are presently hosted through Github pages while a permanent hosting location is
4545
found. IE if this gets popular GH bandwidth concerns may come into play.</p>
46-
<p>You may open an issue at <a href="https://github.com/typhonjs-typedoc/ts-lib-docs">ts-lib-docs</a> repository for discussion /
46+
<p>You may open an issue at <a href="https://github.com/typhonjs-typedoc/ts-lib-docs">ts-lib-docs</a> repository for discussion /
4747
feedback.</p>
4848
</div></div>
4949
<div class="col-sidebar">

0 commit comments

Comments
 (0)