typedoc 0.25.13 → 0.26.0-beta.0

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

@@ -106,17 +106,18 @@ class ProjectReflection extends container_1.ContainerReflection {
             if (child !== reflection) {
                 return true; // Continue iteration
             }
-            if (property === abstract_1.TraverseProperty.Children) {
-                (0, utils_1.removeIfPresent)(parent.children, reflection);
-                if (!parent.children?.length) {
-                    delete parent.children;
-                }
+            if (property === abstract_1.TraverseProperty.Children ||
+                property == abstract_1.TraverseProperty.Documents) {
+                parent.removeChild(reflection);
             }
             else if (property === abstract_1.TraverseProperty.GetSignature) {
                 delete parent.getSignature;
             }
             else if (property === abstract_1.TraverseProperty.IndexSignature) {
-                delete parent.indexSignature;
+                (0, utils_1.removeIfPresent)(parent.indexSignatures, reflection);
+                if (!parent.indexSignatures?.length) {
+                    delete parent.indexSignatures;
+                }
             }
             else if (property === abstract_1.TraverseProperty.Parameters) {
                 (0, utils_1.removeIfPresent)(reflection.parent.parameters, reflection);
@@ -292,7 +293,7 @@ class ProjectReflection extends container_1.ContainerReflection {
                     this.registerSymbolId(refl, new ReflectionSymbolId_1.ReflectionSymbolId(sid));
                 }
                 else {
-                    de.logger.warn(`Serialized project contained a reflection with id ${id} but it was not present in deserialized project.`);
+                    de.logger.warn(de.application.i18n.serialized_project_referenced_0_not_part_of_project(id.toString()));
                 }
             }
         });

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

@@ -1,5 +1,5 @@
-import { SomeType, ReferenceType } from "../types";
-import { Reflection, TraverseCallback } from "./abstract";
+import { type SomeType, type ReferenceType } from "../types";
+import { Reflection, type TraverseCallback } from "./abstract";
 import type { ParameterReflection } from "./parameter";
 import type { TypeParameterReflection } from "./type-parameter";
 import type { DeclarationReflection } from "./declaration";

package/dist/lib/models/reflections/type-parameter.d.ts

@@ -1,5 +1,5 @@
 import type { SomeType } from "../types";
