typedoc 0.24.7 → 0.24.8

package/dist/lib/application.d.ts

@@ -77,6 +77,15 @@ export declare class Application extends ChildableComponent<Application, Abstrac
     bootstrapWithPlugins(options?: Partial<TypeDocOptions>): Promise<void>;
     /**
      * Initialize TypeDoc without loading plugins.
+     *
+     * @example
+     * Initialize the application with pretty-printing output disabled.
+     * ```ts
+     * const app = new Application();
+     * app.bootstrap({ pretty: false });
+     * ```
+     *
+     * @param options - Options to set during initialization
      */
     bootstrap(options?: Partial<TypeDocOptions>): void;
     private setOptions;

package/dist/lib/application.js

@@ -72,7 +72,7 @@ const supportedVersionMajorMinor = packageInfo.peerDependencies.typescript
  * Both the {@link Converter} and the {@link Renderer} emit a series of events while processing the project.
  * Subscribe to these Events to control the application flow or alter the output.
  */
-let Application = Application_1 = class Application extends component_1.ChildableComponent {
+let Application = exports.Application = Application_1 = class Application extends component_1.ChildableComponent {
     /**
      * Create a new TypeDoc application instance.
      */
@@ -104,6 +104,15 @@ let Application = Application_1 = class Application extends component_1.Childabl
     }
     /**
      * Initialize TypeDoc without loading plugins.
+     *
+     * @example
+     * Initialize the application with pretty-printing output disabled.
+     * ```ts
+     * const app = new Application();
+     * app.bootstrap({ pretty: false });
+     * ```
+     *
+     * @param options - Options to set during initialization
      */
     bootstrap(options = {}) {
         this.options.reset();
@@ -438,7 +447,6 @@ __decorate([
 __decorate([
     (0, utils_1.BindOption)("entryPoints")
 ], Application.prototype, "entryPoints", void 0);
-Application = Application_1 = __decorate([
+exports.Application = Application = Application_1 = __decorate([
     (0, component_1.Component)({ name: "application", internal: true })
 ], Application);
-exports.Application = Application;

package/dist/lib/converter/comments/lexer.js

@@ -10,4 +10,4 @@ var TokenSyntaxKind;
     TokenSyntaxKind["Tag"] = "tag";
     TokenSyntaxKind["Code"] = "code";
     TokenSyntaxKind["TypeAnnotation"] = "type";
-})(TokenSyntaxKind = exports.TokenSyntaxKind || (exports.TokenSyntaxKind = {}));
+})(TokenSyntaxKind || (exports.TokenSyntaxKind = TokenSyntaxKind = {}));

package/dist/lib/converter/converter.js

@@ -28,7 +28,7 @@ const linkResolver_1 = require("./comments/linkResolver");
 /**
  * Compiles source files using TypeScript and converts compiler symbols to reflections.
  */
-let Converter = Converter_1 = class Converter extends component_1.ChildableComponent {
+let Converter = exports.Converter = Converter_1 = class Converter extends component_1.ChildableComponent {
     get config() {
         return this._config || this._buildCommentParserConfig();
     }
@@ -343,14 +343,13 @@ __decorate([
 __decorate([
     (0, utils_1.BindOption)("useTsLinkResolution")
 ], Converter.prototype, "useTsLinkResolution", void 0);
-Converter = Converter_1 = __decorate([
+exports.Converter = Converter = Converter_1 = __decorate([
     (0, component_1.Component)({
         name: "converter",
         internal: true,
         childClass: components_1.ConverterComponent,
     })
 ], Converter);
-exports.Converter = Converter;
 function getSymbolForModuleLike(context, node) {
     const symbol = context.checker.getSymbolAtLocation(node) ?? node.symbol;
     if (symbol) {

package/dist/lib/converter/plugins/CategoryPlugin.js

@@ -18,7 +18,7 @@ const utils_1 = require("../../utils");
  *
  * The handler sets the ´category´ property of all reflections.
  */
-let CategoryPlugin = CategoryPlugin_1 = class CategoryPlugin extends components_1.ConverterComponent {
+let CategoryPlugin = exports.CategoryPlugin = CategoryPlugin_1 = class CategoryPlugin extends components_1.ConverterComponent {
     constructor() {
         super(...arguments);
         this.usedBoosts = new Set();
@@ -232,7 +232,6 @@ __decorate([
 __decorate([
     (0, utils_1.BindOption)("searchCategoryBoosts")
 ], CategoryPlugin.prototype, "boosts", void 0);
-CategoryPlugin = CategoryPlugin_1 = __decorate([
+exports.CategoryPlugin = CategoryPlugin = CategoryPlugin_1 = __decorate([
     (0, components_1.Component)({ name: "category" })
 ], CategoryPlugin);
-exports.CategoryPlugin = CategoryPlugin;

package/dist/lib/converter/plugins/CommentPlugin.js

@@ -88,7 +88,7 @@ const NEVER_RENDERED = [
  * - Resolve `@link` tags to point to target reflections
  *
  */
-let CommentPlugin = class CommentPlugin extends components_1.ConverterComponent {
+let CommentPlugin = exports.CommentPlugin = class CommentPlugin extends components_1.ConverterComponent {
     get excludeNotDocumentedKinds() {
         this._excludeKinds ?? (this._excludeKinds = this.application.options
             .getValue("excludeNotDocumentedKinds")
@@ -289,11 +289,15 @@ let CommentPlugin = class CommentPlugin extends components_1.ConverterComponent
         if (!signatures.length) {
             return;
         }
-        const comment = reflection.comment;
+        const comment = reflection.kindOf(models_1.ReflectionKind.ClassOrInterface)
+            ? undefined
+            : reflection.comment;
         // Since this reflection has signatures, remove the comment from the parent
         // reflection. This is important so that in type aliases we don't end up with
         // a comment rendered twice.
-        delete reflection.comment;
+        if (!reflection.kindOf(models_1.ReflectionKind.ClassOrInterface)) {
+            delete reflection.comment;
+        }
         for (const signature of signatures) {
             const childComment = (signature.comment || (signature.comment = comment?.clone()));
             if (!childComment)
@@ -414,10 +418,9 @@ __decorate([
 __decorate([
     (0, utils_1.BindOption)("excludeNotDocumented")
 ], CommentPlugin.prototype, "excludeNotDocumented", void 0);
-CommentPlugin = __decorate([
+exports.CommentPlugin = CommentPlugin = __decorate([
     (0, components_1.Component)({ name: "comment" })
 ], CommentPlugin);
-exports.CommentPlugin = CommentPlugin;
 function inTypeLiteral(refl) {
     while (refl) {
         if (refl.kind === models_1.ReflectionKind.TypeLiteral) {

package/dist/lib/converter/plugins/GroupPlugin.js

@@ -20,7 +20,7 @@ const models_1 = require("../../models");
  *
  * The handler sets the `groups` property of all container reflections.
  */
-let GroupPlugin = GroupPlugin_1 = class GroupPlugin extends components_1.ConverterComponent {
+let GroupPlugin = exports.GroupPlugin = GroupPlugin_1 = class GroupPlugin extends components_1.ConverterComponent {
     constructor() {
         super(...arguments);
         this.usedBoosts = new Set();
@@ -170,7 +170,6 @@ __decorate([
 __decorate([
     (0, utils_1.BindOption)("groupOrder")
 ], GroupPlugin.prototype, "groupOrder", void 0);
-GroupPlugin = GroupPlugin_1 = __decorate([
+exports.GroupPlugin = GroupPlugin = GroupPlugin_1 = __decorate([
     (0, components_1.Component)({ name: "group" })
 ], GroupPlugin);
-exports.GroupPlugin = GroupPlugin;

package/dist/lib/converter/plugins/ImplementsPlugin.js

@@ -22,7 +22,7 @@ const utils_1 = require("../../utils");
  * A plugin that detects interface implementations of functions and
  * properties on classes and links them.
  */
-let ImplementsPlugin = class ImplementsPlugin extends components_1.ConverterComponent {
+let ImplementsPlugin = exports.ImplementsPlugin = class ImplementsPlugin extends components_1.ConverterComponent {
     constructor() {
         super(...arguments);
         this.resolved = new WeakSet();
@@ -224,10 +224,9 @@ let ImplementsPlugin = class ImplementsPlugin extends components_1.ConverterComp
         }
     }
 };
-ImplementsPlugin = __decorate([
+exports.ImplementsPlugin = ImplementsPlugin = __decorate([
     (0, components_1.Component)({ name: "implements" })
 ], ImplementsPlugin);
-exports.ImplementsPlugin = ImplementsPlugin;
 function constructorInheritance(context, reflection, childDecl, constructorDecl) {
     const extendsClause = childDecl.heritageClauses?.find((cl) => cl.token === typescript_1.default.SyntaxKind.ExtendsKeyword);
     if (!extendsClause)

package/dist/lib/converter/plugins/InheritDocPlugin.js

@@ -28,7 +28,7 @@ const application_events_1 = require("../../application-events");
  * - `@typeParam` block
  * - `@return` block
  */
-let InheritDocPlugin = class InheritDocPlugin extends components_1.ConverterComponent {
+let InheritDocPlugin = exports.InheritDocPlugin = class InheritDocPlugin extends components_1.ConverterComponent {
     constructor() {
         super(...arguments);
         // Key is depended on by Values
@@ -159,10 +159,9 @@ let InheritDocPlugin = class InheritDocPlugin extends components_1.ConverterComp
         }
     }
 };
-InheritDocPlugin = __decorate([
+exports.InheritDocPlugin = InheritDocPlugin = __decorate([
     (0, components_1.Component)({ name: "inheritDoc" })
 ], InheritDocPlugin);
-exports.InheritDocPlugin = InheritDocPlugin;
 function copySummaries(source, target) {
     for (const [s, t] of (0, array_1.zip)(source || [], target || [])) {
         t.comment = new models_1.Comment(s.comment?.summary);

package/dist/lib/converter/plugins/LinkResolverPlugin.js

@@ -16,7 +16,7 @@ const application_events_1 = require("../../application-events");
 /**
  * A plugin that resolves `{@link Foo}` tags.
  */
-let LinkResolverPlugin = class LinkResolverPlugin extends components_1.ConverterComponent {
+let LinkResolverPlugin = exports.LinkResolverPlugin = class LinkResolverPlugin extends components_1.ConverterComponent {
     initialize() {
         super.initialize();
         this.owner.on(converter_events_1.ConverterEvents.RESOLVE_END, this.onResolve, this, -300);
@@ -56,7 +56,6 @@ let LinkResolverPlugin = class LinkResolverPlugin extends components_1.Converter
 __decorate([
     (0, utils_1.BindOption)("validation")
 ], LinkResolverPlugin.prototype, "validation", void 0);
-LinkResolverPlugin = __decorate([
+exports.LinkResolverPlugin = LinkResolverPlugin = __decorate([
     (0, components_1.Component)({ name: "link-resolver" })
 ], LinkResolverPlugin);
-exports.LinkResolverPlugin = LinkResolverPlugin;

package/dist/lib/converter/plugins/PackagePlugin.js

@@ -43,7 +43,7 @@ const path_1 = require("path");
  * A handler that tries to find the package.json and readme.md files of the
  * current project.
  */
-let PackagePlugin = class PackagePlugin extends components_1.ConverterComponent {
+let PackagePlugin = exports.PackagePlugin = class PackagePlugin extends components_1.ConverterComponent {
     initialize() {
         this.listenTo(this.owner, {
             [converter_1.Converter.EVENT_BEGIN]: this.onBegin,
@@ -141,7 +141,6 @@ __decorate([
 __decorate([
     (0, utils_1.BindOption)("includeVersion")
 ], PackagePlugin.prototype, "includeVersion", void 0);
-PackagePlugin = __decorate([
+exports.PackagePlugin = PackagePlugin = __decorate([
     (0, components_1.Component)({ name: "package" })
 ], PackagePlugin);
-exports.PackagePlugin = PackagePlugin;

package/dist/lib/converter/plugins/SourcePlugin.js

@@ -23,7 +23,7 @@ const base_path_1 = require("../utils/base-path");
 /**
  * A handler that attaches source file information to reflections.
  */
-let SourcePlugin = class SourcePlugin extends components_1.ConverterComponent {
+let SourcePlugin = exports.SourcePlugin = class SourcePlugin extends components_1.ConverterComponent {
     constructor() {
         super(...arguments);
         /**
@@ -163,7 +163,6 @@ __decorate([
 __decorate([
     (0, utils_1.BindOption)("basePath")
 ], SourcePlugin.prototype, "basePath", void 0);
-SourcePlugin = __decorate([
+exports.SourcePlugin = SourcePlugin = __decorate([
     (0, components_1.Component)({ name: "source" })
 ], SourcePlugin);
-exports.SourcePlugin = SourcePlugin;

package/dist/lib/converter/plugins/TypePlugin.js

@@ -15,7 +15,7 @@ const application_events_1 = require("../../application-events");
 /**
  * Responsible for adding `implementedBy` / `implementedFrom`
  */
-let TypePlugin = class TypePlugin extends components_1.ConverterComponent {
+let TypePlugin = exports.TypePlugin = class TypePlugin extends components_1.ConverterComponent {
     constructor() {
         super(...arguments);
         this.reflections = new Set();
@@ -121,7 +121,6 @@ let TypePlugin = class TypePlugin extends components_1.ConverterComponent {
         });
     }
 };
-TypePlugin = __decorate([
+exports.TypePlugin = TypePlugin = __decorate([
     (0, components_1.Component)({ name: "type" })
 ], TypePlugin);
-exports.TypePlugin = TypePlugin;

package/dist/lib/models/reflections/abstract.js

@@ -34,7 +34,7 @@ var ReflectionFlag;
     ReflectionFlag[ReflectionFlag["Const"] = 1024] = "Const";
     ReflectionFlag[ReflectionFlag["Let"] = 2048] = "Let";
     ReflectionFlag[ReflectionFlag["Readonly"] = 4096] = "Readonly";
-})(ReflectionFlag = exports.ReflectionFlag || (exports.ReflectionFlag = {}));
+})(ReflectionFlag || (exports.ReflectionFlag = ReflectionFlag = {}));
 const relevantFlags = [
     ReflectionFlag.Private,
     ReflectionFlag.Protected,
@@ -170,6 +170,7 @@ class ReflectionFlags extends Array {
         }
     }
 }
+exports.ReflectionFlags = ReflectionFlags;
 ReflectionFlags.serializedFlags = [
     "isPrivate",
     "isProtected",
@@ -183,7 +184,6 @@ ReflectionFlags.serializedFlags = [
     "isConst",
     "isReadonly",
 ];
-exports.ReflectionFlags = ReflectionFlags;
 var TraverseProperty;
 (function (TraverseProperty) {
     TraverseProperty[TraverseProperty["Children"] = 0] = "Children";
@@ -194,7 +194,7 @@ var TraverseProperty;
     TraverseProperty[TraverseProperty["IndexSignature"] = 5] = "IndexSignature";
     TraverseProperty[TraverseProperty["GetSignature"] = 6] = "GetSignature";
     TraverseProperty[TraverseProperty["SetSignature"] = 7] = "SetSignature";
-})(TraverseProperty = exports.TraverseProperty || (exports.TraverseProperty = {}));
+})(TraverseProperty || (exports.TraverseProperty = TraverseProperty = {}));
 /**
  * Base class for all reflection classes.
  *

package/dist/lib/models/reflections/declaration.js

@@ -15,7 +15,7 @@ var ConversionFlags;
 (function (ConversionFlags) {
     ConversionFlags[ConversionFlags["None"] = 0] = "None";
     ConversionFlags[ConversionFlags["VariableOrPropertySource"] = 1] = "VariableOrPropertySource";
-})(ConversionFlags = exports.ConversionFlags || (exports.ConversionFlags = {}));
+})(ConversionFlags || (exports.ConversionFlags = ConversionFlags = {}));
 /**
  * A reflection that represents a single declaration emitted by the TypeScript compiler.
  *

package/dist/lib/models/reflections/kind.js

@@ -31,7 +31,7 @@ var ReflectionKind;
     ReflectionKind[ReflectionKind["ObjectLiteral"] = 2097152] = "ObjectLiteral";
     ReflectionKind[ReflectionKind["TypeAlias"] = 4194304] = "TypeAlias";
     ReflectionKind[ReflectionKind["Reference"] = 8388608] = "Reference";
-})(ReflectionKind = exports.ReflectionKind || (exports.ReflectionKind = {}));
+})(ReflectionKind || (exports.ReflectionKind = ReflectionKind = {}));
 (function (ReflectionKind) {
     ReflectionKind.All = ReflectionKind.Reference * 2 - 1;
     /** @internal */
@@ -129,7 +129,7 @@ var ReflectionKind;
             .toLowerCase()}`;
     }
     ReflectionKind.classString = classString;
-})(ReflectionKind = exports.ReflectionKind || (exports.ReflectionKind = {}));
+})(ReflectionKind || (exports.ReflectionKind = ReflectionKind = {}));
 function getKindString(kind) {
     return ReflectionKind[kind].replace(/(.)([A-Z])/g, (_m, a, b) => a + " " + b.toLowerCase());
 }

package/dist/lib/output/events.d.ts

@@ -101,6 +101,7 @@ export declare class PageEvent<out Model = unknown> extends Event {
  * An event emitted when markdown is being parsed. Allows other plugins to manipulate the result.
  *
  * @see {@link MarkdownEvent.PARSE}
+ * @see {@link MarkdownEvent.INCLUDE}
  */
 export declare class MarkdownEvent extends Event {
     /**
@@ -120,6 +121,11 @@ export declare class MarkdownEvent extends Event {
      * @event
      */
     static readonly PARSE = "parseMarkdown";
+    /**
+     * Triggered on the renderer when this plugin includes a markdown file through a markdown include tag.
+     * @event
+     */
+    static readonly INCLUDE = "includeMarkdown";
     constructor(name: string, page: PageEvent, originalText: string, parsedText: string);
 }
 /**

package/dist/lib/output/events.js

@@ -54,6 +54,7 @@ class RendererEvent extends events_1.Event {
         return [mapping.template, event];
     }
 }
+exports.RendererEvent = RendererEvent;
 /**
  * Triggered before the renderer starts rendering a project.
  * @event
@@ -64,7 +65,6 @@ RendererEvent.BEGIN = "beginRender";
  * @event
  */
 RendererEvent.END = "endRender";
-exports.RendererEvent = RendererEvent;
 /**
  * An event emitted by the {@link Renderer} class before and after the
  * markup of a page is rendered.
@@ -83,6 +83,7 @@ class PageEvent extends events_1.Event {
         this.model = model;
     }
 }
+exports.PageEvent = PageEvent;
 /**
  * Triggered before a document will be rendered.
  * @event
@@ -93,11 +94,11 @@ PageEvent.BEGIN = "beginPage";
  * @event
  */
 PageEvent.END = "endPage";
-exports.PageEvent = PageEvent;
 /**
  * An event emitted when markdown is being parsed. Allows other plugins to manipulate the result.
  *
  * @see {@link MarkdownEvent.PARSE}
+ * @see {@link MarkdownEvent.INCLUDE}
  */
 class MarkdownEvent extends events_1.Event {
     constructor(name, page, originalText, parsedText) {
@@ -107,12 +108,17 @@ class MarkdownEvent extends events_1.Event {
         this.parsedText = parsedText;
     }
 }
+exports.MarkdownEvent = MarkdownEvent;
 /**
  * Triggered on the renderer when this plugin parses a markdown string.
  * @event
  */
 MarkdownEvent.PARSE = "parseMarkdown";
-exports.MarkdownEvent = MarkdownEvent;
+/**
+ * Triggered on the renderer when this plugin includes a markdown file through a markdown include tag.
+ * @event
+ */
+MarkdownEvent.INCLUDE = "includeMarkdown";
 /**
  * An event emitted when the search index is being prepared.
  */
@@ -144,9 +150,9 @@ class IndexEvent extends events_1.Event {
         this.searchFields = Array.from({ length: this.searchResults.length }, () => ({}));
     }
 }
+exports.IndexEvent = IndexEvent;
 /**
  * Triggered on the renderer when the search index is being prepared.
  * @event
  */
 IndexEvent.PREPARE_INDEX = "prepareIndex";
-exports.IndexEvent = IndexEvent;

package/dist/lib/output/plugins/AssetsPlugin.js

@@ -19,7 +19,7 @@ const path_1 = require("path");
  * A plugin that copies the subdirectory ´assets´ from the current themes
  * source folder to the output directory.
  */
-let AssetsPlugin = class AssetsPlugin extends components_1.RendererComponent {
+let AssetsPlugin = exports.AssetsPlugin = class AssetsPlugin extends components_1.RendererComponent {
     /**
      * Create a new AssetsPlugin instance.
      */
@@ -57,7 +57,6 @@ let AssetsPlugin = class AssetsPlugin extends components_1.RendererComponent {
 __decorate([
     (0, utils_1.BindOption)("customCss")
 ], AssetsPlugin.prototype, "customCss", void 0);
-AssetsPlugin = __decorate([
+exports.AssetsPlugin = AssetsPlugin = __decorate([
     (0, components_1.Component)({ name: "assets" })
 ], AssetsPlugin);
-exports.AssetsPlugin = AssetsPlugin;

package/dist/lib/output/plugins/JavascriptIndexPlugin.js

@@ -42,7 +42,7 @@ const DefaultTheme_1 = require("../themes/default/DefaultTheme");
  *
  * The resulting javascript file can be used to build a simple search function.
  */
-let JavascriptIndexPlugin = class JavascriptIndexPlugin extends components_1.RendererComponent {
+let JavascriptIndexPlugin = exports.JavascriptIndexPlugin = class JavascriptIndexPlugin extends components_1.RendererComponent {
     /**
      * Create a new JavascriptIndexPlugin instance.
      */
@@ -141,7 +141,6 @@ let JavascriptIndexPlugin = class JavascriptIndexPlugin extends components_1.Ren
 __decorate([
     (0, utils_1.BindOption)("searchInComments")
 ], JavascriptIndexPlugin.prototype, "searchComments", void 0);
-JavascriptIndexPlugin = __decorate([
+exports.JavascriptIndexPlugin = JavascriptIndexPlugin = __decorate([
     (0, components_1.Component)({ name: "javascript-index" })
 ], JavascriptIndexPlugin);
-exports.JavascriptIndexPlugin = JavascriptIndexPlugin;

package/dist/lib/output/renderer.d.ts

@@ -145,6 +145,8 @@ export declare class Renderer extends ChildableComponent<Application, RendererCo
     lightTheme: ShikiTheme;
     /** @internal */
     darkTheme: ShikiTheme;
+    /** @internal */
+    pretty: boolean;
     renderStartTime: number;
     /**
      * Define a new theme that can be used to render output.

package/dist/lib/output/renderer.js

@@ -82,7 +82,7 @@ const type_1 = require("./themes/default/partials/type");
  *    Triggered when the JavascriptIndexPlugin is preparing the search index. Listeners receive
  *    an instance of {@link IndexEvent}.
  */
-let Renderer = class Renderer extends component_1.ChildableComponent {
+let Renderer = exports.Renderer = class Renderer extends component_1.ChildableComponent {
     constructor() {
         super(...arguments);
         this.themes = new Map([
@@ -139,6 +139,7 @@ let Renderer = class Renderer extends component_1.ChildableComponent {
      * @param outputDirectory  The path of the directory the documentation should be rendered to.
      */
     async render(project, outputDirectory) {
+        (0, jsx_1.setRenderSettings)({ pretty: this.pretty });
         const momento = this.hooks.saveMomento();
         this.renderStartTime = Date.now();
         await (0, highlighter_1.loadHighlighter)(this.lightTheme, this.darkTheme);
@@ -296,10 +297,13 @@ __decorate([
 __decorate([
     (0, utils_1.BindOption)("darkHighlightTheme")
 ], Renderer.prototype, "darkTheme", void 0);
-Renderer = __decorate([
+__decorate([
+    (0, utils_1.BindOption)("pretty")
+], Renderer.prototype, "pretty", void 0);
+exports.Renderer = Renderer = __decorate([
     (0, component_1.Component)({ name: "renderer", internal: true, childClass: components_1.RendererComponent })
 ], Renderer);
-exports.Renderer = Renderer;
 // HACK: THIS HAS TO STAY DOWN HERE
 // if you try to move it up to the top of the file, then you'll run into stuff being used before it has been defined.
 require("./plugins");
+const jsx_1 = require("../utils/jsx");

package/dist/lib/output/theme.js

@@ -17,7 +17,7 @@ const component_1 = require("../utils/component");
  * and templates to use. Additionally themes can subscribe to the events emitted by
  * {@link Renderer} to control and manipulate the output process.
  */
-let Theme = class Theme extends components_1.RendererComponent {
+let Theme = exports.Theme = class Theme extends components_1.RendererComponent {
     /**
      * Create a new BaseTheme instance.
      *
@@ -27,7 +27,6 @@ let Theme = class Theme extends components_1.RendererComponent {
         super(renderer);
     }
 };
-Theme = __decorate([
+exports.Theme = Theme = __decorate([
     (0, component_1.Component)({ name: "theme", internal: true })
 ], Theme);
-exports.Theme = Theme;

package/dist/lib/output/themes/MarkedPlugin.js

@@ -42,7 +42,7 @@ const html_1 = require("../../utils/html");
  * Implements markdown and relativeURL helpers for templates.
  * @internal
  */
-let MarkedPlugin = class MarkedPlugin extends components_1.ContextAwareRendererComponent {
+let MarkedPlugin = exports.MarkedPlugin = class MarkedPlugin extends components_1.ContextAwareRendererComponent {
     constructor() {
         super(...arguments);
         /**
@@ -96,7 +96,9 @@ output file :
                 path = Path.join(this.includes, path.trim());
                 if ((0, utils_1.isFile)(path)) {
                     const contents = (0, utils_1.readFile)(path);
-                    return contents;
+                    const event = new events_1.MarkdownEvent(events_1.MarkdownEvent.INCLUDE, page, contents, contents);
+                    this.owner.trigger(event);
+                    return event.parsedText;
                 }
                 else {
                     this.application.logger.warn("Could not find file to include: " + path);
@@ -199,10 +201,9 @@ __decorate([
 __decorate([
     (0, utils_1.BindOption)("darkHighlightTheme")
 ], MarkedPlugin.prototype, "darkTheme", void 0);
-MarkedPlugin = __decorate([
+exports.MarkedPlugin = MarkedPlugin = __decorate([
     (0, components_1.Component)({ name: "marked" })
 ], MarkedPlugin);
-exports.MarkedPlugin = MarkedPlugin;
 // Basically a copy/paste of Marked's code, with the addition of the button
 // https://github.com/markedjs/marked/blob/v4.3.0/src/Renderer.js#L15-L39
 function renderCode(code, infostring, escaped) {

package/dist/lib/output/themes/default/DefaultTheme.js

@@ -190,8 +190,8 @@ class DefaultTheme extends theme_1.Theme {
         });
     }
 }
-DefaultTheme.URL_PREFIX = /^(http|ftp)s?:\/\//;
 exports.DefaultTheme = DefaultTheme;
+DefaultTheme.URL_PREFIX = /^(http|ftp)s?:\/\//;
 function hasReadme(readme) {
     return !readme.endsWith("none");
 }

package/dist/lib/output/themes/default/DefaultThemeRenderContext.d.ts

@@ -25,7 +25,10 @@ export declare class DefaultThemeRenderContext {
     defaultLayout: (template: import("../..").RenderTemplate<PageEvent<Reflection>>, props: PageEvent<Reflection>) => import("../../../utils/jsx.elements").JsxElement;
     analytics: () => import("../../../utils/jsx.elements").JsxElement | undefined;
     breadcrumb: (props: Reflection) => import("../../../utils/jsx.elements").JsxElement | undefined;
+    /** @deprecated will be removed in 0.25 */
     comment: (props: Reflection) => import("../../../utils/jsx.elements").JsxElement | undefined;
+    commentSummary: (props: Reflection) => import("../../../utils/jsx.elements").JsxElement | undefined;
+    commentTags: (props: Reflection) => import("../../../utils/jsx.elements").JsxElement | undefined;
     footer: () => import("../../../utils/jsx.elements").JsxElement | undefined;
     header: (props: PageEvent<Reflection>) => import("../../../utils/jsx.elements").JsxElement;
     hierarchy: (props: import("../../../models").DeclarationHierarchy | undefined) => import("../../../utils/jsx.elements").JsxElement | undefined;

package/dist/lib/output/themes/default/DefaultThemeRenderContext.js

@@ -69,7 +69,10 @@ class DefaultThemeRenderContext {
         this.defaultLayout = bind(default_1.defaultLayout, this);
         this.analytics = bind(analytics_1.analytics, this);
         this.breadcrumb = bind(breadcrumb_1.breadcrumb, this);
+        /** @deprecated will be removed in 0.25 */
         this.comment = bind(comment_1.comment, this);
+        this.commentSummary = bind(comment_1.commentSummary, this);
+        this.commentTags = bind(comment_1.commentTags, this);
         this.footer = bind(footer_1.footer, this);
         this.header = bind(header_1.header, this);
         this.hierarchy = bind(hierarchy_1.hierarchy, this);

package/dist/lib/output/themes/default/partials/comment.d.ts

@@ -2,3 +2,5 @@ import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext";
 import { JSX } from "../../../../utils";
 import { Reflection } from "../../../../models";
 export declare function comment({ markdown }: DefaultThemeRenderContext, props: Reflection): JSX.Element | undefined;
+export declare function commentSummary({ markdown }: DefaultThemeRenderContext, props: Reflection): JSX.Element | undefined;
+export declare function commentTags({ markdown }: DefaultThemeRenderContext, props: Reflection): JSX.Element | undefined;

package/dist/lib/output/themes/default/partials/comment.js

@@ -1,13 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.comment = void 0;
+exports.commentTags = exports.commentSummary = exports.comment = void 0;
 const utils_1 = require("../../../../utils");
 const models_1 = require("../../../../models");
 const lib_1 = require("../../lib");
+// Note: Comment modifiers are handled in `renderFlags`
 function comment({ markdown }, props) {
     if (!props.comment?.hasVisibleComponent())
         return;
-    // Note: Comment modifiers are handled in `renderFlags`
     const tags = props.kindOf(models_1.ReflectionKind.SomeSignature)
         ? props.comment.blockTags.filter((tag) => tag.tag !== "@returns")
         : props.comment.blockTags;
@@ -18,3 +18,21 @@ function comment({ markdown }, props) {
             utils_1.JSX.createElement(utils_1.Raw, { html: markdown(item.content) }))))));
 }
 exports.comment = comment;
+function commentSummary({ markdown }, props) {
+    if (!props.comment?.summary.some((part) => part.text))
+        return;
+    return (utils_1.JSX.createElement("div", { class: "tsd-comment tsd-typography" },
+        utils_1.JSX.createElement(utils_1.Raw, { html: markdown(props.comment.summary) })));
+}
+exports.commentSummary = commentSummary;
+function commentTags({ markdown }, props) {
+    if (!props.comment)
+        return;
+    const tags = props.kindOf(models_1.ReflectionKind.SomeSignature)
+        ? props.comment.blockTags.filter((tag) => tag.tag !== "@returns")
+        : props.comment.blockTags;
+    return (utils_1.JSX.createElement("div", { class: "tsd-comment tsd-typography" }, tags.map((item) => (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
+        utils_1.JSX.createElement("h4", null, (0, lib_1.camelToTitleCase)(item.tag.substring(1))),
+        utils_1.JSX.createElement(utils_1.Raw, { html: markdown(item.content) }))))));
+}
+exports.commentTags = commentTags;

package/dist/lib/output/themes/default/partials/icon.js

@@ -21,9 +21,9 @@ function cachedPart(key, svgPart) {
         },
     };
 }
-const kindIcon = (kind, letterPath, color, circular = false) => (utils_1.JSX.createElement("svg", { class: "tsd-kind-icon", width: "24", height: "24", viewBox: "0 0 24 24" },
-    cachedPart(`${kind}-path`, utils_1.JSX.createElement("rect", { fill: "var(--color-icon-background)", stroke: color, "stroke-width": "1.5", x: "1", y: "1", width: "22", height: "22", rx: circular ? "12" : "6" })),
-    cachedPart(`${kind}-text`, letterPath)));
+const kindIcon = (kind, letterPath, color, circular = false) => (utils_1.JSX.createElement("svg", { class: "tsd-kind-icon", viewBox: "0 0 24 24" }, cachedPart(`${kind}`, utils_1.JSX.createElement("g", null,
+    utils_1.JSX.createElement("rect", { fill: "var(--color-icon-background)", stroke: color, "stroke-width": "1.5", x: "1", y: "1", width: "22", height: "22", rx: circular ? "12" : "6" }),
+    letterPath))));
 exports.icons = {
     [models_1.ReflectionKind.Accessor]: () => kindIcon(models_1.ReflectionKind.Accessor, utils_1.JSX.createElement("path", { d: "M8.85 16L11.13 7.24H12.582L14.85 16H13.758L13.182 13.672H10.53L9.954 16H8.85ZM10.746 12.76H12.954L12.282 10.06C12.154 9.548 12.054 9.12 11.982 8.776C11.91 8.432 11.866 8.208 11.85 8.104C11.834 8.208 11.79 8.432 11.718 8.776C11.646 9.12 11.546 9.544 11.418 10.048L10.746 12.76Z", fill: "var(--color-text)" }), "#FF4D4D", true),
     [models_1.ReflectionKind.CallSignature]() {
@@ -74,8 +74,7 @@ exports.icons = {
         return this[models_1.ReflectionKind.TypeAlias]();
     },
     [models_1.ReflectionKind.Variable]: () => kindIcon(models_1.ReflectionKind.Variable, utils_1.JSX.createElement("path", { d: "M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z", fill: "var(--color-text)" }), "var(--color-ts-variable)"),
-    chevronDown: () => (utils_1.JSX.createElement("svg", { width: "20", height: "20", viewBox: "0 0 24 24", fill: "none" },
-        utils_1.JSX.createElement("path", { d: "M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z", fill: "var(--color-text)" }))),
+    chevronDown: () => (utils_1.JSX.createElement("svg", { width: "20", height: "20", viewBox: "0 0 24 24", fill: "none" }, cachedPart("chevronDown", utils_1.JSX.createElement("path", { d: "M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z", fill: "var(--color-text)" })))),
     chevronSmall: () => (utils_1.JSX.createElement("svg", { width: "16", height: "16", viewBox: "0 0 16 16", fill: "none" },
         utils_1.JSX.createElement("path", { d: "M1.5 5.50969L8 11.6609L14.5 5.50969L12.5466 3.66086L8 7.96494L3.45341 3.66086L1.5 5.50969Z", fill: "var(--color-text)" }))),
     checkbox: () => (utils_1.JSX.createElement("svg", { width: "32", height: "32", viewBox: "0 0 32 32", "aria-hidden": "true" },
@@ -84,8 +83,8 @@ exports.icons = {
     menu: () => (utils_1.JSX.createElement("svg", { width: "16", height: "16", viewBox: "0 0 16 16", fill: "none" }, ["3", "7", "11"].map((y) => (utils_1.JSX.createElement("rect", { x: "1", y: y, width: "14", height: "2", fill: "var(--color-text)" }))))),
     search: () => (utils_1.JSX.createElement("svg", { width: "16", height: "16", viewBox: "0 0 16 16", fill: "none" },
         utils_1.JSX.createElement("path", { d: "M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z", fill: "var(--color-text)" }))),
-    anchor: () => (utils_1.JSX.createElement("svg", { class: "icon icon-tabler icon-tabler-link", viewBox: "0 0 24 24", "stroke-width": "2", stroke: "currentColor", fill: "none", "stroke-linecap": "round", "stroke-linejoin": "round" },
-        cachedPart("anchor-a", utils_1.JSX.createElement("path", { stroke: "none", d: "M0 0h24v24H0z", fill: "none" })),
-        cachedPart("anchor-b", utils_1.JSX.createElement("path", { d: "M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" })),
-        cachedPart("anchor-c", utils_1.JSX.createElement("path", { d: "M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" })))),
+    anchor: () => (utils_1.JSX.createElement("svg", { viewBox: "0 0 24 24" }, cachedPart("anchor", utils_1.JSX.createElement("g", { "stroke-width": "2", stroke: "currentColor", fill: "none", "stroke-linecap": "round", "stroke-linejoin": "round" },
+        utils_1.JSX.createElement("path", { stroke: "none", d: "M0 0h24v24H0z", fill: "none" }),
+        utils_1.JSX.createElement("path", { d: "M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" }),
+        utils_1.JSX.createElement("path", { d: "M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" }))))),
 };

package/dist/lib/output/themes/default/partials/member.declaration.d.ts

@@ -1,4 +1,4 @@
-import { DeclarationReflection } from "../../../../models";
+import type { DeclarationReflection } from "../../../../models";
 import { JSX } from "../../../../utils";
 import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext";
-export declare const memberDeclaration: (context: DefaultThemeRenderContext, props: DeclarationReflection) => JSX.Element;
+export declare function memberDeclaration(context: DefaultThemeRenderContext, props: DeclarationReflection): JSX.Element;

package/dist/lib/output/themes/default/partials/member.declaration.js

@@ -1,27 +1,40 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.memberDeclaration = void 0;
-const models_1 = require("../../../../models");
 const utils_1 = require("../../../../utils");
 const lib_1 = require("../../lib");
-const memberDeclaration = (context, props) => (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
-    utils_1.JSX.createElement("div", { class: "tsd-signature" },
-        utils_1.JSX.createElement("span", { class: (0, lib_1.getKindClass)(props) }, (0, lib_1.wbr)(props.name)),
-        (0, lib_1.renderTypeParametersSignature)(context, props.typeParameters),
-        props.type && (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
-            utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" },
-                !!props.flags.isOptional && "?",
-                ":"),
-            " ",
-            context.type(props.type))),
-        !!props.defaultValue && (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
-            utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" },
-                " = ",
-                props.defaultValue)))),
-    context.comment(props),
-    (0, lib_1.hasTypeParameters)(props) && context.typeParameters(props.typeParameters),
-    props.type instanceof models_1.ReflectionType && (utils_1.JSX.createElement("div", { class: "tsd-type-declaration" },
-        utils_1.JSX.createElement("h4", null, "Type declaration"),
-        context.parameter(props.type.declaration))),
-    context.memberSources(props)));
+function memberDeclaration(context, props) {
+    function renderTypeDeclaration(type) {
+        return (utils_1.JSX.createElement("div", { class: "tsd-type-declaration" },
+            utils_1.JSX.createElement("h4", null, "Type declaration"),
+            context.parameter(type.declaration)));
+    }
+    const visitor = { reflection: renderTypeDeclaration };
+    return (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
+        utils_1.JSX.createElement("div", { class: "tsd-signature" },
+            utils_1.JSX.createElement("span", { class: (0, lib_1.getKindClass)(props) }, (0, lib_1.wbr)(props.name)),
+            (0, lib_1.renderTypeParametersSignature)(context, props.typeParameters),
+            props.type && (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
+                utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" },
+                    !!props.flags.isOptional && "?",
+                    ":"),
+                " ",
+                context.type(props.type))),
+            !!props.defaultValue && (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
+                utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" },
+                    " = ",
+                    props.defaultValue)))),
+        context.commentSummary(props),
+        (0, lib_1.hasTypeParameters)(props) && context.typeParameters(props.typeParameters),
+        props.type?.visit({
+            reflection: renderTypeDeclaration,
+            array: (arr) => arr.elementType.visit(visitor),
+            intersection: (int) => int.types.map((t) => t.visit(visitor)),
+            union: (union) => union.types.map((t) => t.visit(visitor)),
+            reference: (ref) => ref.typeArguments?.map((t) => t.visit(visitor)),
+            tuple: (ref) => ref.elements.map((t) => t.visit(visitor)),
+        }),
+        context.commentTags(props),
+        context.memberSources(props)));
+}
 exports.memberDeclaration = memberDeclaration;

package/dist/lib/output/themes/default/partials/member.signature.body.js

@@ -8,7 +8,7 @@ function memberSignatureBody(context, props, { hideSources = false } = {}) {
     const returnsTag = props.comment?.getTag("@returns");
     return (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
         (0, lib_1.renderFlags)(props.flags, props.comment),
-        context.comment(props),
+        context.commentSummary(props),
         (0, lib_1.hasTypeParameters)(props) && context.typeParameters(props.typeParameters),
         props.parameters && props.parameters.length > 0 && (utils_1.JSX.createElement("div", { class: "tsd-parameters" },
             utils_1.JSX.createElement("h4", { class: "tsd-parameters-title" }, "Parameters"),
@@ -22,7 +22,8 @@ function memberSignatureBody(context, props, { hideSources = false } = {}) {
                     item.defaultValue != null && (utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" },
                         " = ",
                         item.defaultValue))),
-                context.comment(item),
+                context.commentSummary(item),
+                context.commentTags(item),
                 item.type instanceof models_1.ReflectionType && context.parameter(item.type.declaration))))))),
         props.type && (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
             utils_1.JSX.createElement("h4", { class: "tsd-returns-title" },
@@ -30,6 +31,7 @@ function memberSignatureBody(context, props, { hideSources = false } = {}) {
                 context.type(props.type)),
             returnsTag && utils_1.JSX.createElement(utils_1.Raw, { html: context.markdown(returnsTag.content) }),
             props.type instanceof models_1.ReflectionType && context.parameter(props.type.declaration))),
+        context.commentTags(props),
         !hideSources && context.memberSources(props)));
 }
 exports.memberSignatureBody = memberSignatureBody;

package/dist/lib/output/themes/default/partials/navigation.js

@@ -91,9 +91,9 @@ function navigation(context, props) {
         createNavElement(props.project),
         utils_1.JSX.createElement("ul", { class: "tsd-small-nested-navigation" }, getNavigationElements(props.project, opts).map((c) => (utils_1.JSX.createElement("li", null, links(c, [])))))));
     function links(mod, parents) {
-        const nameClasses = (0, lib_1.classNames)({ deprecated: mod instanceof models_1.Reflection && mod.isDeprecated() }, !(mod instanceof models_1.Reflection) || mod.isProject() ? void 0 : context.getReflectionClasses(mod));
+        const nameClasses = (0, lib_1.classNames)({ deprecated: mod instanceof models_1.Reflection && mod.isDeprecated() }, mod instanceof models_1.DeclarationReflection ? context.getReflectionClasses(mod) : void 0);
         const children = getNavigationElements(mod, opts);
-        if (!children.length) {
+        if (!children.length || (!opts.fullTree && mod instanceof models_1.Reflection && !inPath(mod))) {
             return createNavElement(mod, nameClasses);
         }
         return (utils_1.JSX.createElement("details", { class: (0, lib_1.classNames)({ "tsd-index-accordion": true }, nameClasses), open: mod instanceof models_1.Reflection && inPath(mod), "data-key": mod instanceof models_1.Reflection ? mod.getFullName() : [...parents, mod.title].join("$") },

package/dist/lib/output/themes/default/partials/parameter.js

@@ -25,7 +25,8 @@ const parameter = (context, props) => (utils_1.JSX.createElement(utils_1.JSX.Fra
                         context.type(item.type)))),
                     utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "]: "),
                     context.type(props.indexSignature.type)),
-                context.comment(props.indexSignature),
+                context.commentSummary(props.indexSignature),
+                context.commentTags(props.indexSignature),
                 props.indexSignature.type instanceof models_1.ReflectionType &&
                     context.parameter(props.indexSignature.type.declaration)))),
         props.children?.map((item) => (utils_1.JSX.createElement(utils_1.JSX.Fragment, null, item.signatures ? (utils_1.JSX.createElement("li", { class: "tsd-parameter" },
@@ -46,7 +47,8 @@ const parameter = (context, props) => (utils_1.JSX.createElement(utils_1.JSX.Fra
                         !!item.flags.isOptional && "?",
                         ": "),
                     context.type(item.type)),
-                context.comment(item),
+                context.commentSummary(item),
+                context.commentTags(item),
                 !!item.children && context.parameter(item),
                 item.type instanceof models_1.ReflectionType && context.parameter(item.type.declaration)))) : (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
             item.getSignature && (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
@@ -57,7 +59,8 @@ const parameter = (context, props) => (utils_1.JSX.createElement(utils_1.JSX.Fra
                         utils_1.JSX.createElement("span", { class: (0, lib_1.getKindClass)(item) }, (0, lib_1.wbr)(item.name)),
                         utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "(): "),
                         context.type(item.getSignature.type)),
-                    context.comment(item.getSignature)))),
+                    context.commentSummary(item.getSignature),
+                    context.commentTags(item.getSignature)))),
             item.setSignature && (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
                 utils_1.JSX.createElement("li", { class: "tsd-parameter" },
                     utils_1.JSX.createElement("h5", null,
@@ -71,5 +74,6 @@ const parameter = (context, props) => (utils_1.JSX.createElement(utils_1.JSX.Fra
                             context.type(item.type)))),
                         utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "): "),
                         context.type(item.setSignature.type)),
-                    context.comment(item.setSignature))))))))))));
+                    context.commentSummary(item.setSignature),
+                    context.commentTags(item.setSignature))))))))))));
 exports.parameter = parameter;

package/dist/lib/output/themes/default/partials/typeParameters.js

@@ -17,6 +17,7 @@ function typeParameters(context, typeParameters) {
                     !!item.default && (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
                         " = ",
                         context.type(item.default)))),
-                context.comment(item))))))));
+                context.commentSummary(item),
+                context.commentTags(item))))))));
 }
 exports.typeParameters = typeParameters;

package/dist/lib/output/themes/default/templates/reflection.js

@@ -10,7 +10,9 @@ function reflectionTemplate(context, props) {
         return context.memberDeclaration(props.model);
     }
     return (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
-        props.model.hasComment() && (utils_1.JSX.createElement("section", { class: "tsd-panel tsd-comment" }, context.comment(props.model))),
+        props.model.hasComment() && (utils_1.JSX.createElement("section", { class: "tsd-panel tsd-comment" },
+            context.commentSummary(props.model),
+            context.commentTags(props.model))),
         props.model instanceof models_1.DeclarationReflection &&
             props.model.kind === models_1.ReflectionKind.Module &&
             props.model.readme?.length && (utils_1.JSX.createElement("section", { class: "tsd-panel tsd-typography" },
@@ -38,7 +40,8 @@ function reflectionTemplate(context, props) {
                         context.type(item.type)))),
                     utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "]: "),
                     context.type(props.model.indexSignature.type)),
-                context.comment(props.model.indexSignature),
+                context.commentSummary(props.model.indexSignature),
+                context.commentTags(props.model.indexSignature),
                 props.model.indexSignature?.type instanceof models_1.ReflectionType &&
                     context.parameter(props.model.indexSignature.type.declaration))),
             !props.model.signatures && context.memberSources(props.model))),

package/dist/lib/serialization/serializer.js

@@ -41,6 +41,7 @@ class Serializer extends utils_1.EventDispatcher {
         return project;
     }
 }
+exports.Serializer = Serializer;
 /**
  * Triggered when the {@link Serializer} begins transforming a project.
  * @event EVENT_BEGIN
@@ -51,4 +52,3 @@ Serializer.EVENT_BEGIN = "begin";
  * @event EVENT_END
  */
 Serializer.EVENT_END = "end";
-exports.Serializer = Serializer;

package/dist/lib/utils/component.d.ts

@@ -43,7 +43,7 @@ export declare abstract class AbstractComponent<O extends ComponentHost> extends
      */
     private _componentOwner;
     /**
-     * The name of this component as set by the @Component decorator.
+     * The name of this component as set by the `@Component` decorator.
      */
     componentName: string;
     /**

package/dist/lib/utils/component.js

@@ -49,9 +49,9 @@ class ComponentEvent extends events_1.Event {
         this.component = component;
     }
 }
+exports.ComponentEvent = ComponentEvent;
 ComponentEvent.ADDED = "componentAdded";
 ComponentEvent.REMOVED = "componentRemoved";
-exports.ComponentEvent = ComponentEvent;
 /**
  * Component base class.  Has an owner (unless it's the application root component),
  * can dispatch events to its children, and has access to the root Application component.

package/dist/lib/utils/jsx.d.ts

@@ -41,4 +41,7 @@ export declare namespace JSX {
  * @param children
  */
 export declare function createElement(tag: typeof Fragment | string | JsxComponent<any>, props: object | null, ...children: JsxChildren[]): JsxElement;
+export declare function setRenderSettings(options: {
+    pretty: boolean;
+}): void;
 export declare function renderElement(element: JsxElement | null | undefined): string;

package/dist/lib/utils/jsx.js

@@ -14,7 +14,7 @@
  * @module
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.renderElement = exports.createElement = exports.Raw = exports.Fragment = void 0;
+exports.renderElement = exports.setRenderSettings = exports.createElement = exports.Raw = exports.Fragment = void 0;
 const html_1 = require("./html");
 const jsx_elements_1 = require("./jsx.elements");
 var jsx_elements_2 = require("./jsx.elements");
@@ -71,6 +71,11 @@ function createElement(tag, props, ...children) {
     return { tag, props, children };
 }
 exports.createElement = createElement;
+let renderPretty = true;
+function setRenderSettings(options) {
+    renderPretty = options.pretty;
+}
+exports.setRenderSettings = setRenderSettings;
 function renderElement(element) {
     if (!element) {
         return "";
@@ -84,7 +89,7 @@ function renderElement(element) {
     }
     const html = [];
     if (tag !== jsx_elements_1.JsxFragment) {
-        if (blockElements.has(tag)) {
+        if (blockElements.has(tag) && renderPretty) {
             html.push("\n");
         }
         html.push("<", tag);

package/dist/lib/utils/loggers.js

@@ -19,7 +19,7 @@ var LogLevel;
     LogLevel[LogLevel["Warn"] = 2] = "Warn";
     LogLevel[LogLevel["Error"] = 3] = "Error";
     LogLevel[LogLevel["None"] = 4] = "None";
-})(LogLevel = exports.LogLevel || (exports.LogLevel = {}));
+})(LogLevel || (exports.LogLevel = LogLevel = {}));
 const Colors = {
     red: "\u001b[91m",
     yellow: "\u001b[93m",

package/dist/lib/utils/options/declaration.d.ts

@@ -103,6 +103,7 @@ export interface TypeDocOptionMap {
     navigation: {
         includeCategories: boolean;
         includeGroups: boolean;
+        fullTree: boolean;
     };
     visibilityFilters: ManuallyValidatedOption<{
         protected?: boolean;

package/dist/lib/utils/options/declaration.js

@@ -22,7 +22,7 @@ var ParameterHint;
 (function (ParameterHint) {
     ParameterHint[ParameterHint["File"] = 0] = "File";
     ParameterHint[ParameterHint["Directory"] = 1] = "Directory";
-})(ParameterHint = exports.ParameterHint || (exports.ParameterHint = {}));
+})(ParameterHint || (exports.ParameterHint = ParameterHint = {}));
 var ParameterType;
 (function (ParameterType) {
     ParameterType[ParameterType["String"] = 0] = "String";
@@ -55,7 +55,7 @@ var ParameterType;
      * An object with true/false flags
      */
     ParameterType[ParameterType["Flags"] = 11] = "Flags";
-})(ParameterType = exports.ParameterType || (exports.ParameterType = {}));
+})(ParameterType || (exports.ParameterType = ParameterType = {}));
 const converters = {
     [ParameterType.String](value, option) {
         const stringValue = value == null ? "" : String(value);

package/dist/lib/utils/options/sources/typedoc.js

@@ -414,6 +414,7 @@ function addTypeDocOptions(options) {
         defaults: {
             includeCategories: false,
             includeGroups: false,
+            fullTree: false,
         },
     });
     options.addDeclaration({

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "typedoc",
   "description": "Create api documentation for TypeScript projects.",
-  "version": "0.24.7",
+  "version": "0.24.8",
   "homepage": "https://typedoc.org",
   "exports": {
     ".": "./dist/index.js",
@@ -30,7 +30,7 @@
     "shiki": "^0.14.1"
   },
   "peerDependencies": {
-    "typescript": "4.6.x || 4.7.x || 4.8.x || 4.9.x || 5.0.x"
+    "typescript": "4.6.x || 4.7.x || 4.8.x || 4.9.x || 5.0.x || 5.1.x"
   },
   "devDependencies": {
     "@types/lunr": "^2.3.4",
@@ -47,7 +47,7 @@
     "prettier": "2.8.7",
     "puppeteer": "^13.5.2",
     "ts-node": "^10.9.1",
-    "typescript": "5.0.4"
+    "typescript": "5.1.3"
   },
   "files": [
     "/bin",