typedoc 0.23.5 → 0.23.8

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

@@ -168,7 +168,8 @@ function* lexBlockComment2(file, pos, end) {
                         lookahead++;
                     }
                 }
-                if (lookahead !== pos + 1) {
+                if (lookahead !== pos + 1 &&
+                    (lookahead === end || /\s/.test(file[lookahead]))) {
                     braceStartsType = true;
                     yield makeToken(lexer_1.TokenSyntaxKind.Tag, lookahead - pos);
                     break;

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

@@ -137,7 +137,8 @@ function* lexLineComments2(file, pos, end) {
                         lookahead++;
                     }
                 }
-                if (lookahead !== pos + 1) {
+                if (lookahead !== pos + 1 &&
+                    (lookahead === end || /\s/.test(file[lookahead]))) {
                     braceStartsType = true;
                     yield makeToken(lexer_1.TokenSyntaxKind.Tag, lookahead - pos);
                     break;

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

@@ -141,7 +141,8 @@ function* lexCommentString2(file) {
                         lookahead++;
                     }
                 }
-                if (lookahead !== pos + 1) {
+                if (lookahead !== pos + 1 &&
+                    (lookahead === end || /\s/.test(file[lookahead]))) {
                     braceStartsType = true;
                     yield makeToken(lexer_1.TokenSyntaxKind.Tag, lookahead - pos);
                     break;

package/dist/lib/converter/converter.d.ts

@@ -4,6 +4,7 @@ import { ProjectReflection, SomeType } from "../models/index";
 import { Context } from "./context";
 import { ConverterComponent } from "./components";
 import { ChildableComponent } from "../utils/component";
+import { MinimalSourceFile } from "../utils";
 import type { DocumentationEntryPoint } from "../utils/entry-point";
 import { CommentParserConfig } from "./comments";
 import type { CommentStyle } from "../utils/options/declaration";
@@ -51,7 +52,8 @@ export declare class Converter extends ChildableComponent<Application, Converter
     static readonly EVENT_CREATE_DECLARATION: "createDeclaration";
     /**
      * Triggered when the converter has created a signature reflection.
-     * The listener will be given {@link Context}, {@link SignatureReflection} | {@link ProjectReflection} and a `ts.Node?`
+     * The listener will be given {@link Context}, {@link SignatureReflection} | {@link ProjectReflection} and
+     * `ts.SignatureDeclaration | ts.IndexSignatureDeclaration | ts.JSDocSignature | undefined`
      * @event
      */
     static readonly EVENT_CREATE_SIGNATURE: "createSignature";
@@ -103,6 +105,10 @@ export declare class Converter extends ChildableComponent<Application, Converter
      * @internal
      */
     convertType(context: Context, node: ts.TypeNode | ts.Type | undefined): SomeType;
+    /**
+     * Parse the given file into a comment. Intended to be used with markdown files.
+     */
+    parseRawComment(file: MinimalSourceFile): import("../models/index").Comment;
     /**
      * Compile the files within the given context and convert the compiler symbols to reflections.
      *

package/dist/lib/converter/converter.js

@@ -20,6 +20,8 @@ const symbols_1 = require("./symbols");
 const paths_1 = require("../utils/paths");
 const enum_1 = require("../utils/enum");
 const comments_1 = require("./comments");
+const parser_1 = require("./comments/parser");
+const rawLexer_1 = require("./comments/rawLexer");
 /**
  * Compiles source files using TypeScript and converts compiler symbols to reflections.
  */
@@ -58,6 +60,12 @@ let Converter = Converter_1 = class Converter extends component_1.ChildableCompo
     convertType(context, node) {
         return (0, types_1.convertType)(context, node);
     }
+    /**
+     * Parse the given file into a comment. Intended to be used with markdown files.
+     */
+    parseRawComment(file) {
+        return (0, parser_1.parseComment)((0, rawLexer_1.lexCommentString)(file.text), this.config, file, this.application.logger);
+    }
     /**
      * Compile the files within the given context and convert the compiler symbols to reflections.
      *
@@ -73,7 +81,7 @@ let Converter = Converter_1 = class Converter extends component_1.ChildableCompo
         });
         entries.forEach((e) => {
             context.setActiveProgram(e.entryPoint.program);
-            e.context = this.convertExports(context, e.entryPoint.sourceFile, entries.length === 1, e.entryPoint.displayName);
+            e.context = this.convertExports(context, e.entryPoint, entries.length === 1);
         });
         for (const { entryPoint, context } of entries) {
             // active program is already set on context
@@ -84,7 +92,9 @@ let Converter = Converter_1 = class Converter extends component_1.ChildableCompo
         }
         context.setActiveProgram(undefined);
     }
-    convertExports(context, node, singleEntryPoint, entryName) {
+    convertExports(context, entryPoint, singleEntryPoint) {
+        const node = entryPoint.sourceFile;
+        const entryName = entryPoint.displayName;
         const symbol = getSymbolForModuleLike(context, node);
         let moduleContext;
         const allExports = getExports(context, node, symbol);
@@ -104,6 +114,19 @@ let Converter = Converter_1 = class Converter extends component_1.ChildableCompo
         }
         else {
             const reflection = context.createDeclarationReflection(index_1.ReflectionKind.Module, symbol, void 0, entryName);
+            if (entryPoint.readmeFile) {
+                const readme = (0, utils_1.readFile)(entryPoint.readmeFile);
+                const comment = this.parseRawComment(new utils_1.MinimalSourceFile(readme, entryPoint.readmeFile));
+                if (comment.blockTags.length || comment.modifierTags.size) {
+                    const ignored = [
+                        ...comment.blockTags.map((tag) => tag.tag),
+                        ...comment.modifierTags,
+                    ];
+                    context.logger.warn(`Block and modifier tags will be ignored within the readme:\n\t${ignored.join("\n\t")}`);
+                }
+                reflection.readme = comment.summary;
+            }
+            reflection.version = entryPoint.version;
             context.finalizeDeclarationReflection(reflection);
             moduleContext = context.withScope(reflection);
         }
@@ -189,7 +212,8 @@ Converter.EVENT_END = converter_events_1.ConverterEvents.END;
 Converter.EVENT_CREATE_DECLARATION = converter_events_1.ConverterEvents.CREATE_DECLARATION;
 /**
  * Triggered when the converter has created a signature reflection.
- * The listener will be given {@link Context}, {@link SignatureReflection} | {@link ProjectReflection} and a `ts.Node?`
+ * The listener will be given {@link Context}, {@link SignatureReflection} | {@link ProjectReflection} and
+ * `ts.SignatureDeclaration | ts.IndexSignatureDeclaration | ts.JSDocSignature | undefined`
  * @event
  */
 Converter.EVENT_CREATE_SIGNATURE = converter_events_1.ConverterEvents.CREATE_SIGNATURE;

package/dist/lib/converter/factories/signature.js

@@ -49,7 +49,7 @@ function createSignature(context, kind, signature, declaration) {
             context.scope.signatures.push(sigRef);
             break;
     }
-    context.trigger(converter_events_1.ConverterEvents.CREATE_SIGNATURE, sigRef);
+    context.trigger(converter_events_1.ConverterEvents.CREATE_SIGNATURE, sigRef, declaration);
 }
 exports.createSignature = createSignature;
 function convertParameters(context, sigRef, parameters, parameterNodes) {

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

@@ -174,14 +174,16 @@ let CommentPlugin = class CommentPlugin extends components_1.ConverterComponent
         }
         hidden.forEach((reflection) => project.removeReflection(reflection));
         // remove functions with empty signatures after their signatures have been removed
-        const [allRemoved, someRemoved] = (0, utils_1.partition)((0, utils_1.filterMap)(hidden, (reflection) => reflection.parent?.kindOf(models_1.ReflectionKind.FunctionOrMethod | models_1.ReflectionKind.Constructor)
+        const [allRemoved, someRemoved] = (0, utils_1.partition)((0, utils_1.unique)((0, utils_1.filterMap)(hidden, (reflection) => reflection.parent?.kindOf(models_1.ReflectionKind.SignatureContainer)
             ? reflection.parent
-            : void 0), (method) => method.signatures?.length === 0);
+            : void 0)), (method) => method.getNonIndexSignatures().length === 0);
         allRemoved.forEach((reflection) => {
             project.removeReflection(reflection);
         });
         someRemoved.forEach((reflection) => {
-            reflection.sources = (0, utils_1.unique)(reflection.signatures.flatMap((s) => s.sources ?? []));
+            reflection.sources = reflection
+                .getNonIndexSignatures()
+                .flatMap((s) => s.sources ?? []);
         });
     }
     /**
@@ -282,8 +284,9 @@ let CommentPlugin = class CommentPlugin extends components_1.ConverterComponent
         }
         if (!comment) {
             if (this.excludeNotDocumented) {
-                // Only allow excludeNotDocumented to exclude root level reflections
-                if (!(reflection instanceof models_1.DeclarationReflection)) {
+                // Don't let excludeNotDocumented remove parameters.
+                if (!(reflection instanceof models_1.DeclarationReflection) &&
+                    !(reflection instanceof models_1.SignatureReflection)) {
                     return false;
                 }
                 // excludeNotDocumented should hide a module only if it has no visible children
@@ -297,6 +300,12 @@ let CommentPlugin = class CommentPlugin extends components_1.ConverterComponent
                 if (reflection.kind === models_1.ReflectionKind.EnumMember) {
                     return false;
                 }
+                // signature containers should only be hidden if all their signatures are hidden
+                if (reflection.kindOf(models_1.ReflectionKind.SignatureContainer)) {
+                    return reflection
+                        .getAllSignatures()
+                        .every((child) => this.isHidden(child));
+                }
                 // excludeNotDocumented should never hide parts of "type" reflections
                 return inTypeLiteral(reflection) === false;
             }

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

@@ -14,8 +14,9 @@ const declarationReference_1 = require("../comments/declarationReference");
 const ts = require("typescript");
 const utils_1 = require("../../utils");
 const declarationReferenceResolver_1 = require("../comments/declarationReferenceResolver");
+const models_1 = require("../../models");
 const urlPrefix = /^(http|ftp)s?:\/\//;
-const brackets = /\[\[([^\]]+)\]\]/g;
+const brackets = /\[\[(?!include:)([^\]]+)\]\]/g;
 /**
  * A plugin that resolves `{@link Foo}` tags.
  */
@@ -113,6 +114,9 @@ let LinkResolverPlugin = LinkResolverPlugin_1 = class LinkResolverPlugin extends
         for (const tag of comment.blockTags) {
             tag.content = this.processParts(reflection, tag.content, warn);
         }
+        if (reflection instanceof models_1.DeclarationReflection && reflection.readme) {
+            reflection.readme = this.processParts(reflection, reflection.readme, warn);
+        }
     }
     processParts(reflection, parts, warn) {
         return parts.flatMap((part) => this.processPart(reflection, part, warn));
@@ -173,6 +177,10 @@ exports.LinkResolverPlugin = LinkResolverPlugin;
 function resolveLinkTag(reflection, part, warn) {
     let pos = 0;
     const end = part.text.length;
+    while (pos < end && ts.isWhiteSpaceLike(part.text.charCodeAt(pos))) {
+        pos++;
+    }
+    const origText = part.text;
     // Try to parse one
     const declRef = (0, declarationReference_1.parseDeclarationReference)(part.text, pos, end);
     let target;
@@ -181,12 +189,20 @@ function resolveLinkTag(reflection, part, warn) {
         target = (0, declarationReferenceResolver_1.resolveDeclarationReference)(reflection, declRef[0]);
         pos = declRef[1];
     }
+    if (!target) {
+        if (urlPrefix.test(part.text)) {
+            const wsIndex = part.text.search(/\s/);
+            target =
+                wsIndex === -1 ? part.text : part.text.substring(0, wsIndex);
+            pos = target.length;
+        }
+    }
     // If resolution via a declaration reference failed, revert to the legacy "split and check"
     // method... this should go away in 0.24, once people have had a chance to migrate any failing links.
     if (!target) {
         const resolved = legacyResolveLinkTag(reflection, part);
         if (resolved) {
-            warn(`Failed to resolve {@link ${part.text}} in ${reflection.getFriendlyFullName()} with declaration references. This link will break in v0.24.`);
+            warn(`Failed to resolve {@link ${origText}} in ${reflection.getFriendlyFullName()} with declaration references. This link will break in v0.24.`);
         }
         return resolved;
     }
@@ -199,7 +215,9 @@ function resolveLinkTag(reflection, part, warn) {
         pos++;
     }
     part.target = target;
-    part.text = part.text.substring(pos).trim() || target.name;
+    part.text =
+        part.text.substring(pos).trim() ||
+            (typeof target === "string" ? target : target.name);
     return part;
 }
 function legacyResolveLinkTag(reflection, part) {

package/dist/lib/converter/plugins/PackagePlugin.d.ts

@@ -1,4 +1,5 @@
 import { ConverterComponent } from "../components";
+import { EntryPointStrategy } from "../../utils";
 /**
  * A handler that tries to find the package.json and readme.md files of the
  * current project.
@@ -6,6 +7,7 @@ import { ConverterComponent } from "../components";
 export declare class PackagePlugin extends ConverterComponent {
     readme: string;
     includeVersion: boolean;
+    entryPointStrategy: EntryPointStrategy;
     /**
      * The file name of the found readme.md file.
      */

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

@@ -14,8 +14,6 @@ const converter_1 = require("../converter");
 const utils_1 = require("../../utils");
 const fs_1 = require("../../utils/fs");
 const paths_1 = require("../../utils/paths");
-const rawLexer_1 = require("../comments/rawLexer");
-const parser_1 = require("../comments/parser");
 const minimalSourceFile_1 = require("../../utils/minimalSourceFile");
 /**
  * A handler that tries to find the package.json and readme.md files of the
@@ -76,7 +74,7 @@ let PackagePlugin = class PackagePlugin extends components_1.ConverterComponent
         const project = context.project;
         if (this.readmeFile) {
             const readme = (0, utils_1.readFile)(this.readmeFile);
-            const comment = (0, parser_1.parseComment)((0, rawLexer_1.lexCommentString)(readme), context.converter.config, new minimalSourceFile_1.MinimalSourceFile(readme, this.readmeFile), context.logger);
+            const comment = context.converter.parseRawComment(new minimalSourceFile_1.MinimalSourceFile(readme, this.readmeFile));
             if (comment.blockTags.length || comment.modifierTags.size) {
                 const ignored = [
                     ...comment.blockTags.map((tag) => tag.tag),
@@ -102,7 +100,11 @@ let PackagePlugin = class PackagePlugin extends components_1.ConverterComponent
                     project.name = `${project.name} - v${packageInfo.version}`;
                 }
                 else {
-                    context.logger.warn("--includeVersion was specified, but package.json does not specify a version.");
+                    // since not all monorepo specifies a meaningful version to the main package.json
+                    // this warning should be optional
+                    if (this.entryPointStrategy !== utils_1.EntryPointStrategy.Packages) {
+                        context.logger.warn("--includeVersion was specified, but package.json does not specify a version.");
+                    }
                 }
             }
         }
@@ -112,7 +114,11 @@ let PackagePlugin = class PackagePlugin extends components_1.ConverterComponent
                 project.name = "Documentation";
             }
             if (this.includeVersion) {
-                context.logger.warn("--includeVersion was specified, but no package.json was found. Not adding package version to the documentation.");
+                // since not all monorepo specifies a meaningful version to the main package.json
+                // this warning should be optional
+                if (this.entryPointStrategy !== utils_1.EntryPointStrategy.Packages) {
+                    context.logger.warn("--includeVersion was specified, but no package.json was found. Not adding package version to the documentation.");
+                }
             }
         }
     }
@@ -123,6 +129,9 @@ __decorate([
 __decorate([
     (0, utils_1.BindOption)("includeVersion")
 ], PackagePlugin.prototype, "includeVersion", void 0);
+__decorate([
+    (0, utils_1.BindOption)("entryPointStrategy")
+], PackagePlugin.prototype, "entryPointStrategy", void 0);
 PackagePlugin = __decorate([
     (0, components_1.Component)({ name: "package" })
 ], PackagePlugin);

package/dist/lib/converter/plugins/SourcePlugin.d.ts

@@ -33,6 +33,7 @@ export declare class SourcePlugin extends ConverterComponent {
      * @param reflection  The reflection that is currently processed.
      */
     private onDeclaration;
+    private onSignature;
     /**
      * Triggered when the converter begins resolving a project.
      *

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

@@ -42,7 +42,7 @@ let SourcePlugin = class SourcePlugin extends components_1.ConverterComponent {
         this.listenTo(this.owner, {
             [converter_1.Converter.EVENT_END]: this.onEnd,
             [converter_1.Converter.EVENT_CREATE_DECLARATION]: this.onDeclaration,
-            [converter_1.Converter.EVENT_CREATE_SIGNATURE]: this.onDeclaration,
+            [converter_1.Converter.EVENT_CREATE_SIGNATURE]: this.onSignature,
             [converter_1.Converter.EVENT_RESOLVE_BEGIN]: this.onBeginResolve,
         });
     }
@@ -77,6 +77,16 @@ let SourcePlugin = class SourcePlugin extends components_1.ConverterComponent {
             reflection.sources.push(new models_1.SourceReference(fileName, position.line + 1, position.character));
         }
     }
+    onSignature(_context, reflection, sig) {
+        if (this.disableSources || !sig)
+            return;
+        const sourceFile = sig.getSourceFile();
+        const fileName = sourceFile.fileName;
+        this.fileNames.add(fileName);
+        const position = ts.getLineAndCharacterOfPosition(sourceFile, sig.getStart());
+        reflection.sources || (reflection.sources = []);
+        reflection.sources.push(new models_1.SourceReference(fileName, position.line + 1, position.character));
+    }
     /**
      * Triggered when the converter begins resolving a project.
      *

package/dist/lib/converter/utils/repository.js

@@ -44,11 +44,19 @@ class Repository {
         this.path = path;
         this.branch = gitRevision || "master";
         for (let i = 0, c = repoLinks.length; i < c; i++) {
-            let match = /(github(?:\.[a-z]+)*\.[a-z]{2,})[:/]([^/]+)\/(.*)/.exec(repoLinks[i]);
+            let match = /(github(?!.us)(?:\.[a-z]+)*\.[a-z]{2,})[:/]([^/]+)\/(.*)/.exec(repoLinks[i]);
             // Github Enterprise
             if (!match) {
                 match = /(\w+\.githubprivate.com)[:/]([^/]+)\/(.*)/.exec(repoLinks[i]);
             }
+            // Github Enterprise
+            if (!match) {
+                match = /(\w+\.ghe.com)[:/]([^/]+)\/(.*)/.exec(repoLinks[i]);
+            }
+            // Github Enterprise
+            if (!match) {
+                match = /(\w+\.github.us)[:/]([^/]+)\/(.*)/.exec(repoLinks[i]);
+            }
             if (!match) {
                 match = /(bitbucket.org)[:/]([^/]+)\/(.*)/.exec(repoLinks[i]);
             }

package/dist/lib/models/reflections/declaration.d.ts

@@ -5,6 +5,7 @@ import { ContainerReflection } from "./container";
 import type { SignatureReflection } from "./signature";
 import type { TypeParameterReflection } from "./type-parameter";
 import type { Serializer, JSONOutput } from "../../serialization";
+import type { CommentDisplayPart } from "../comments";
 /**
  * Stores hierarchical type data.
  *
@@ -109,6 +110,14 @@ export declare class DeclarationReflection extends ContainerReflection {
      * rendered in templates.
      */
     typeHierarchy?: DeclarationHierarchy;
+    /**
+     * The contents of the readme file of the module when found.
+     */
+    readme?: CommentDisplayPart[];
+    /**
+     * The version of the module when found.
+     */
+    version?: string;
     hasGetterOrSetter(): boolean;
     getAllSignatures(): SignatureReflection[];
     /** @internal */

package/dist/lib/models/reflections/kind.d.ts

@@ -45,4 +45,9 @@ export declare namespace ReflectionKind {
     const Inheritable: number;
     /** @internal */
     const ContainsCallSignatures: number;
+    /**
+     * Note: This does not include Class/Interface, even though they technically could contain index signatures
+     * @internal
+     */
+    const SignatureContainer: number;
 }

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

@@ -78,4 +78,9 @@ var ReflectionKind;
     ReflectionKind.ContainsCallSignatures = ReflectionKind.Constructor |
         ReflectionKind.Function |
         ReflectionKind.Method;
+    /**
+     * Note: This does not include Class/Interface, even though they technically could contain index signatures
+     * @internal
+     */
+    ReflectionKind.SignatureContainer = ReflectionKind.ContainsCallSignatures | ReflectionKind.Accessor;
 })(ReflectionKind = exports.ReflectionKind || (exports.ReflectionKind = {}));

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

@@ -221,6 +221,11 @@ class DefaultTheme extends theme_1.Theme {
                     classes.push("tsd-is-protected");
                 }
             }