-import { Reflection, TraverseCallback } from "./abstract";
+import { Reflection, type TraverseCallback } from "./abstract";
 import type { DeclarationReflection } from "./declaration";
 import type { Serializer, JSONOutput, Deserializer } from "../../serialization";
 import type { SignatureReflection } from "./signature";

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.splitUnquotedString = void 0;
+exports.splitUnquotedString = splitUnquotedString;
 function splitUnquotedString(input, delimiter) {
     if (input.startsWith(delimiter)) {
         return splitUnquotedString(input.substring(delimiter.length), delimiter);
@@ -27,4 +27,3 @@ function splitUnquotedString(input, delimiter) {
         return input.split(delimiter);
     }
 }
-exports.splitUnquotedString = splitUnquotedString;

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

@@ -1,4 +1,5 @@
 import type { DeclarationReflection } from "./declaration";
+import type { DocumentReflection } from "./document";
 import type { ParameterReflection } from "./parameter";
 import type { ProjectReflection } from "./project";
 import type { ReferenceReflection } from "./reference";
@@ -15,4 +16,5 @@ export interface ReflectionVariant {
     reference: ReferenceReflection;
     signature: SignatureReflection;
     typeParam: TypeParameterReflection;
+    document: DocumentReflection;
 }

package/dist/lib/models/types.d.ts

@@ -228,11 +228,11 @@ export declare class MappedType extends Type {
     parameter: string;
     parameterType: SomeType;
     templateType: SomeType;
-    readonlyModifier?: "+" | "-" | undefined;
-    optionalModifier?: "+" | "-" | undefined;
+    readonlyModifier?: ("+" | "-") | undefined;
+    optionalModifier?: ("+" | "-") | undefined;
     nameType?: SomeType | undefined;
     readonly type = "mapped";
-    constructor(parameter: string, parameterType: SomeType, templateType: SomeType, readonlyModifier?: "+" | "-" | undefined, optionalModifier?: "+" | "-" | undefined, nameType?: SomeType | undefined);
+    constructor(parameter: string, parameterType: SomeType, templateType: SomeType, readonlyModifier?: ("+" | "-") | undefined, optionalModifier?: ("+" | "-") | undefined, nameType?: SomeType | undefined);
     protected getTypeString(): string;
     needsParenthesis(): boolean;
     toObject(serializer: Serializer): JSONOutput.MappedType;
@@ -402,7 +402,7 @@ export declare class ReflectionType extends Type {
     declaration: DeclarationReflection;
     readonly type = "reflection";
     constructor(declaration: DeclarationReflection);
-    protected getTypeString(): "Object" | "Function";
+    protected getTypeString(): "Function" | "Object";
     needsParenthesis(): boolean;
     toObject(serializer: Serializer): JSONOutput.ReflectionType;
 }

package/dist/lib/models/types.js

@@ -23,7 +23,8 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UnknownType = exports.UnionType = exports.TypeOperatorType = exports.NamedTupleMember = exports.TupleType = exports.TemplateLiteralType = exports.RestType = exports.ReflectionType = exports.ReferenceType = exports.QueryType = exports.PredicateType = exports.OptionalType = exports.MappedType = exports.LiteralType = exports.IntrinsicType = exports.IntersectionType = exports.InferredType = exports.IndexedAccessType = exports.ConditionalType = exports.ArrayType = exports.TypeContext = exports.makeRecursiveVisitor = exports.Type = void 0;
+exports.UnknownType = exports.UnionType = exports.TypeOperatorType = exports.NamedTupleMember = exports.TupleType = exports.TemplateLiteralType = exports.RestType = exports.ReflectionType = exports.ReferenceType = exports.QueryType = exports.PredicateType = exports.OptionalType = exports.MappedType = exports.LiteralType = exports.IntrinsicType = exports.IntersectionType = exports.InferredType = exports.IndexedAccessType = exports.ConditionalType = exports.ArrayType = exports.TypeContext = exports.Type = void 0;
+exports.makeRecursiveVisitor = makeRecursiveVisitor;
 const ts = __importStar(require("typescript"));
 const tsutils_1 = require("../utils/tsutils");
 const ReflectionSymbolId_1 = require("./reflections/ReflectionSymbolId");
@@ -144,7 +145,6 @@ function makeRecursiveVisitor(visitor) {
     };
     return recursiveVisitor;
 }
-exports.makeRecursiveVisitor = makeRecursiveVisitor;
 /**
  * Enumeration that can be used when traversing types to track the location of recursion.
  * Used by TypeDoc internally to track when to output parenthesis when rendering.
@@ -826,7 +826,7 @@ class ReferenceType extends Type {
                     this._target = target.id;
                 }
                 else {
-                    de.logger.warn(`Serialized project contained a reference to ${obj.target} (${this.qualifiedName}), which was not a part of the project.`);
+                    de.logger.warn(de.application.i18n.serialized_project_referenced_0_not_part_of_project(obj.target.toString()));
                 }
             });
         }

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

@@ -1,7 +1,7 @@
 import { Event } from "../utils/events";
 import type { ProjectReflection } from "../models/reflections/project";
 import type { RenderTemplate, UrlMapping } from "./models/UrlMapping";
-import type { DeclarationReflection, Reflection, ReflectionKind } from "../models";
+import type { DeclarationReflection, DocumentReflection, Reflection, ReflectionKind } from "../models";
 /**
  * An event emitted by the {@link Renderer} class at the very beginning and
  * ending of the entire rendering process.
@@ -145,17 +145,17 @@ export declare class IndexEvent extends Event {
      * same index from {@link searchFields}. The {@link removeResult} helper
      * will do this for you.
      */
-    searchResults: DeclarationReflection[];
+    searchResults: Array<DeclarationReflection | DocumentReflection>;
     /**
      * Additional search fields to be used when creating the search index.
-     * `name` and `comment` may be specified to overwrite TypeDoc's search fields.
+     * `name`, `comment` and `document` may be specified to overwrite TypeDoc's search fields.
      *
      * Do not use `id` as a custom search field.
      */
     searchFields: Record<string, string>[];
     /**
      * Weights for the fields defined in `searchFields`. The default will weight
-     * `name` as 10x more important than comment content.
+     * `name` as 10x more important than comment and document content.
      *
      * If a field added to {@link searchFields} is not added to this object, it
      * will **not** be searchable.
@@ -168,5 +168,5 @@ export declare class IndexEvent extends Event {
      * Remove a search result by index.
      */
     removeResult(index: number): void;
-    constructor(name: string, searchResults: DeclarationReflection[]);
+    constructor(name: string, searchResults: Array<DeclarationReflection | DocumentReflection>);
 }

