typedoc 0.24.0-beta.6 → 0.24.0-beta.8

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

@@ -1,12 +1,13 @@
-import type { RendererHooks } from "../..";
-import { CommentDisplayPart, DeclarationReflection, ReferenceType, Reflection, ReflectionKind } from "../../../models";
+import type { PageEvent, RendererHooks } from "../..";
+import { CommentDisplayPart, DeclarationReflection, ReferenceType, Reflection } from "../../../models";
 import type { NeverIfInternal, Options } from "../../../utils";
 import type { DefaultTheme } from "./DefaultTheme";
 export declare class DefaultThemeRenderContext {
     private theme;
+    page: PageEvent<Reflection>;
     options: Options;
-    constructor(theme: DefaultTheme, options: Options);
-    icons: Record<"search" | "anchor" | ReflectionKind | "checkbox" | "chevronDown" | "menu" | "chevronSmall", () => import("../../../utils/jsx.elements").JsxElement>;
+    constructor(theme: DefaultTheme, page: PageEvent<Reflection>, options: Options);
+    icons: Record<"search" | "anchor" | import("../../../models").ReflectionKind | "checkbox" | "chevronDown" | "menu" | "chevronSmall", () => import("../../../utils/jsx.elements").JsxElement>;
     hook: (name: keyof RendererHooks) => import("../../../utils/jsx.elements").JsxElement[];
     /** Avoid this in favor of urlTo if possible */
     relativeURL: (url: string, cacheBust?: boolean) => string;
@@ -18,15 +19,15 @@ export declare class DefaultThemeRenderContext {
      * Will be removed in 0.24.
      */
     attemptExternalResolution: (type: NeverIfInternal<ReferenceType>) => string | undefined;
-    getReflectionClasses: (reflection: DeclarationReflection) => string;
-    reflectionTemplate: (props: import("../..").PageEvent<import("../../../models").ContainerReflection>) => import("../../../utils/jsx.elements").JsxElement;
-    indexTemplate: (props: import("../..").PageEvent<import("../../../models").ProjectReflection>) => import("../../../utils/jsx.elements").JsxElement;
-    defaultLayout: (props: import("../..").PageEvent<Reflection>) => import("../../../utils/jsx.elements").JsxElement;
+    getReflectionClasses: (refl: DeclarationReflection) => string;
+    reflectionTemplate: (props: PageEvent<import("../../../models").ContainerReflection>) => import("../../../utils/jsx.elements").JsxElement;
+    indexTemplate: (props: PageEvent<import("../../../models").ProjectReflection>) => import("../../../utils/jsx.elements").JsxElement;
+    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;
     comment: (props: Reflection) => import("../../../utils/jsx.elements").JsxElement | undefined;
     footer: () => import("../../../utils/jsx.elements").JsxElement | undefined;
-    header: (props: import("../..").PageEvent<Reflection>) => import("../../../utils/jsx.elements").JsxElement;
+    header: (props: PageEvent<Reflection>) => import("../../../utils/jsx.elements").JsxElement;
     hierarchy: (props: import("../../../models").DeclarationHierarchy | undefined) => import("../../../utils/jsx.elements").JsxElement | undefined;
     index: (props: import("../../../models").ContainerReflection) => import("../../../utils/jsx.elements").JsxElement;
     member: (props: DeclarationReflection) => import("../../../utils/jsx.elements").JsxElement;
@@ -44,13 +45,14 @@ export declare class DefaultThemeRenderContext {
     memberSources: (props: import("../../../models").SignatureReflection | DeclarationReflection) => import("../../../utils/jsx.elements").JsxElement;
     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;
+    sidebar: (props: PageEvent<Reflection>) => import("../../../utils/jsx.elements").JsxElement;
+    pageSidebar: (props: PageEvent<Reflection>) => import("../../../utils/jsx.elements").JsxElement;
     sidebarLinks: () => import("../../../utils/jsx.elements").JsxElement | null;
     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;
+    navigation: (props: PageEvent<Reflection>) => import("../../../utils/jsx.elements").JsxElement;
+    pageNavigation: (props: PageEvent<Reflection>) => import("../../../utils/jsx.elements").JsxElement;
     parameter: (props: DeclarationReflection) => import("../../../utils/jsx.elements").JsxElement;
-    toolbar: (props: import("../..").PageEvent<Reflection>) => import("../../../utils/jsx.elements").JsxElement;
+    toolbar: (props: PageEvent<Reflection>) => import("../../../utils/jsx.elements").JsxElement;
     type: (type: import("../../../models").Type | undefined) => import("../../../utils/jsx.elements").JsxElement;
     typeAndParent: (props: import("../../../models").Type) => import("../../../utils/jsx.elements").JsxElement;
     typeParameters: (typeParameters: import("../../../models").TypeParameterReflection[]) => import("../../../utils/jsx.elements").JsxElement;

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

@@ -33,8 +33,9 @@ function bind(fn, first) {
     return (...r) => fn(first, ...r);
 }
 class DefaultThemeRenderContext {
-    constructor(theme, options) {
+    constructor(theme, page, options) {
         this.theme = theme;
+        this.page = page;
         this.icons = icon_1.icons;
         this.hook = (name) => this.theme.owner.hooks.emit(name, this);
         /** Avoid this in favor of urlTo if possible */
@@ -50,9 +51,9 @@ class DefaultThemeRenderContext {
         };
         this.markdown = (md) => {
             if (md instanceof Array) {
-                return this.theme.markedPlugin.parseMarkdown(models_1.Comment.displayPartsToMarkdown(md, this.urlTo));
+                return this.theme.markedPlugin.parseMarkdown(models_1.Comment.displayPartsToMarkdown(md, this.urlTo), this.page);
             }
-            return md ? this.theme.markedPlugin.parseMarkdown(md) : "";
+            return md ? this.theme.markedPlugin.parseMarkdown(md, this.page) : "";
         };
         /**
          * Using this method will repeat work already done, instead of calling it, use `type.externalUrl`.
@@ -62,10 +63,7 @@ class DefaultThemeRenderContext {
         this.attemptExternalResolution = (type) => {
             return type.externalUrl;
         };
-        this.getReflectionClasses = (reflection) => {
-            const filters = this.options.getValue("visibilityFilters");
-            return getReflectionClasses(reflection, filters);
-        };
+        this.getReflectionClasses = (refl) => this.theme.getReflectionClasses(refl);
         this.reflectionTemplate = bind(reflection_1.reflectionTemplate, this);
         this.indexTemplate = bind(templates_1.indexTemplate, this);
         this.defaultLayout = bind(default_1.defaultLayout, this);
@@ -86,11 +84,12 @@ class DefaultThemeRenderContext {
         this.memberSources = bind(member_sources_1.memberSources, this);
         this.members = bind(members_1.members, this);
         this.membersGroup = bind(members_group_1.membersGroup, this);
-        this.navigation = bind(navigation_1.navigation, this);
+        this.sidebar = bind(navigation_1.sidebar, this);
+        this.pageSidebar = bind(navigation_1.pageSidebar, this);
         this.sidebarLinks = bind(navigation_1.sidebarLinks, this);
         this.settings = bind(navigation_1.settings, this);
-        this.primaryNavigation = bind(navigation_1.primaryNavigation, this);
-        this.secondaryNavigation = bind(navigation_1.secondaryNavigation, this);
+        this.navigation = bind(navigation_1.navigation, this);
+        this.pageNavigation = bind(navigation_1.pageNavigation, this);
         this.parameter = bind(parameter_1.parameter, this);
         this.toolbar = bind(toolbar_1.toolbar, this);
         this.type = bind(type_1.type, this);
@@ -100,52 +99,3 @@ class DefaultThemeRenderContext {
     }
 }
 exports.DefaultThemeRenderContext = DefaultThemeRenderContext;
-function getReflectionClasses(reflection, filters) {
-    const classes = [];
-    classes.push(toStyleClass("tsd-kind-" + models_1.ReflectionKind[reflection.kind]));
-    if (reflection.parent &&
-        reflection.parent instanceof models_1.DeclarationReflection) {
-        classes.push(toStyleClass(`tsd-parent-kind-${models_1.ReflectionKind[reflection.parent.kind]}`));
-    }
-    // Filter classes should match up with the settings function in
-    // partials/navigation.tsx.
-    for (const key of Object.keys(filters)) {
-        if (key === "inherited") {
-            if (reflection.inheritedFrom) {
-                classes.push("tsd-is-inherited");
-            }
-        }
-        else if (key === "protected") {
-            if (reflection.flags.isProtected) {
-                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");
-            }
-        }
-        else if (key.startsWith("@")) {
-            if (key === "@deprecated") {
-                if (reflection.isDeprecated()) {
-                    classes.push(toStyleClass(`tsd-is-${key.substring(1)}`));
-                }
-            }
-            else if (reflection.comment?.hasModifier(key) ||
-                reflection.comment?.getTag(key)) {
-                classes.push(toStyleClass(`tsd-is-${key.substring(1)}`));
-            }
-        }
-    }
-    return classes.join(" ");
-}
-function toStyleClass(str) {
-    return str
-        .replace(/(\w)([A-Z])/g, (_m, m1, m2) => m1 + "-" + m2)
-        .toLowerCase();
-}

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

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

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

@@ -2,19 +2,21 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.defaultLayout = void 0;
 const utils_1 = require("../../../../utils");
-const defaultLayout = (context, props) => (utils_1.JSX.createElement("html", { class: "default", lang: context.options.getValue("htmlLang") },
+const lib_1 = require("../../lib");
+const defaultLayout = (context, template, props) => (utils_1.JSX.createElement("html", { class: "default", lang: context.options.getValue("htmlLang") },
     utils_1.JSX.createElement("head", null,
         utils_1.JSX.createElement("meta", { charSet: "utf-8" }),
         context.hook("head.begin"),
         utils_1.JSX.createElement("meta", { "http-equiv": "x-ua-compatible", content: "IE=edge" }),
-        utils_1.JSX.createElement("title", null, props.model.name === props.project.name
-            ? props.project.name
-            : `${props.model.name} | ${props.project.name}`),
+        utils_1.JSX.createElement("title", null, props.model.isProject()
+            ? (0, lib_1.getDisplayName)(props.model)
+            : `${(0, lib_1.getDisplayName)(props.model)} | ${(0, lib_1.getDisplayName)(props.project)}`),
         utils_1.JSX.createElement("meta", { name: "description", content: "Documentation for " + props.project.name }),
         utils_1.JSX.createElement("meta", { name: "viewport", content: "width=device-width, initial-scale=1" }),
         utils_1.JSX.createElement("link", { rel: "stylesheet", href: context.relativeURL("assets/style.css", true) }),
         utils_1.JSX.createElement("link", { rel: "stylesheet", href: context.relativeURL("assets/highlight.css", true) }),
         context.options.getValue("customCss") && (utils_1.JSX.createElement("link", { rel: "stylesheet", href: context.relativeURL("assets/custom.css", true) })),
+        utils_1.JSX.createElement("script", { defer: true, src: context.relativeURL("assets/main.js", true) }),
         utils_1.JSX.createElement("script", { async: true, src: context.relativeURL("assets/search.js", true), id: "search-script" }),
         context.hook("head.end")),
     utils_1.JSX.createElement("body", null,
@@ -23,18 +25,22 @@ const defaultLayout = (context, props) => (utils_1.JSX.createElement("html", { c
             utils_1.JSX.createElement(utils_1.Raw, { html: 'document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"' })),
         context.toolbar(props),
         utils_1.JSX.createElement("div", { class: "container container-main" },
-            utils_1.JSX.createElement("div", { class: "col-4 col-menu menu-sticky-wrap menu-highlight" },
-                context.hook("navigation.begin"),
-                context.navigation(props),
-                context.hook("navigation.end")),
-            utils_1.JSX.createElement("div", { class: "col-8 col-content" },
+            utils_1.JSX.createElement("div", { class: "col-content" },
                 context.hook("content.begin"),
                 context.header(props),
-                props.template(props),
-                context.hook("content.end"))),
+                template(props),
+                context.hook("content.end")),
+            utils_1.JSX.createElement("div", { class: "col-sidebar" },
+                utils_1.JSX.createElement("div", { class: "page-menu" },
+                    context.hook("pageSidebar.begin"),
+                    context.pageSidebar(props),
+                    context.hook("pageSidebar.end")),
+                utils_1.JSX.createElement("div", { class: "site-menu" },
+                    context.hook("sidebar.begin"),
+                    context.sidebar(props),
+                    context.hook("sidebar.end")))),
         context.footer(),
         utils_1.JSX.createElement("div", { class: "overlay" }),
-        utils_1.JSX.createElement("script", { src: context.relativeURL("assets/main.js", true) }),
         context.analytics(),
         context.hook("body.end"))));
 exports.defaultLayout = defaultLayout;

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

@@ -5,7 +5,7 @@ const utils_1 = require("../../../../utils");
 function footer(context) {
     const hideGenerator = context.options.getValue("hideGenerator");
     if (!hideGenerator)
-        return (utils_1.JSX.createElement("div", { class: "container tsd-generator" },
+        return (utils_1.JSX.createElement("div", { class: "tsd-generator" },
             utils_1.JSX.createElement("p", null,
                 "Generated using ",
                 utils_1.JSX.createElement("a", { href: "https://typedoc.org/", target: "_blank" }, "TypeDoc"))));

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

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

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

@@ -5,18 +5,26 @@ const lib_1 = require("../../lib");
 const utils_1 = require("../../../../utils");
 const models_1 = require("../../../../models");
 const anchor_icon_1 = require("./anchor-icon");
-const member = (context, props) => (utils_1.JSX.createElement("section", { class: (0, lib_1.classNames)({ "tsd-panel": true, "tsd-member": true }, context.getReflectionClasses(props)) },
-    utils_1.JSX.createElement("a", { id: props.anchor, class: "tsd-anchor" }),
-    !!props.name && (utils_1.JSX.createElement("h3", { class: "tsd-anchor-link" },
-        (0, lib_1.renderFlags)(props.flags, props.comment),
-        utils_1.JSX.createElement("span", { class: (0, lib_1.classNames)({ deprecated: props.isDeprecated() }) }, (0, lib_1.wbr)(props.name)),
-        (0, anchor_icon_1.anchorIcon)(context, props.anchor))),
-    props.signatures
-        ? context.memberSignatures(props)
-        : props.hasGetterOrSetter()
-            ? context.memberGetterSetter(props)
-            : props instanceof models_1.ReferenceReflection
-                ? context.memberReference(props)
-                : context.memberDeclaration(props),
-    props.groups?.map((item) => item.children.map((item) => !item.hasOwnDocument && context.member(item)))));
+function member(context, props) {
+    context.page.pageHeadings.push({
+        link: `#${props.anchor}`,
+        text: (0, lib_1.getDisplayName)(props),
+        kind: props.kind,
+        classes: context.getReflectionClasses(props),
+    });
+    return (utils_1.JSX.createElement("section", { class: (0, lib_1.classNames)({ "tsd-panel": true, "tsd-member": true }, context.getReflectionClasses(props)) },
+        utils_1.JSX.createElement("a", { id: props.anchor, class: "tsd-anchor" }),
+        !!props.name && (utils_1.JSX.createElement("h3", { class: "tsd-anchor-link" },
+            (0, lib_1.renderFlags)(props.flags, props.comment),
+            utils_1.JSX.createElement("span", { class: (0, lib_1.classNames)({ deprecated: props.isDeprecated() }) }, (0, lib_1.wbr)(props.name)),
+            (0, anchor_icon_1.anchorIcon)(context, props.anchor))),
+        props.signatures
+            ? context.memberSignatures(props)
+            : props.hasGetterOrSetter()
+                ? context.memberGetterSetter(props)
+                : props instanceof models_1.ReferenceReflection
+                    ? context.memberReference(props)
+                    : context.memberDeclaration(props),
+        props.groups?.map((item) => item.children.map((item) => !item.hasOwnDocument && context.member(item)))));
+}
 exports.member = member;

package/dist/lib/output/themes/default/partials/members.group.js

@@ -6,10 +6,10 @@ function membersGroup(context, group) {
     if (group.categories) {
         return (utils_1.JSX.createElement(utils_1.JSX.Fragment, null, group.categories.map((item) => (utils_1.JSX.createElement("section", { class: "tsd-panel-group tsd-member-group" },
             utils_1.JSX.createElement("h2", null,
+                group.title,
                 !!item.title && utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
-                    item.title,
-                    " "),
-                group.title),
+                    " - ",
+                    item.title)),
             item.children.map((item) => !item.hasOwnDocument && context.member(item)))))));
     }
     return (utils_1.JSX.createElement("section", { class: "tsd-panel-group tsd-member-group" },

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

@@ -2,8 +2,9 @@ import { Reflection } from "../../../../models";
 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 sidebar(context: DefaultThemeRenderContext, props: PageEvent<Reflection>): JSX.Element;
 export declare function sidebarLinks(context: DefaultThemeRenderContext): JSX.Element | null;
 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;
+export declare function navigation(context: DefaultThemeRenderContext, props: PageEvent<Reflection>): JSX.Element;
+export declare function pageSidebar(context: DefaultThemeRenderContext, props: PageEvent<Reflection>): JSX.Element;
+export declare function pageNavigation(context: DefaultThemeRenderContext, props: PageEvent<Reflection>): JSX.Element;

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

@@ -1,17 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.secondaryNavigation = exports.primaryNavigation = exports.settings = exports.sidebarLinks = exports.navigation = void 0;
+exports.pageNavigation = exports.pageSidebar = exports.navigation = exports.settings = exports.sidebarLinks = exports.sidebar = void 0;
 const models_1 = require("../../../../models");
 const utils_1 = require("../../../../utils");
 const lib_1 = require("../../lib");
-function navigation(context, props) {
+function sidebar(context, props) {
     return (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
         context.sidebarLinks(),
-        context.settings(),
-        context.primaryNavigation(props),
-        context.secondaryNavigation(props)));
+        context.navigation(props)));
 }
-exports.navigation = navigation;
+exports.sidebar = sidebar;
 function buildFilterItem(context, name, displayName, defaultValue) {
     return (utils_1.JSX.createElement("li", { class: "tsd-filter-item" },
         utils_1.JSX.createElement("label", { class: "tsd-filter-input" },
@@ -50,7 +48,7 @@ function settings(context) {
             utils_1.JSX.createElement("summary", { class: "tsd-accordion-summary" },
                 utils_1.JSX.createElement("h3", null,
                     context.icons.chevronDown(),
-                    " Settings")),
+                    "Settings")),
             utils_1.JSX.createElement("div", { class: "tsd-accordion-details" },
                 visibilityOptions.length && (utils_1.JSX.createElement("div", { class: "tsd-filter-visibility" },
                     utils_1.JSX.createElement("h4", { class: "uppercase" }, "Member Visibility"),
@@ -64,79 +62,78 @@ function settings(context) {
                         utils_1.JSX.createElement("option", { value: "dark" }, "Dark")))))));
 }
 exports.settings = settings;
-function primaryNavigation(context, props) {
+function navigation(context, props) {
     // Create the navigation for the current page
-    const modules = props.model.project.getChildrenByKind(models_1.ReflectionKind.SomeModule);
-    const [ext, int] = (0, utils_1.partition)(modules, (m) => m.flags.isExternal);
-    const selected = props.model.isProject();
-    const current = selected || int.some((mod) => inPath(mod, props.model));
-    return (utils_1.JSX.createElement("nav", { class: "tsd-navigation primary" },
-        utils_1.JSX.createElement("details", { class: "tsd-index-accordion", open: true },
+    // Recurse to children if the parent is some kind of module
+    return (utils_1.JSX.createElement("nav", { class: "tsd-navigation" },
+        link(props.project),
+        utils_1.JSX.createElement("ul", { class: "tsd-small-nested-navigation" }, props.project.children?.map((c) => (utils_1.JSX.createElement("li", null, links(c)))))));
+    function links(mod) {
+        const children = (mod.kindOf(models_1.ReflectionKind.SomeModule | models_1.ReflectionKind.Project) && mod.children) || [];
+        const nameClasses = (0, lib_1.classNames)({ deprecated: mod.isDeprecated() }, mod.isProject() ? void 0 : context.getReflectionClasses(mod));
+        if (!children.length) {
+            return link(mod, nameClasses);
+        }
+        return (utils_1.JSX.createElement("details", { class: (0, lib_1.classNames)({ "tsd-index-accordion": true }, nameClasses), open: inPath(mod), "data-key": mod.getFullName() },
             utils_1.JSX.createElement("summary", { class: "tsd-accordion-summary" },
-                utils_1.JSX.createElement("h3", null,
-                    context.icons.chevronDown(),
-                    " Modules")),
+                context.icons.chevronDown(),
+                link(mod)),
             utils_1.JSX.createElement("div", { class: "tsd-accordion-details" },
-                utils_1.JSX.createElement("ul", null,
-                    utils_1.JSX.createElement("li", { class: (0, lib_1.classNames)({ current, selected }) },
-                        utils_1.JSX.createElement("a", { href: context.urlTo(props.model.project) }, (0, lib_1.wbr)(props.project.name)),
-                        utils_1.JSX.createElement("ul", null, int.map(link))),
-                    ext.map(link))))));
-    function link(mod) {
-        const current = inPath(mod, props.model);
-        const selected = mod.name === props.model.name;
-        let childNav;
-        const childModules = mod.children?.filter((m) => m.kindOf(models_1.ReflectionKind.SomeModule));
-        if (childModules?.length) {
-            childNav = utils_1.JSX.createElement("ul", null, childModules.map(link));
-        }
-        return (utils_1.JSX.createElement("li", { class: (0, lib_1.classNames)({ current, selected, deprecated: mod.isDeprecated() }, context.getReflectionClasses(mod)) },
-            utils_1.JSX.createElement("a", { href: context.urlTo(mod) }, (0, lib_1.wbr)((0, lib_1.getDisplayName)(mod))),
-            childNav));
+                utils_1.JSX.createElement("ul", { class: "tsd-nested-navigation" }, children.map((c) => (utils_1.JSX.createElement("li", null, links(c))))))));
     }
-}
-exports.primaryNavigation = primaryNavigation;
-function secondaryNavigation(context, props) {
-    // Multiple entry points, and on main project page.
-    if (props.model.isProject() && props.model.getChildrenByKind(models_1.ReflectionKind.Module).length) {
-        return;
+    function link(child, nameClasses) {
+        return (utils_1.JSX.createElement("a", { href: context.urlTo(child), class: (0, lib_1.classNames)({ current: child === props.model }, nameClasses) },
+            context.icons[child.kind](),
+            utils_1.JSX.createElement("span", null, (0, lib_1.wbr)((0, lib_1.getDisplayName)(child)))));
     }
-    const effectivePageParent = (props.model instanceof models_1.ContainerReflection && props.model.children?.length) || props.model.isProject()
-        ? props.model
-        : props.model.parent;
-    const children = effectivePageParent.children || [];
-    const pageNavigation = children
-        .filter((child) => !child.kindOf(models_1.ReflectionKind.SomeModule))
-        .map((child) => {
-        return (utils_1.JSX.createElement("li", { class: (0, lib_1.classNames)({ deprecated: child.isDeprecated(), current: props.model === child }, context.getReflectionClasses(child)) },
-            utils_1.JSX.createElement("a", { href: context.urlTo(child), class: "tsd-index-link" },
-                context.icons[child.kind](),
-                utils_1.JSX.createElement("span", null, (0, lib_1.renderName)(child)))));
-    });
-    if (effectivePageParent.kindOf(models_1.ReflectionKind.SomeModule | models_1.ReflectionKind.Project)) {
-        return (utils_1.JSX.createElement("nav", { class: "tsd-navigation secondary menu-sticky" }, !!pageNavigation.length && utils_1.JSX.createElement("ul", null, pageNavigation)));
+    function inPath(mod) {
+        let iter = props.model;
+        do {
+            if (iter == mod)
+                return true;
+            iter = iter.parent;
+        } while (iter);
+        return false;
     }
-    return (utils_1.JSX.createElement("nav", { class: "tsd-navigation secondary menu-sticky" },
-        utils_1.JSX.createElement("ul", null,
-            utils_1.JSX.createElement("li", { class: (0, lib_1.classNames)({
-                    deprecated: effectivePageParent.isDeprecated(),
-                    current: effectivePageParent === props.model,
-                }, effectivePageParent instanceof models_1.DeclarationReflection
-                    ? context.getReflectionClasses(effectivePageParent)
-                    : "") },
-                utils_1.JSX.createElement("a", { href: context.urlTo(effectivePageParent), class: "tsd-index-link" },
-                    context.icons[effectivePageParent.kind](),
-                    utils_1.JSX.createElement("span", null, (0, lib_1.renderName)(effectivePageParent))),
-                !!pageNavigation.length && utils_1.JSX.createElement("ul", null, pageNavigation)))));
 }
-exports.secondaryNavigation = secondaryNavigation;
-function inPath(thisPage, toCheck) {
-    while (toCheck) {
-        if (toCheck.isProject())
-            return false;
-        if (thisPage === toCheck)
-            return true;
-        toCheck = toCheck.parent;
+exports.navigation = navigation;
+function pageSidebar(context, props) {
+    return (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
+        context.settings(),
+        context.pageNavigation(props)));
+}
+exports.pageSidebar = pageSidebar;
+function pageNavigation(context, props) {
+    const levels = [[]];
+    function finalizeLevel() {
+        const built = (utils_1.JSX.createElement("ul", null, levels.pop().map((l) => (utils_1.JSX.createElement("li", null, l)))));
+        levels[levels.length - 1].push(built);
+    }
+    for (const heading of props.pageHeadings) {
+        const inferredLevel = heading.level ? heading.level + 1 : 1;
+        while (inferredLevel < levels.length) {
+            finalizeLevel();
+        }
+        if (inferredLevel > levels.length) {
+            // Lower level than before
+            levels.push([]);
+        }
+        levels[levels.length - 1].push(utils_1.JSX.createElement("a", { href: heading.link, class: heading.classes },
+            heading.kind && context.icons[heading.kind](),
+            utils_1.JSX.createElement("span", null, (0, lib_1.wbr)(heading.text))));
+    }
+    while (levels.length > 1) {
+        finalizeLevel();
+    }
+    if (!levels[0].length) {
+        return utils_1.JSX.createElement(utils_1.JSX.Fragment, null);
     }
-    return false;
+    return (utils_1.JSX.createElement("details", { open: true, class: "tsd-index-accordion tsd-page-navigation" },
+        utils_1.JSX.createElement("summary", { class: "tsd-accordion-summary" },
+            utils_1.JSX.createElement("h3", null,
+                context.icons.chevronDown(),
+                "On This Page")),
+        utils_1.JSX.createElement("div", { class: "tsd-accordion-details" },
+            utils_1.JSX.createElement("ul", null, levels[0].map((l) => (utils_1.JSX.createElement("li", null, l)))))));
 }
+exports.pageNavigation = pageNavigation;

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

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.toolbar = void 0;
 const utils_1 = require("../../../../utils");
+const lib_1 = require("../../lib");
 const toolbar = (context, props) => (utils_1.JSX.createElement("header", { class: "tsd-page-toolbar" },
     utils_1.JSX.createElement("div", { class: "tsd-toolbar-contents container" },
         utils_1.JSX.createElement("div", { class: "table-cell", id: "tsd-search", "data-base": context.relativeURL("./") },
@@ -13,7 +14,7 @@ const toolbar = (context, props) => (utils_1.JSX.createElement("header", { class
             utils_1.JSX.createElement("ul", { class: "results" },
                 utils_1.JSX.createElement("li", { class: "state loading" }, "Preparing search index..."),
                 utils_1.JSX.createElement("li", { class: "state failure" }, "The search index is not available")),
-            utils_1.JSX.createElement("a", { href: context.options.getValue("titleLink") || context.relativeURL("index.html"), class: "title" }, props.project.name)),
+            utils_1.JSX.createElement("a", { href: context.options.getValue("titleLink") || context.relativeURL("index.html"), class: "title" }, (0, lib_1.getDisplayName)(props.project))),
         utils_1.JSX.createElement("div", { class: "table-cell", id: "tsd-widgets" },
             utils_1.JSX.createElement("a", { href: "#", class: "tsd-widget tsd-toolbar-icon menu no-caption", "data-toggle": "menu", "aria-label": "Menu" }, context.icons.menu())))));
 exports.toolbar = toolbar;

package/dist/lib/serialization/schema.d.ts

@@ -26,6 +26,7 @@
  *
  * For documentation on the JSON output properties, view the corresponding model.
  * @module
+ * @internal
  */
 import type * as M from "../models";
 /**
@@ -182,6 +183,7 @@ export interface InlineTagDisplayPart {
     tag: `@${string}`;
     text: string;
     target?: string | number | ReflectionSymbolId;
+    tsLinkText?: string;
 }
 export interface SourceReference extends S<M.SourceReference, "fileName" | "line" | "character" | "url"> {
 }

package/dist/lib/serialization/schema.js

@@ -27,5 +27,6 @@
  *
  * For documentation on the JSON output properties, view the corresponding model.
  * @module
+ * @internal
  */
 Object.defineProperty(exports, "__esModule", { value: true });

package/dist/lib/serialization/serializer.d.ts

@@ -15,7 +15,7 @@ export declare class Serializer extends EventDispatcher {
     static EVENT_END: string;
     private serializers;
     /**
-     * Only set after resolve.
+     * Only set when serializing.
      */
     projectRoot: string;
     addSerializer(serializer: SerializerComponent<any>): void;

package/dist/lib/utils/entry-point.d.ts

@@ -7,7 +7,7 @@ import type { Options } from "./options";
  */
 export declare const EntryPointStrategy: {
     /**
-     * The default behavior in v0.22-v0.23, expects all provided entry points as being part of a single program.
+     * The default behavior in v0.22+, expects all provided entry points as being part of a single program.
      * Any directories included in the entry point list will result in `dir/index.([cm][tj]s|[tj]sx?)` being used.
      */
     readonly Resolve: "resolve";
@@ -17,8 +17,8 @@ export declare const EntryPointStrategy: {
      */
     readonly Expand: "expand";
     /**
-     * Run TypeDoc in each directory passed as an entry point, and save the json result to `.typedoc/<project>`
-     * Once all have been saved, use the merge option to produce final output.
+     * Run TypeDoc in each directory passed as an entry point. Once all directories have been converted,
+     * use the merge option to produce final output.
      */
     readonly Packages: "packages";
     /**

package/dist/lib/utils/entry-point.js

@@ -42,7 +42,7 @@ const general_1 = require("./general");
  */
 exports.EntryPointStrategy = {
     /**
-     * The default behavior in v0.22-v0.23, expects all provided entry points as being part of a single program.
+     * The default behavior in v0.22+, expects all provided entry points as being part of a single program.
      * Any directories included in the entry point list will result in `dir/index.([cm][tj]s|[tj]sx?)` being used.
      */
     Resolve: "resolve",
@@ -52,8 +52,8 @@ exports.EntryPointStrategy = {
      */
     Expand: "expand",
     /**
-     * Run TypeDoc in each directory passed as an entry point, and save the json result to `.typedoc/<project>`
-     * Once all have been saved, use the merge option to produce final output.
+     * Run TypeDoc in each directory passed as an entry point. Once all directories have been converted,
+     * use the merge option to produce final output.
      */
     Packages: "packages",
     /**
@@ -315,7 +315,7 @@ function getEntryPointsForLegacyPackages(logger, packageGlobPaths, options) {
         results.push({
             displayName: typedocPackageConfig?.displayName ?? packageName,
             version: includeVersion
-                ? packageJson["version"]
+                ? packageJson["version"]?.replace(/^v/, "")
                 : void 0,
             readmeFile: discoverReadmeFile(logger, Path.join(packageJsonPath, ".."), typedocPackageConfig?.readmeFile),
             program,

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

@@ -53,6 +53,10 @@ export declare function discoverInParentDir<T extends {}>(name: string, dir: str
     file: string;
     content: T;
 } | undefined;
+export declare function discoverInParentDirExactMatch<T extends {}>(name: string, dir: string, read: (content: string) => T | undefined): {
+    file: string;
+    content: T;
+} | undefined;
 export declare function discoverPackageJson(dir: string): {
     file: string;
     content: {
@@ -61,3 +65,4 @@ export declare function discoverPackageJson(dir: string): {
         name: string;
     };
 } | undefined;
+export declare function findPackageForPath(sourcePath: string): string | undefined;