+            else if (key === "private") {
+                if (reflection.flags.isPrivate) {
+                    classes.push("tsd-is-private");
+                }
+            }
             else if (key === "external") {
                 if (reflection.flags.isExternal) {
                     classes.push("tsd-is-external");

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

@@ -39,6 +39,9 @@ export declare class DefaultThemeRenderContext {
     members: (props: import("../../../models").ContainerReflection) => import("../../../utils/jsx.elements").JsxElement;
     membersGroup: (group: import("../../../models").ReflectionGroup) => import("../../../utils/jsx.elements").JsxElement;
     navigation: (props: import("../..").PageEvent<Reflection>) => import("../../../utils/jsx.elements").JsxElement;
+    settings: () => import("../../../utils/jsx.elements").JsxElement;
+    primaryNavigation: (props: import("../..").PageEvent<Reflection>) => import("../../../utils/jsx.elements").JsxElement;
+    secondaryNavigation: (props: import("../..").PageEvent<Reflection>) => import("../../../utils/jsx.elements").JsxElement | undefined;
     parameter: (props: import("../../../models").DeclarationReflection) => import("../../../utils/jsx.elements").JsxElement;
     toolbar: (props: import("../..").PageEvent<Reflection>) => import("../../../utils/jsx.elements").JsxElement;
     type: (type: import("../../../models").Type | undefined) => import("../../../utils/jsx.elements").JsxElement;

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

@@ -68,6 +68,9 @@ class DefaultThemeRenderContext {
         this.members = bind(members_1.members, this);
         this.membersGroup = bind(members_group_1.membersGroup, this);
         this.navigation = bind(navigation_1.navigation, this);
+        this.settings = bind(navigation_1.settings, this);
+        this.primaryNavigation = bind(navigation_1.primaryNavigation, this);
+        this.secondaryNavigation = bind(navigation_1.secondaryNavigation, this);
         this.parameter = bind(parameter_1.parameter, this);
         this.toolbar = bind(toolbar_1.toolbar, this);
         this.type = bind(type_1.type, this);

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

@@ -1,5 +1,5 @@
 import { JSX } from "../../../../utils";
 import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext";
 import type { PageEvent } from "../../../events";
-import type { Reflection } from "../../../../models";
+import { Reflection } from "../../../../models";
 export declare const header: (context: DefaultThemeRenderContext, props: PageEvent<Reflection>) => JSX.Element;

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

@@ -3,13 +3,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.header = void 0;
 const lib_1 = require("../../lib");
 const utils_1 = require("../../../../utils");
+const models_1 = require("../../../../models");
 const header = (context, props) => {
     const HeadingLevel = props.model.isProject() ? "h2" : "h1";
     return (utils_1.JSX.createElement("div", { class: "tsd-page-title" },
         !!props.model.parent && utils_1.JSX.createElement("ul", { class: "tsd-breadcrumb" }, context.breadcrumb(props.model)),
         utils_1.JSX.createElement(HeadingLevel, null,
-            props.model.kindString !== "Project" && `${props.model.kindString ?? ""} `,
+            props.model.kind !== models_1.ReflectionKind.Project && `${props.model.kindString ?? ""} `,
             props.model.name,
+            props.model instanceof models_1.DeclarationReflection &&
+                props.model.version !== undefined &&
+                ` - v${props.model.version}`,
             (0, lib_1.hasTypeParameters)(props.model) && (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
                 "<",
                 (0, lib_1.join)(", ", props.model.typeParameters, (item) => item.name),

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

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

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

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.index = void 0;
 const lib_1 = require("../../lib");
 const utils_1 = require("../../../../utils");
+const models_1 = require("../../../../models");
 function renderCategory({ urlTo, icons }, item, prependName = "") {
     return (utils_1.JSX.createElement("section", { class: "tsd-index-section" },
         utils_1.JSX.createElement("h3", { class: "tsd-index-heading" }, prependName ? `${prependName} - ${item.title}` : item.title),
@@ -36,7 +37,13 @@ function index(context, props) {
             utils_1.JSX.createElement("h3", { class: "tsd-index-heading uppercase" }, "Index"),
             content));
     }
-    return (utils_1.JSX.createElement("section", { class: "tsd-panel-group tsd-index-group" },
-        utils_1.JSX.createElement("section", { class: "tsd-panel tsd-index-panel" }, content)));
+    return (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
+        props instanceof models_1.DeclarationReflection &&
+            props.kind === models_1.ReflectionKind.Module &&
+            props.readme?.length !== 0 && (utils_1.JSX.createElement("section", { class: "tsd-panel-group" },
+            utils_1.JSX.createElement("section", { class: "tsd-panel tsd-typography" },
+                utils_1.JSX.createElement(utils_1.Raw, { html: context.markdown((0, lib_1.displayPartsToMarkdown)(props.readme || [], context.urlTo)) })))),
+        utils_1.JSX.createElement("section", { class: "tsd-panel-group tsd-index-group" },
+            utils_1.JSX.createElement("section", { class: "tsd-panel tsd-index-panel" }, content))));
 }
 exports.index = index;

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

@@ -4,21 +4,22 @@ exports.memberGetterSetter = void 0;
 const utils_1 = require("../../../../utils");
 const memberGetterSetter = (context, props) => (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
     utils_1.JSX.createElement("ul", { class: "tsd-signatures " + props.cssClasses },
-        !!props.getSignature && (utils_1.JSX.createElement("li", { class: "tsd-signature", id: props.getSignature.anchor },
-            utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "get"),
-            " ",
-            props.name,
-            context.memberSignatureTitle(props.getSignature, {
-                hideName: true,
-            }))),
-        !!props.setSignature && (utils_1.JSX.createElement("li", { class: "tsd-signature", id: props.setSignature.anchor },
-            utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "set"),
-            " ",
-            props.name,
-            context.memberSignatureTitle(props.setSignature, {
-                hideName: true,
-            })))),
-    utils_1.JSX.createElement("ul", { class: "tsd-descriptions" },
-        !!props.getSignature && utils_1.JSX.createElement("li", { class: "tsd-description" }, context.memberSignatureBody(props.getSignature)),
-        !!props.setSignature && utils_1.JSX.createElement("li", { class: "tsd-description" }, context.memberSignatureBody(props.setSignature)))));
+        !!props.getSignature && (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
+            utils_1.JSX.createElement("li", { class: "tsd-signature", id: props.getSignature.anchor },
+                utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "get"),
+                " ",
+                props.name,
+                context.memberSignatureTitle(props.getSignature, {
+                    hideName: true,
+                })),
+            utils_1.JSX.createElement("li", { class: "tsd-description" }, context.memberSignatureBody(props.getSignature)))),
+        !!props.setSignature && (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
+            utils_1.JSX.createElement("li", { class: "tsd-signature", id: props.setSignature.anchor },
+                utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "set"),
+                " ",
+                props.name,
+                context.memberSignatureTitle(props.setSignature, {
+                    hideName: true,
+                })),
+            utils_1.JSX.createElement("li", { class: "tsd-description" }, context.memberSignatureBody(props.setSignature)))))));
 exports.memberGetterSetter = memberGetterSetter;

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

