2023.7.10 release

Author: typhonrt

docs/2023/dom/index.html

@@ -25,10 +25,11 @@ <h2>Typescript Library Declarations (DOM)</h2></div>
 provides links to MDN docs <em>and</em> relevant specifications embedded in the API docs provided.</p>
 <hr>
 <p>If you are using TypeDoc to generate documentation there are several plugins available to link all TS built-in lib 
-symbols to the hosted TS Lib docs. </p>
-<p>Include the following in your <code>dependencies</code> in <code>package.json</code>:</p>
-<pre><code class="language-json"><span class="hl-0">{</span><br><span class="hl-0">   </span><span class="hl-1">"dependencies"</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">"0.1.0"</span><br><span class="hl-0">   }</span><br><span class="hl-0">}</span>
+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>
+<p>Include the following in your <code>devDependencies</code> in <code>package.json</code>:</p>
+<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>
 </code><button>Copy</button></pre>
+<p>The date of generation <code>&lt;year&gt;.&lt;month&gt;.&lt;day&gt;</code> is used instead of normal SEMVER.</p>
 <p>Then in your TypeDoc configuration / JSON include:</p>
 <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>
 </code><button>Copy</button></pre>
@@ -38,10 +39,10 @@ <h2>Typescript Library Declarations (DOM)</h2></div>
 <p>A brand new Typedoc theme <a href="https://www.npmjs.com/package/@typhonjs-typedoc/typedoc-theme-dmt">@typhonjs-typedoc/typedoc-theme-dmt</a> / 
 (Default Modern Theme) / theme augmentation is used to generate the TS Lib docs. The biggest feature is a massive 
 reduction in disk space utilized upwards of 90% for large documentation projects like this one along with an 80% speed 
-improvement when generating docs. </p>
+improvement when generating docs. The DMT theme is not necessary to link your TypeDoc doc generation. </p>
 <hr>
-<p>Please note that these API docs are presently hosted through Github pages while a permanent hosting location is found. 
-IE if this gets popular GH bandwidth concerns may come into play.</p>
+<p>Please note that the TS Lib API docs are presently hosted through Github pages while a permanent hosting location is 
+found. IE if this gets popular GH bandwidth concerns may come into play.</p>
 <p>You may open an issue at <a href="https://github.com/typhonjs-typedoc/ts-lib-docs">ts-lib-docs</a> repository for discussion / 
 feedback.</p>
 </div></div>

docs/2023/esm/index.html

@@ -25,10 +25,11 @@ <h2>Typescript Library Declarations (ES2023)</h2></div>
 provides links to MDN docs <em>and</em> relevant specifications embedded in the API docs provided.</p>
 <hr>
 <p>If you are using TypeDoc to generate documentation there are several plugins available to link all TS built-in lib 
-symbols to the hosted TS Lib docs. </p>
-<p>Include the following in your <code>dependencies</code> in <code>package.json</code>:</p>
-<pre><code class="language-json"><span class="hl-0">{</span><br><span class="hl-0">   </span><span class="hl-1">"dependencies"</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">"0.1.0"</span><br><span class="hl-0">   }</span><br><span class="hl-0">}</span>
+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>
+<p>Include the following in your <code>devDependencies</code> in <code>package.json</code>:</p>
+<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>
 </code><button>Copy</button></pre>
+<p>The date of generation <code>&lt;year&gt;.&lt;month&gt;.&lt;day&gt;</code> is used instead of normal SEMVER.</p>
 <p>Then in your TypeDoc configuration / JSON include:</p>
 <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>
 </code><button>Copy</button></pre>
@@ -38,10 +39,10 @@ <h2>Typescript Library Declarations (ES2023)</h2></div>
 <p>A brand new Typedoc theme <a href="https://www.npmjs.com/package/@typhonjs-typedoc/typedoc-theme-dmt">@typhonjs-typedoc/typedoc-theme-dmt</a> / 
 (Default Modern Theme) / theme augmentation is used to generate the TS Lib docs. The biggest feature is a massive 
 reduction in disk space utilized upwards of 90% for large documentation projects like this one along with an 80% speed 
-improvement when generating docs. </p>
+improvement when generating docs. The DMT theme is not necessary to link your TypeDoc doc generation. </p>
 <hr>
-<p>Please note that these API docs are presently hosted through Github pages while a permanent hosting location is found. 
-IE if this gets popular GH bandwidth concerns may come into play.</p>
+<p>Please note that the TS Lib API docs are presently hosted through Github pages while a permanent hosting location is 
+found. IE if this gets popular GH bandwidth concerns may come into play.</p>
 <p>You may open an issue at <a href="https://github.com/typhonjs-typedoc/ts-lib-docs">ts-lib-docs</a> repository for discussion / 
 feedback.</p>
 </div></div>

docs/2023/worker/index.html

@@ -25,10 +25,11 @@ <h2>Typescript Library Declarations (Web Worker)</h2></div>
 provides links to MDN docs <em>and</em> relevant specifications embedded in the API docs provided.</p>
 <hr>
 <p>If you are using TypeDoc to generate documentation there are several plugins available to link all TS built-in lib 
-symbols to the hosted TS Lib docs. </p>
-<p>Include the following in your <code>dependencies</code> in <code>package.json</code>:</p>
-<pre><code class="language-json"><span class="hl-0">{</span><br><span class="hl-0">   </span><span class="hl-1">"dependencies"</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">"0.1.0"</span><br><span class="hl-0">   }</span><br><span class="hl-0">}</span>
+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>
+<p>Include the following in your <code>devDependencies</code> in <code>package.json</code>:</p>
+<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>
 </code><button>Copy</button></pre>
+<p>The date of generation <code>&lt;year&gt;.&lt;month&gt;.&lt;day&gt;</code> is used instead of normal SEMVER.</p>
 <p>Then in your TypeDoc configuration / JSON include:</p>
 <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>
 </code><button>Copy</button></pre>
@@ -38,10 +39,10 @@ <h2>Typescript Library Declarations (Web Worker)</h2></div>
 <p>A brand new Typedoc theme <a href="https://www.npmjs.com/package/@typhonjs-typedoc/typedoc-theme-dmt">@typhonjs-typedoc/typedoc-theme-dmt</a> / 
 (Default Modern Theme) / theme augmentation is used to generate the TS Lib docs. The biggest feature is a massive 
 reduction in disk space utilized upwards of 90% for large documentation projects like this one along with an 80% speed 
-improvement when generating docs. </p>
+improvement when generating docs. The DMT theme is not necessary to link your TypeDoc doc generation. </p>
 <hr>
-<p>Please note that these API docs are presently hosted through Github pages while a permanent hosting location is found. 
-IE if this gets popular GH bandwidth concerns may come into play.</p>
+<p>Please note that the TS Lib API docs are presently hosted through Github pages while a permanent hosting location is 
+found. IE if this gets popular GH bandwidth concerns may come into play.</p>
 <p>You may open an issue at <a href="https://github.com/typhonjs-typedoc/ts-lib-docs">ts-lib-docs</a> repository for discussion / 
 feedback.</p>
 </div></div>

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@typhonjs-typedoc/ts-lib-docs",
-  "version": "2023.0.0",
+  "version": "2023.7.10",
   "description": "Provides generated documentation for built-in Typescript lib declarations and a TypeDoc plugin to link symbols to the published docs.",
   "license": "MPL-2.0",
   "type": "module",