diff --git a/src/generate/generate.js b/src/generate/generate.js index b782b371..b9315e5f 100644 --- a/src/generate/generate.js +++ b/src/generate/generate.js @@ -2,7 +2,7 @@ import { processDTS } from './processDTS.js'; import { typedoc } from './typedoc/typedoc.js'; // Process the TRL runtime & standard libraries along with the Svelte library moving DTS files to `.doc-gen`. -// processDTS(); +processDTS(); // Generate TypeDoc documentation from `.doc-gen`. await typedoc(); \ No newline at end of file diff --git a/src/generate/typedoc/typedoc.js b/src/generate/typedoc/typedoc.js index 75b726af..2206fba5 100644 --- a/src/generate/typedoc/typedoc.js +++ b/src/generate/typedoc/typedoc.js @@ -32,11 +32,13 @@ export async function typedoc(logLevel = LogLevel.Verbose) dmtFavicon: './assets/icons/favicon.ico', // Replaces 'Module' for 'Package'. - dmtModuleAsPackage: true, + dmtModuleRemap: { + isPackage: true + }, // Add service icon links in toolbar. dmtLinksService: { - "Discord": "https://discord.gg/mnbgN8f", + "Discord": "https://typhonjs.io/discord/", "GitHub": "https://github.com/typhonjs-fvtt-lib/typhonjs", "NPM": "https://www.npmjs.com/package/@typhonjs-fvtt/runtime" }, @@ -44,6 +46,9 @@ export async function typedoc(logLevel = LogLevel.Verbose) entryPoints, entryPointStrategy: 'expand', + // Excludes any @internal marked symbols. + excludeInternal: true, + // Excludes any private members including the `#private;` member added by Typescript. excludePrivate: true, @@ -80,9 +85,10 @@ export async function typedoc(logLevel = LogLevel.Verbose) theme: 'default-modern', - // Only show the `inherited` filter. + // Only show the `inherited` & `protected` filters. visibilityFilters: { inherited: true, + protected: true } }, [new TSConfigReader()]);