@@ -1,6 +1,6 @@
 import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext";
 import { JSX } from "../../../../utils";
-import type { SignatureReflection } from "../../../../models";
+import { SignatureReflection } from "../../../../models";
 export declare const memberSignatureTitle: (context: DefaultThemeRenderContext, props: SignatureReflection, { hideName, arrowStyle }?: {
     hideName?: boolean | undefined;
     arrowStyle?: boolean | undefined;

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

@@ -3,8 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.memberSignatureTitle = void 0;
 const lib_1 = require("../../lib");
 const utils_1 = require("../../../../utils");
+const models_1 = require("../../../../models");
 const memberSignatureTitle = (context, props, { hideName = false, arrowStyle = false } = {}) => (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
-    !hideName ? ((0, lib_1.wbr)(props.name)) : (utils_1.JSX.createElement(utils_1.JSX.Fragment, null, props.kindString === "Constructor signature" && (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
+    !hideName ? ((0, lib_1.wbr)(props.name)) : (utils_1.JSX.createElement(utils_1.JSX.Fragment, null, props.kind === models_1.ReflectionKind.ConstructorSignature && (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
         !!props.flags.isAbstract && utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "abstract "),
         utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "new "))))),
     (0, lib_1.renderTypeParametersSignature)(props.typeParameters),

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

@@ -2,7 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.memberSignatures = void 0;
 const utils_1 = require("../../../../utils");
+const anchor_icon_1 = require("./anchor-icon");
 const memberSignatures = (context, props) => (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
-    utils_1.JSX.createElement("ul", { class: "tsd-signatures " + props.cssClasses }, props.signatures?.map((item) => (utils_1.JSX.createElement("li", { class: "tsd-signature", id: item.anchor }, context.memberSignatureTitle(item))))),
-    utils_1.JSX.createElement("ul", { class: "tsd-descriptions" }, props.signatures?.map((item) => (utils_1.JSX.createElement("li", { class: "tsd-description" }, context.memberSignatureBody(item)))))));
+    utils_1.JSX.createElement("ul", { class: "tsd-signatures " + props.cssClasses }, props.signatures?.map((item) => (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
+        utils_1.JSX.createElement("li", { class: "tsd-signature tsd-anchor-link", id: item.anchor },
+            context.memberSignatureTitle(item),
+            (0, anchor_icon_1.anchorIcon)(context, item.anchor)),
+        utils_1.JSX.createElement("li", { class: "tsd-description" }, context.memberSignatureBody(item))))))));
 exports.memberSignatures = memberSignatures;

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

@@ -3,3 +3,6 @@ import { JSX } from "../../../../utils";
 import type { PageEvent } from "../../../events";
 import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext";
 export declare function navigation(context: DefaultThemeRenderContext, props: PageEvent<Reflection>): JSX.Element;
+export declare function settings(context: DefaultThemeRenderContext): JSX.Element;
+export declare function primaryNavigation(context: DefaultThemeRenderContext, props: PageEvent<Reflection>): JSX.Element;
+export declare function secondaryNavigation(context: DefaultThemeRenderContext, props: PageEvent<Reflection>): JSX.Element | undefined;