package/dist/lib/output/events.js

@@ -134,7 +134,7 @@ class IndexEvent extends events_1.Event {
         super(name);
         /**
          * Weights for the fields defined in `searchFields`. The default will weight
-         * `name` as 10x more important than comment content.
+         * `name` as 10x more important than comment and document content.
          *
          * If a field added to {@link searchFields} is not added to this object, it
          * will **not** be searchable.
@@ -145,6 +145,7 @@ class IndexEvent extends events_1.Event {
         this.searchFieldWeights = {
             name: 10,
             comment: 1,
+            document: 1,
         };
         this.searchResults = searchResults;
         this.searchFields = Array.from({ length: this.searchResults.length }, () => ({}));

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

@@ -4,5 +4,5 @@ export type { RenderTemplate } from "./models/UrlMapping";
 export { Renderer } from "./renderer";
 export type { RendererHooks } from "./renderer";
 export { Theme } from "./theme";
-export { DefaultTheme, type NavigationElement, } from "./themes/default/DefaultTheme";
+export { DefaultTheme, Slugger, type NavigationElement, } from "./themes/default/DefaultTheme";
 export { DefaultThemeRenderContext } from "./themes/default/DefaultThemeRenderContext";

package/dist/lib/output/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DefaultThemeRenderContext = exports.DefaultTheme = exports.Theme = exports.Renderer = exports.UrlMapping = exports.IndexEvent = exports.MarkdownEvent = exports.RendererEvent = exports.PageEvent = void 0;
+exports.DefaultThemeRenderContext = exports.Slugger = exports.DefaultTheme = exports.Theme = exports.Renderer = exports.UrlMapping = exports.IndexEvent = exports.MarkdownEvent = exports.RendererEvent = exports.PageEvent = void 0;
 var events_1 = require("./events");
 Object.defineProperty(exports, "PageEvent", { enumerable: true, get: function () { return events_1.PageEvent; } });
 Object.defineProperty(exports, "RendererEvent", { enumerable: true, get: function () { return events_1.RendererEvent; } });
@@ -14,5 +14,6 @@ var theme_1 = require("./theme");
 Object.defineProperty(exports, "Theme", { enumerable: true, get: function () { return theme_1.Theme; } });
 var DefaultTheme_1 = require("./themes/default/DefaultTheme");
 Object.defineProperty(exports, "DefaultTheme", { enumerable: true, get: function () { return DefaultTheme_1.DefaultTheme; } });
+Object.defineProperty(exports, "Slugger", { enumerable: true, get: function () { return DefaultTheme_1.Slugger; } });
 var DefaultThemeRenderContext_1 = require("./themes/default/DefaultThemeRenderContext");
 Object.defineProperty(exports, "DefaultThemeRenderContext", { enumerable: true, get: function () { return DefaultThemeRenderContext_1.DefaultThemeRenderContext; } });

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

@@ -89,7 +89,7 @@ let AssetsPlugin = (() => {
                             (0, fs_1.copySync)(this.customCss, (0, path_1.join)(dest, "custom.css"));
                         }
                         else {
-                            this.application.logger.error(`Custom CSS file at ${this.customCss} does not exist.`);
+                            this.application.logger.error(this.application.i18n.custom_css_file_0_does_not_exist(this.customCss));
                             event.preventDefault();
                         }
                     }

package/dist/lib/output/plugins/JavascriptIndexPlugin.d.ts

@@ -5,7 +5,8 @@ import { RendererComponent } from "../components";
  * The resulting javascript file can be used to build a simple search function.
  */
 export declare class JavascriptIndexPlugin extends RendererComponent {
-    accessor searchComments: boolean;
+    private accessor searchComments;
+    private accessor searchDocuments;
     /**
      * Create a new JavascriptIndexPlugin instance.
      */
@@ -18,4 +19,5 @@ export declare class JavascriptIndexPlugin extends RendererComponent {
     private onRendererBegin;
     private buildSearchIndex;
     private getCommentSearchText;
+    private getDocumentSearchText;
 }

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

@@ -89,7 +89,7 @@ const gzipP = (0, util_1.promisify)(zlib_1.gzip);
  * The resulting javascript file can be used to build a simple search function.
  */
 let JavascriptIndexPlugin = (() => {
-    var _JavascriptIndexPlugin_searchComments_accessor_storage;
+    var _JavascriptIndexPlugin_searchComments_accessor_storage, _JavascriptIndexPlugin_searchDocuments_accessor_storage;
     let _classDecorators = [(0, components_1.Component)({ name: "javascript-index" })];
     let _classDescriptor;
     let _classExtraInitializers = [];
@@ -98,9 +98,14 @@ let JavascriptIndexPlugin = (() => {
     let _searchComments_decorators;
     let _searchComments_initializers = [];
     let _searchComments_extraInitializers = [];
+    let _searchDocuments_decorators;
+    let _searchDocuments_initializers = [];
+    let _searchDocuments_extraInitializers = [];
     var JavascriptIndexPlugin = _classThis = class extends _classSuper {
         get searchComments() { return __classPrivateFieldGet(this, _JavascriptIndexPlugin_searchComments_accessor_storage, "f"); }
         set searchComments(value) { __classPrivateFieldSet(this, _JavascriptIndexPlugin_searchComments_accessor_storage, value, "f"); }
+        get searchDocuments() { return __classPrivateFieldGet(this, _JavascriptIndexPlugin_searchDocuments_accessor_storage, "f"); }
+        set searchDocuments(value) { __classPrivateFieldSet(this, _JavascriptIndexPlugin_searchDocuments_accessor_storage, value, "f"); }
         /**
          * Create a new JavascriptIndexPlugin instance.
          */
@@ -125,7 +130,8 @@ let JavascriptIndexPlugin = (() => {
             const theme = this.owner.theme;
             const rows = [];
             const initialSearchResults = Object.values(event.project.reflections).filter((refl) => {
-                return (refl instanceof models_1.DeclarationReflection &&
+                return ((refl instanceof models_1.DeclarationReflection ||
+                    refl instanceof models_1.DocumentReflection) &&
                     refl.url &&
                     refl.name &&
                     !refl.flags.isExternal);
@@ -165,6 +171,7 @@ let JavascriptIndexPlugin = (() => {
                 builder.add({
                     name: reflection.name,
                     comment: this.getCommentSearchText(reflection),
+                    document: this.getDocumentSearchText(reflection),
                     ...indexEvent.searchFields[rows.length],
                     id: rows.length,
                 }, { boost });
@@ -185,11 +192,13 @@ let JavascriptIndexPlugin = (() => {
             const comments = [];
             if (reflection.comment)
                 comments.push(reflection.comment);
-            reflection.signatures?.forEach((s) => s.comment && comments.push(s.comment));
-            reflection.getSignature?.comment &&
-                comments.push(reflection.getSignature.comment);
-            reflection.setSignature?.comment &&
-                comments.push(reflection.setSignature.comment);
+            if (reflection.isDeclaration()) {
+                reflection.signatures?.forEach((s) => s.comment && comments.push(s.comment));
+                reflection.getSignature?.comment &&
+                    comments.push(reflection.getSignature.comment);
+                reflection.setSignature?.comment &&
+                    comments.push(reflection.setSignature.comment);
+            }
             if (!comments.length) {
                 return;
             }
@@ -200,18 +209,29 @@ let JavascriptIndexPlugin = (() => {
                 .map((part) => part.text)
                 .join("\n");
         }
+        getDocumentSearchText(reflection) {
+            if (!this.searchDocuments)
+                return;
+            if (reflection.isDocument()) {
+                return reflection.content.flatMap((c) => c.text).join("\n");
+            }
+        }
         constructor() {
             super(...arguments);
             _JavascriptIndexPlugin_searchComments_accessor_storage.set(this, __runInitializers(this, _searchComments_initializers, void 0));
-            __runInitializers(this, _searchComments_extraInitializers);
+            _JavascriptIndexPlugin_searchDocuments_accessor_storage.set(this, (__runInitializers(this, _searchComments_extraInitializers), __runInitializers(this, _searchDocuments_initializers, void 0)));
+            __runInitializers(this, _searchDocuments_extraInitializers);
         }
     };
     _JavascriptIndexPlugin_searchComments_accessor_storage = new WeakMap();
+    _JavascriptIndexPlugin_searchDocuments_accessor_storage = new WeakMap();
     __setFunctionName(_classThis, "JavascriptIndexPlugin");
     (() => {
         const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(_classSuper[Symbol.metadata] ?? null) : void 0;
         _searchComments_decorators = [(0, utils_1.Option)("searchInComments")];
+        _searchDocuments_decorators = [(0, utils_1.Option)("searchInDocuments")];
         __esDecorate(_classThis, null, _searchComments_decorators, { kind: "accessor", name: "searchComments", static: false, private: false, access: { has: obj => "searchComments" in obj, get: obj => obj.searchComments, set: (obj, value) => { obj.searchComments = value; } }, metadata: _metadata }, _searchComments_initializers, _searchComments_extraInitializers);
+        __esDecorate(_classThis, null, _searchDocuments_decorators, { kind: "accessor", name: "searchDocuments", static: false, private: false, access: { has: obj => "searchDocuments" in obj, get: obj => obj.searchDocuments, set: (obj, value) => { obj.searchDocuments = value; } }, metadata: _metadata }, _searchDocuments_initializers, _searchDocuments_extraInitializers);
         __esDecorate(null, _classDescriptor = { value: _classThis }, _classDecorators, { kind: "class", name: _classThis.name, metadata: _metadata }, null, _classExtraInitializers);
         JavascriptIndexPlugin = _classThis = _classDescriptor.value;
         if (_metadata) Object.defineProperty(_classThis, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });

package/dist/lib/output/plugins/SitemapPlugin.d.ts

@@ -1,6 +1,6 @@
 import { RendererComponent } from "../components";
 export declare class SitemapPlugin extends RendererComponent {
-    accessor sitemapBaseUrl: string;
+    accessor hostedBaseUrl: string;
     initialize(): void;
     private onRendererBegin;
     private buildSitemap;

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

@@ -59,19 +59,20 @@ const events_1 = require("../events");
 const DefaultTheme_1 = require("../themes/default/DefaultTheme");
 const utils_1 = require("../../utils");
 const html_1 = require("../../utils/html");
+const jsx_1 = require("../../utils/jsx");
 let SitemapPlugin = (() => {
-    var _SitemapPlugin_sitemapBaseUrl_accessor_storage;
+    var _SitemapPlugin_hostedBaseUrl_accessor_storage;
     let _classDecorators = [(0, components_1.Component)({ name: "sitemap" })];
     let _classDescriptor;
     let _classExtraInitializers = [];
     let _classThis;
     let _classSuper = components_1.RendererComponent;
-    let _sitemapBaseUrl_decorators;
-    let _sitemapBaseUrl_initializers = [];
-    let _sitemapBaseUrl_extraInitializers = [];
+    let _hostedBaseUrl_decorators;
+    let _hostedBaseUrl_initializers = [];
+    let _hostedBaseUrl_extraInitializers = [];
     var SitemapPlugin = _classThis = class extends _classSuper {
-        get sitemapBaseUrl() { return __classPrivateFieldGet(this, _SitemapPlugin_sitemapBaseUrl_accessor_storage, "f"); }
-        set sitemapBaseUrl(value) { __classPrivateFieldSet(this, _SitemapPlugin_sitemapBaseUrl_accessor_storage, value, "f"); }
+        get hostedBaseUrl() { return __classPrivateFieldGet(this, _SitemapPlugin_hostedBaseUrl_accessor_storage, "f"); }
+        set hostedBaseUrl(value) { __classPrivateFieldSet(this, _SitemapPlugin_hostedBaseUrl_accessor_storage, value, "f"); }
         initialize() {
             this.listenTo(this.owner, events_1.RendererEvent.BEGIN, this.onRendererBegin);
         }
@@ -79,9 +80,19 @@ let SitemapPlugin = (() => {
             if (!(this.owner.theme instanceof DefaultTheme_1.DefaultTheme)) {
                 return;
             }
-            if (event.isDefaultPrevented || !this.sitemapBaseUrl) {
+            if (event.isDefaultPrevented || !this.hostedBaseUrl) {
                 return;
             }
+            this.owner.hooks.on("head.begin", (context) => {
+                if (context.page.url === "index.html") {
+                    return {
+                        tag: "link",
+                        props: { rel: "canonical", href: this.hostedBaseUrl },
+                        children: [],
+                    };
+                }
+                return { tag: jsx_1.Fragment, props: null, children: [] };
+            });
             this.owner.preRenderAsyncJobs.push((event) => this.buildSitemap(event));
         }
         async buildSitemap(event) {
@@ -94,7 +105,7 @@ let SitemapPlugin = (() => {
                     children: [
                         {
                             tag: "loc",
-                            children: new URL(url.url, this.sitemapBaseUrl).toString(),
+                            children: new URL(url.url, this.hostedBaseUrl).toString(),
                         },
                         {
                             tag: "lastmod",
@@ -114,16 +125,16 @@ let SitemapPlugin = (() => {
         }
         constructor() {
             super(...arguments);
-            _SitemapPlugin_sitemapBaseUrl_accessor_storage.set(this, __runInitializers(this, _sitemapBaseUrl_initializers, void 0));
-            __runInitializers(this, _sitemapBaseUrl_extraInitializers);
+            _SitemapPlugin_hostedBaseUrl_accessor_storage.set(this, __runInitializers(this, _hostedBaseUrl_initializers, void 0));
+            __runInitializers(this, _hostedBaseUrl_extraInitializers);
         }
     };
-    _SitemapPlugin_sitemapBaseUrl_accessor_storage = new WeakMap();
+    _SitemapPlugin_hostedBaseUrl_accessor_storage = new WeakMap();
     __setFunctionName(_classThis, "SitemapPlugin");
     (() => {
         const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(_classSuper[Symbol.metadata] ?? null) : void 0;
-        _sitemapBaseUrl_decorators = [(0, utils_1.Option)("sitemapBaseUrl")];
-        __esDecorate(_classThis, null, _sitemapBaseUrl_decorators, { kind: "accessor", name: "sitemapBaseUrl", static: false, private: false, access: { has: obj => "sitemapBaseUrl" in obj, get: obj => obj.sitemapBaseUrl, set: (obj, value) => { obj.sitemapBaseUrl = value; } }, metadata: _metadata }, _sitemapBaseUrl_initializers, _sitemapBaseUrl_extraInitializers);
+        _hostedBaseUrl_decorators = [(0, utils_1.Option)("hostedBaseUrl")];
+        __esDecorate(_classThis, null, _hostedBaseUrl_decorators, { kind: "accessor", name: "hostedBaseUrl", static: false, private: false, access: { has: obj => "hostedBaseUrl" in obj, get: obj => obj.hostedBaseUrl, set: (obj, value) => { obj.hostedBaseUrl = value; } }, metadata: _metadata }, _hostedBaseUrl_initializers, _hostedBaseUrl_extraInitializers);
         __esDecorate(null, _classDescriptor = { value: _classThis }, _classDecorators, { kind: "class", name: _classThis.name, metadata: _metadata }, null, _classExtraInitializers);
         SitemapPlugin = _classThis = _classDescriptor.value;
         if (_metadata) Object.defineProperty(_classThis, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });

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

@@ -5,7 +5,7 @@ import type { ProjectReflection } from "../models/reflections/project";
 import { RendererComponent } from "./components";
 import { ChildableComponent } from "../utils/component";
 import { EventHooks } from "../utils";
-import type { Theme as ShikiTheme } from "shiki";
+import type { BundledTheme as ShikiTheme } from "shiki" with { "resolution-mode": "import" };
 import type { JsxElement } from "../utils/jsx.elements";
 import type { DefaultThemeRenderContext } from "./themes/default/DefaultThemeRenderContext";
 /**

package/dist/lib/output/renderer.js

@@ -307,7 +307,7 @@ let Renderer = (() => {
                 (0, fs_1.writeFileSync)(page.filename, page.contents);
             }
             catch (error) {
-                this.application.logger.error(`Could not write ${page.filename}`);
+                this.application.logger.error(this.application.i18n.could_not_write_0(page.filename));
             }
         }
         /**
@@ -322,9 +322,7 @@ let Renderer = (() => {
             if (!this.theme) {
                 const ctor = this.themes.get(this.themeName);
                 if (!ctor) {
-                    this.application.logger.error(`The theme '${this.themeName}' is not defined. The available themes are: ${[
-                        ...this.themes.keys(),
-                    ].join(", ")}`);
+                    this.application.logger.error(this.application.i18n.theme_0_is_not_defined_available_are_1(this.themeName, [...this.themes.keys()].join(", ")));
                     return false;
                 }
                 else {
@@ -349,7 +347,7 @@ let Renderer = (() => {
                     });
                 }
                 catch (error) {
-                    this.application.logger.warn("Could not empty the output directory.");
+                    this.application.logger.warn(this.application.i18n.could_not_empty_output_directory_0(directory));
                     return false;
                 }
             }
@@ -357,7 +355,7 @@ let Renderer = (() => {
                 fs.mkdirSync(directory, { recursive: true });
             }
             catch (error) {
-                this.application.logger.error(`Could not create output directory ${directory}.`);
+                this.application.logger.error(this.application.i18n.could_not_create_output_directory_0(directory));
                 return false;
             }
             if (this.githubPages) {
@@ -368,7 +366,7 @@ let Renderer = (() => {
                     fs.writeFileSync(path.join(directory, ".nojekyll"), text);
                 }
                 catch (error) {
-                    this.application.logger.warn("Could not create .nojekyll file.");
+                    this.application.logger.warn(this.application.i18n.could_not_write_0(path.join(directory, ".nojekyll")));
                     return false;
                 }
             }

package/dist/lib/output/themes/MarkedPlugin.d.ts

@@ -1,33 +1,21 @@
 import { ContextAwareRendererComponent } from "../components";
-import { RendererEvent, MarkdownEvent, PageEvent } from "../events";
-import type { Theme } from "shiki";
+import { type RendererEvent, MarkdownEvent, type PageEvent } from "../events";
+import type { BundledTheme } from "shiki" with { "resolution-mode": "import" };
+import type { DefaultThemeRenderContext } from "..";
 /**
  * Implements markdown and relativeURL helpers for templates.
  * @internal
  */
 export declare class MarkedPlugin extends ContextAwareRendererComponent {
-    accessor includeSource: string;
-    accessor mediaSource: string;
-    accessor lightTheme: Theme;
-    accessor darkTheme: Theme;
+    accessor lightTheme: BundledTheme;
+    accessor darkTheme: BundledTheme;
+    private parser?;
     /**
-     * The path referenced files are located in.
+     * This needing to be here really feels hacky... probably some nicer way to do this.
+     * Revisit when adding support for arbitrary pages in 0.26.
      */
-    private includes?;
-    /**
-     * Path to the output media directory.
-     */
-    private mediaDirectory?;
-    /**
-     * The pattern used to find references in markdown.
-     */
-    private includePattern;
-    /**
-     * The pattern used to find media links.
-     */
-    private mediaPattern;
-    private sources?;
-    private outputFileName?;
+    private renderContext;
+    private lastHeaderSlug;
     /**
      * Create a new MarkedPlugin instance.
      */
@@ -46,19 +34,20 @@ export declare class MarkedPlugin extends ContextAwareRendererComponent {
      * @param text  The markdown string that should be parsed.
      * @returns The resulting html string.
      */
-    parseMarkdown(text: string, page: PageEvent<any>): string;
+    parseMarkdown(text: string, page: PageEvent<any>, context: DefaultThemeRenderContext): string;
     /**
      * Triggered before the renderer starts rendering a project.
      *
      * @param event  An event object describing the current render operation.
      */
     protected onBeginRenderer(event: RendererEvent): void;
+    private getSlugger;
     /**
      * Creates an object with options that are passed to the markdown parser.
      *
      * @returns The options object for the markdown parser.
      */
-    private createMarkedOptions;
+    private setupParser;
     /**
      * Triggered when {@link MarkedPlugin} parses a markdown string.
      *