typedoc 0.26.10 → 0.27.0-beta.0

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

@@ -1,15 +1,6 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SitemapPlugin = exports.NavigationPlugin = exports.JavascriptIndexPlugin = exports.IconsPlugin = exports.AssetsPlugin = exports.MarkedPlugin = void 0;
-var MarkedPlugin_1 = require("../themes/MarkedPlugin");
-Object.defineProperty(exports, "MarkedPlugin", { enumerable: true, get: function () { return MarkedPlugin_1.MarkedPlugin; } });
-var AssetsPlugin_1 = require("./AssetsPlugin");
-Object.defineProperty(exports, "AssetsPlugin", { enumerable: true, get: function () { return AssetsPlugin_1.AssetsPlugin; } });
-var IconsPlugin_1 = require("./IconsPlugin");
-Object.defineProperty(exports, "IconsPlugin", { enumerable: true, get: function () { return IconsPlugin_1.IconsPlugin; } });
-var JavascriptIndexPlugin_1 = require("./JavascriptIndexPlugin");
-Object.defineProperty(exports, "JavascriptIndexPlugin", { enumerable: true, get: function () { return JavascriptIndexPlugin_1.JavascriptIndexPlugin; } });
-var NavigationPlugin_1 = require("./NavigationPlugin");
-Object.defineProperty(exports, "NavigationPlugin", { enumerable: true, get: function () { return NavigationPlugin_1.NavigationPlugin; } });
-var SitemapPlugin_1 = require("./SitemapPlugin");
-Object.defineProperty(exports, "SitemapPlugin", { enumerable: true, get: function () { return SitemapPlugin_1.SitemapPlugin; } });
+export { MarkedPlugin } from "../themes/MarkedPlugin.js";
+export { AssetsPlugin } from "./AssetsPlugin.js";
+export { IconsPlugin } from "./IconsPlugin.js";
+export { JavascriptIndexPlugin } from "./JavascriptIndexPlugin.js";
+export { NavigationPlugin } from "./NavigationPlugin.js";
+export { SitemapPlugin } from "./SitemapPlugin.js";

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

@@ -1,13 +1,12 @@
-import type { Application } from "../application";
-import type { Theme } from "./theme";
-import { RendererEvent, PageEvent, IndexEvent, type MarkdownEvent } from "./events";
-import type { ProjectReflection } from "../models/reflections/project";
-import { RendererComponent } from "./components";
-import { ChildableComponent } from "../utils/component";
-import { EventHooks } from "../utils";
-import { type Comment, Reflection } from "../models";
-import type { JsxElement } from "../utils/jsx.elements";
-import type { DefaultThemeRenderContext } from "./themes/default/DefaultThemeRenderContext";
+import type { Application } from "../application.js";
+import type { Theme } from "./theme.js";
+import { RendererEvent, PageEvent, IndexEvent, type MarkdownEvent } from "./events.js";
+import type { ProjectReflection } from "../models/reflections/project.js";
+import { EventHooks, AbstractComponent } from "../utils/index.js";
+import { type Comment, Reflection } from "../models/index.js";
+import type { JsxElement } from "../utils/jsx.elements.js";
+import type { DefaultThemeRenderContext } from "./themes/default/DefaultThemeRenderContext.js";
+import { MarkedPlugin } from "./plugins/index.js";
 /**
  * Describes the hooks available to inject output in the default theme.
  * If the available hooks don't let you put something where you'd like, please open an issue!
@@ -114,9 +113,10 @@ export interface RendererEvents {
  *    Triggered when the JavascriptIndexPlugin is preparing the search index. Listeners receive
  *    an instance of {@link IndexEvent}.
  *
- * @document ../../../internal-docs/custom-themes.md
+ * @summary Writes HTML output from TypeDoc's models
+ * @group Common
  */
-export declare class Renderer extends ChildableComponent<Application, RendererComponent, RendererEvents> {
+export declare class Renderer extends AbstractComponent<Application, RendererEvents> {
     private themes;
     /** @event */
     static readonly EVENT_BEGIN_PAGE = "beginPage";
@@ -173,6 +173,8 @@ export declare class Renderer extends ChildableComponent<Application, RendererCo
     private accessor highlightLanguages;
     private accessor pretty;
     renderStartTime: number;
+    markedPlugin: MarkedPlugin;
+    constructor(owner: Application);
     /**
      * Define a new theme that can be used to render output.
      * This API will likely be changing at some point, to allow more easily overriding parts of the theme without
@@ -215,4 +217,3 @@ export declare class Renderer extends ChildableComponent<Application, RendererCo
      */
     private prepareOutputDirectory;
 }
-import "./plugins";

package/dist/lib/output/renderer.js

@@ -1,20 +1,3 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
 var __esDecorate = (this && this.__esDecorate) || function (ctor, descriptorIn, decorators, contextIn, initializers, extraInitializers) {
     function accept(f) { if (f !== void 0 && typeof f !== "function") throw new TypeError("Function expected"); return f; }
     var kind = contextIn.kind, key = kind === "getter" ? "get" : kind === "setter" ? "set" : "value";
@@ -49,30 +32,6 @@ var __runInitializers = (this && this.__runInitializers) || function (thisArg, i
     }
     return useValue ? value : void 0;
 };
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __setFunctionName = (this && this.__setFunctionName) || function (f, name, prefix) {
-    if (typeof name === "symbol") name = name.description ? "[".concat(name.description, "]") : "";
-    return Object.defineProperty(f, "name", { configurable: true, value: prefix ? "".concat(prefix, " ", name) : name });
-};
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
-    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
-};
-var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
-    if (kind === "m") throw new TypeError("Private method is not writable");
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
-    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Renderer = void 0;
 /**
  * Holds all logic used render and output the final documentation.
  *
@@ -81,18 +40,16 @@ exports.Renderer = void 0;
  * series of {@link RendererEvent} events. Instances of {@link BasePlugin} can listen to these events and
  * alter the generated output.
  */
-const fs = __importStar(require("fs"));
-const path = __importStar(require("path"));
-const events_1 = require("./events");
-const fs_1 = require("../utils/fs");
-const DefaultTheme_1 = require("./themes/default/DefaultTheme");
-const components_1 = require("./components");
-const component_1 = require("../utils/component");
-const utils_1 = require("../utils");
-const highlighter_1 = require("../utils/highlighter");
-const models_1 = require("../models");
-const type_1 = require("./themes/default/partials/type");
-const jsx_1 = require("../utils/jsx");
+import * as fs from "fs";
+import * as path from "path";
+import { RendererEvent, PageEvent, IndexEvent, } from "./events.js";
+import { writeFileSync } from "../utils/fs.js";
+import { DefaultTheme } from "./themes/default/DefaultTheme.js";
+import { Option, EventHooks, AbstractComponent } from "../utils/index.js";
+import { loadHighlighter } from "../utils/highlighter.js";
+import { Reflection } from "../models/index.js";
+import { setRenderSettings } from "../utils/jsx.js";
+import { AssetsPlugin, IconsPlugin, JavascriptIndexPlugin, MarkedPlugin, NavigationPlugin, SitemapPlugin, } from "./plugins/index.js";
 /**
  * The renderer processes a {@link ProjectReflection} using a {@link Theme} instance and writes
  * the emitted html documents to a output directory. You can specify which theme should be used
@@ -122,15 +79,11 @@ const jsx_1 = require("../utils/jsx");
  *    Triggered when the JavascriptIndexPlugin is preparing the search index. Listeners receive
  *    an instance of {@link IndexEvent}.
  *
- * @document ../../../internal-docs/custom-themes.md
+ * @summary Writes HTML output from TypeDoc's models
+ * @group Common
  */
 let Renderer = (() => {
-    var _Renderer_themeName_accessor_storage, _Renderer_cleanOutputDir_accessor_storage, _Renderer_cname_accessor_storage, _Renderer_githubPages_accessor_storage, _Renderer_cacheBust_accessor_storage, _Renderer_lightTheme_accessor_storage, _Renderer_darkTheme_accessor_storage, _Renderer_highlightLanguages_accessor_storage, _Renderer_pretty_accessor_storage;
-    let _classDecorators = [(0, component_1.Component)({ name: "renderer", internal: true, childClass: components_1.RendererComponent })];
-    let _classDescriptor;
-    let _classExtraInitializers = [];
-    let _classThis;
-    let _classSuper = component_1.ChildableComponent;
+    let _classSuper = AbstractComponent;
     let _themeName_decorators;
     let _themeName_initializers = [];
     let _themeName_extraInitializers = [];
@@ -158,72 +111,115 @@ let Renderer = (() => {
     let _pretty_decorators;
     let _pretty_initializers = [];
     let _pretty_extraInitializers = [];
-    var Renderer = _classThis = class extends _classSuper {
-        constructor() {
-            super(...arguments);
-            this.themes = new Map([
-                ["default", DefaultTheme_1.DefaultTheme],
-            ]);
-            /**
-             * A list of async jobs which must be completed *before* rendering output.
-             * They will be called after {@link RendererEvent.BEGIN} has fired, but before any files have been written.
-             *
-             * This may be used by plugins to register work that must be done to prepare output files. For example: asynchronously
-             * transform markdown to HTML.
-             *
-             * Note: This array is cleared after calling the contained functions on each {@link Renderer.render} call.
-             */
-            this.preRenderAsyncJobs = [];
-            /**
-             * A list of async jobs which must be completed after rendering output files but before generation is considered successful.
-             * These functions will be called after all documents have been written to the filesystem.
-             *
-             * This may be used by plugins to register work that must be done to finalize output files. For example: asynchronously
-             * generating an image referenced in a render hook.
-             *
-             * Note: This array is cleared after calling the contained functions on each {@link Renderer.render} call.
-             */
-            this.postRenderAsyncJobs = [];
-            /**
-             * Hooks which will be called when rendering pages.
-             * Note:
-             * - Hooks added during output will be discarded at the end of rendering.
-             * - Hooks added during a page render will be discarded at the end of that page's render.
-             *
-             * See {@link RendererHooks} for a description of each available hook, and when it will be called.
-             */
-            this.hooks = new utils_1.EventHooks();
-            _Renderer_themeName_accessor_storage.set(this, __runInitializers(this, _themeName_initializers, void 0));
-            _Renderer_cleanOutputDir_accessor_storage.set(this, (__runInitializers(this, _themeName_extraInitializers), __runInitializers(this, _cleanOutputDir_initializers, void 0)));
-            _Renderer_cname_accessor_storage.set(this, (__runInitializers(this, _cleanOutputDir_extraInitializers), __runInitializers(this, _cname_initializers, void 0)));
-            _Renderer_githubPages_accessor_storage.set(this, (__runInitializers(this, _cname_extraInitializers), __runInitializers(this, _githubPages_initializers, void 0)));
-            _Renderer_cacheBust_accessor_storage.set(this, (__runInitializers(this, _githubPages_extraInitializers), __runInitializers(this, _cacheBust_initializers, void 0)));
-            _Renderer_lightTheme_accessor_storage.set(this, (__runInitializers(this, _cacheBust_extraInitializers), __runInitializers(this, _lightTheme_initializers, void 0)));
-            _Renderer_darkTheme_accessor_storage.set(this, (__runInitializers(this, _lightTheme_extraInitializers), __runInitializers(this, _darkTheme_initializers, void 0)));
-            _Renderer_highlightLanguages_accessor_storage.set(this, (__runInitializers(this, _darkTheme_extraInitializers), __runInitializers(this, _highlightLanguages_initializers, void 0)));
-            _Renderer_pretty_accessor_storage.set(this, (__runInitializers(this, _highlightLanguages_extraInitializers), __runInitializers(this, _pretty_initializers, void 0)));
-            this.renderStartTime = (__runInitializers(this, _pretty_extraInitializers), -1);
+    return class Renderer extends _classSuper {
+        static {
+            const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(_classSuper[Symbol.metadata] ?? null) : void 0;
+            _themeName_decorators = [Option("theme")];
+            _cleanOutputDir_decorators = [Option("cleanOutputDir")];
+            _cname_decorators = [Option("cname")];
+            _githubPages_decorators = [Option("githubPages")];
+            _cacheBust_decorators = [Option("cacheBust")];
+            _lightTheme_decorators = [Option("lightHighlightTheme")];
+            _darkTheme_decorators = [Option("darkHighlightTheme")];
+            _highlightLanguages_decorators = [Option("highlightLanguages")];
+            _pretty_decorators = [Option("pretty")];
+            __esDecorate(this, null, _themeName_decorators, { kind: "accessor", name: "themeName", static: false, private: false, access: { has: obj => "themeName" in obj, get: obj => obj.themeName, set: (obj, value) => { obj.themeName = value; } }, metadata: _metadata }, _themeName_initializers, _themeName_extraInitializers);
+            __esDecorate(this, null, _cleanOutputDir_decorators, { kind: "accessor", name: "cleanOutputDir", static: false, private: false, access: { has: obj => "cleanOutputDir" in obj, get: obj => obj.cleanOutputDir, set: (obj, value) => { obj.cleanOutputDir = value; } }, metadata: _metadata }, _cleanOutputDir_initializers, _cleanOutputDir_extraInitializers);
+            __esDecorate(this, null, _cname_decorators, { kind: "accessor", name: "cname", static: false, private: false, access: { has: obj => "cname" in obj, get: obj => obj.cname, set: (obj, value) => { obj.cname = value; } }, metadata: _metadata }, _cname_initializers, _cname_extraInitializers);
+            __esDecorate(this, null, _githubPages_decorators, { kind: "accessor", name: "githubPages", static: false, private: false, access: { has: obj => "githubPages" in obj, get: obj => obj.githubPages, set: (obj, value) => { obj.githubPages = value; } }, metadata: _metadata }, _githubPages_initializers, _githubPages_extraInitializers);
+            __esDecorate(this, null, _cacheBust_decorators, { kind: "accessor", name: "cacheBust", static: false, private: false, access: { has: obj => "cacheBust" in obj, get: obj => obj.cacheBust, set: (obj, value) => { obj.cacheBust = value; } }, metadata: _metadata }, _cacheBust_initializers, _cacheBust_extraInitializers);
+            __esDecorate(this, null, _lightTheme_decorators, { kind: "accessor", name: "lightTheme", static: false, private: false, access: { has: obj => "lightTheme" in obj, get: obj => obj.lightTheme, set: (obj, value) => { obj.lightTheme = value; } }, metadata: _metadata }, _lightTheme_initializers, _lightTheme_extraInitializers);
+            __esDecorate(this, null, _darkTheme_decorators, { kind: "accessor", name: "darkTheme", static: false, private: false, access: { has: obj => "darkTheme" in obj, get: obj => obj.darkTheme, set: (obj, value) => { obj.darkTheme = value; } }, metadata: _metadata }, _darkTheme_initializers, _darkTheme_extraInitializers);
+            __esDecorate(this, null, _highlightLanguages_decorators, { kind: "accessor", name: "highlightLanguages", static: false, private: false, access: { has: obj => "highlightLanguages" in obj, get: obj => obj.highlightLanguages, set: (obj, value) => { obj.highlightLanguages = value; } }, metadata: _metadata }, _highlightLanguages_initializers, _highlightLanguages_extraInitializers);
+            __esDecorate(this, null, _pretty_decorators, { kind: "accessor", name: "pretty", static: false, private: false, access: { has: obj => "pretty" in obj, get: obj => obj.pretty, set: (obj, value) => { obj.pretty = value; } }, metadata: _metadata }, _pretty_initializers, _pretty_extraInitializers);
+            if (_metadata) Object.defineProperty(this, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
         }
+        themes = new Map([
+            ["default", DefaultTheme],
+        ]);
+        /** @event */
+        static EVENT_BEGIN_PAGE = PageEvent.BEGIN;
+        /** @event */
+        static EVENT_END_PAGE = PageEvent.END;
+        /** @event */
+        static EVENT_BEGIN = RendererEvent.BEGIN;
+        /** @event */
+        static EVENT_END = RendererEvent.END;
+        /** @event */
+        static EVENT_PREPARE_INDEX = IndexEvent.PREPARE_INDEX;
+        /**
+         * A list of async jobs which must be completed *before* rendering output.
+         * They will be called after {@link RendererEvent.BEGIN} has fired, but before any files have been written.
+         *
+         * This may be used by plugins to register work that must be done to prepare output files. For example: asynchronously
+         * transform markdown to HTML.
+         *
+         * Note: This array is cleared after calling the contained functions on each {@link Renderer.render} call.
+         */
+        preRenderAsyncJobs = [];
+        /**
+         * A list of async jobs which must be completed after rendering output files but before generation is considered successful.
+         * These functions will be called after all documents have been written to the filesystem.
+         *
+         * This may be used by plugins to register work that must be done to finalize output files. For example: asynchronously
+         * generating an image referenced in a render hook.
+         *
+         * Note: This array is cleared after calling the contained functions on each {@link Renderer.render} call.
+         */
+        postRenderAsyncJobs = [];
+        /**
+         * The theme that is used to render the documentation.
+         */
+        theme;
+        /**
+         * Hooks which will be called when rendering pages.
+         * Note:
+         * - Hooks added during output will be discarded at the end of rendering.
+         * - Hooks added during a page render will be discarded at the end of that page's render.
+         *
+         * See {@link RendererHooks} for a description of each available hook, and when it will be called.
+         */
+        hooks = new EventHooks();
+        #themeName_accessor_storage = __runInitializers(this, _themeName_initializers, void 0);
         /** @internal */
-        get themeName() { return __classPrivateFieldGet(this, _Renderer_themeName_accessor_storage, "f"); }
-        set themeName(value) { __classPrivateFieldSet(this, _Renderer_themeName_accessor_storage, value, "f"); }
-        get cleanOutputDir() { return __classPrivateFieldGet(this, _Renderer_cleanOutputDir_accessor_storage, "f"); }
-        set cleanOutputDir(value) { __classPrivateFieldSet(this, _Renderer_cleanOutputDir_accessor_storage, value, "f"); }
-        get cname() { return __classPrivateFieldGet(this, _Renderer_cname_accessor_storage, "f"); }
-        set cname(value) { __classPrivateFieldSet(this, _Renderer_cname_accessor_storage, value, "f"); }
-        get githubPages() { return __classPrivateFieldGet(this, _Renderer_githubPages_accessor_storage, "f"); }
-        set githubPages(value) { __classPrivateFieldSet(this, _Renderer_githubPages_accessor_storage, value, "f"); }
+        get themeName() { return this.#themeName_accessor_storage; }
+        set themeName(value) { this.#themeName_accessor_storage = value; }
+        #cleanOutputDir_accessor_storage = (__runInitializers(this, _themeName_extraInitializers), __runInitializers(this, _cleanOutputDir_initializers, void 0));
+        get cleanOutputDir() { return this.#cleanOutputDir_accessor_storage; }
+        set cleanOutputDir(value) { this.#cleanOutputDir_accessor_storage = value; }
+        #cname_accessor_storage = (__runInitializers(this, _cleanOutputDir_extraInitializers), __runInitializers(this, _cname_initializers, void 0));
+        get cname() { return this.#cname_accessor_storage; }
+        set cname(value) { this.#cname_accessor_storage = value; }
+        #githubPages_accessor_storage = (__runInitializers(this, _cname_extraInitializers), __runInitializers(this, _githubPages_initializers, void 0));
+        get githubPages() { return this.#githubPages_accessor_storage; }
+        set githubPages(value) { this.#githubPages_accessor_storage = value; }
+        #cacheBust_accessor_storage = (__runInitializers(this, _githubPages_extraInitializers), __runInitializers(this, _cacheBust_initializers, void 0));
         /** @internal */
-        get cacheBust() { return __classPrivateFieldGet(this, _Renderer_cacheBust_accessor_storage, "f"); }
-        set cacheBust(value) { __classPrivateFieldSet(this, _Renderer_cacheBust_accessor_storage, value, "f"); }
-        get lightTheme() { return __classPrivateFieldGet(this, _Renderer_lightTheme_accessor_storage, "f"); }
-        set lightTheme(value) { __classPrivateFieldSet(this, _Renderer_lightTheme_accessor_storage, value, "f"); }
-        get darkTheme() { return __classPrivateFieldGet(this, _Renderer_darkTheme_accessor_storage, "f"); }
-        set darkTheme(value) { __classPrivateFieldSet(this, _Renderer_darkTheme_accessor_storage, value, "f"); }
-        get highlightLanguages() { return __classPrivateFieldGet(this, _Renderer_highlightLanguages_accessor_storage, "f"); }
-        set highlightLanguages(value) { __classPrivateFieldSet(this, _Renderer_highlightLanguages_accessor_storage, value, "f"); }
-        get pretty() { return __classPrivateFieldGet(this, _Renderer_pretty_accessor_storage, "f"); }
-        set pretty(value) { __classPrivateFieldSet(this, _Renderer_pretty_accessor_storage, value, "f"); }
+        get cacheBust() { return this.#cacheBust_accessor_storage; }
+        set cacheBust(value) { this.#cacheBust_accessor_storage = value; }
+        #lightTheme_accessor_storage = (__runInitializers(this, _cacheBust_extraInitializers), __runInitializers(this, _lightTheme_initializers, void 0));
+        get lightTheme() { return this.#lightTheme_accessor_storage; }
+        set lightTheme(value) { this.#lightTheme_accessor_storage = value; }
+        #darkTheme_accessor_storage = (__runInitializers(this, _lightTheme_extraInitializers), __runInitializers(this, _darkTheme_initializers, void 0));
+        get darkTheme() { return this.#darkTheme_accessor_storage; }
+        set darkTheme(value) { this.#darkTheme_accessor_storage = value; }
+        #highlightLanguages_accessor_storage = (__runInitializers(this, _darkTheme_extraInitializers), __runInitializers(this, _highlightLanguages_initializers, void 0));
+        get highlightLanguages() { return this.#highlightLanguages_accessor_storage; }
+        set highlightLanguages(value) { this.#highlightLanguages_accessor_storage = value; }
+        #pretty_accessor_storage = (__runInitializers(this, _highlightLanguages_extraInitializers), __runInitializers(this, _pretty_initializers, void 0));
+        get pretty() { return this.#pretty_accessor_storage; }
+        set pretty(value) { this.#pretty_accessor_storage = value; }
+        renderStartTime = (__runInitializers(this, _pretty_extraInitializers), -1);
+        markedPlugin;
+        constructor(owner) {
+            super(owner);
+            this.markedPlugin = new MarkedPlugin(this);
+            new AssetsPlugin(this);
+            new IconsPlugin(this);
+            new JavascriptIndexPlugin(this);
+            new NavigationPlugin(this);
+            new SitemapPlugin(this);
+        }
         /**
          * Define a new theme that can be used to render output.
          * This API will likely be changing at some point, to allow more easily overriding parts of the theme without
@@ -244,25 +240,24 @@ let Renderer = (() => {
          * @param outputDirectory  The path of the directory the documentation should be rendered to.
          */
         async render(project, outputDirectory) {
-            (0, jsx_1.setRenderSettings)({ pretty: this.pretty });
+            setRenderSettings({ pretty: this.pretty });
             const momento = this.hooks.saveMomento();
             this.renderStartTime = Date.now();
             if (!this.prepareTheme() ||
                 !(await this.prepareOutputDirectory(outputDirectory))) {
                 return;
             }
-            const output = new events_1.RendererEvent(outputDirectory, project);
+            const output = new RendererEvent(outputDirectory, project);
             output.urls = this.theme.getUrls(project);
-            this.trigger(events_1.RendererEvent.BEGIN, output);
+            this.trigger(RendererEvent.BEGIN, output);
             await this.runPreRenderJobs(output);
             this.application.logger.verbose(`There are ${output.urls.length} pages to write.`);
             output.urls.forEach((mapping) => {
                 this.renderDocument(...output.createPageEvent(mapping));
-                (0, type_1.validateStateIsClean)(mapping.url);
             });
             await Promise.all(this.postRenderAsyncJobs.map((job) => job(output)));
             this.postRenderAsyncJobs = [];
-            this.trigger(events_1.RendererEvent.END, output);
+            this.trigger(RendererEvent.END, output);
             this.theme = void 0;
             this.hooks.restoreMomento(momento);
         }
@@ -274,7 +269,7 @@ let Renderer = (() => {
             this.application.logger.verbose(`Pre render async jobs took ${Date.now() - start}ms`);
         }
         async loadHighlighter() {
-            await (0, highlighter_1.loadHighlighter)(this.lightTheme, this.darkTheme, 
+            await loadHighlighter(this.lightTheme, this.darkTheme, 
             // Checked in option validation
             this.highlightLanguages);
         }
@@ -286,17 +281,17 @@ let Renderer = (() => {
          */
         renderDocument(template, page) {
             const momento = this.hooks.saveMomento();
-            this.trigger(events_1.PageEvent.BEGIN, page);
-            if (page.model instanceof models_1.Reflection) {
+            this.trigger(PageEvent.BEGIN, page);
+            if (page.model instanceof Reflection) {
                 page.contents = this.theme.render(page, template);
             }
             else {
                 throw new Error("Should be unreachable");
             }
-            this.trigger(events_1.PageEvent.END, page);
+            this.trigger(PageEvent.END, page);
             this.hooks.restoreMomento(momento);
             try {
-                (0, fs_1.writeFileSync)(page.filename, page.contents);
+                writeFileSync(page.filename, page.contents);
             }
             catch (error) {
                 this.application.logger.error(this.application.i18n.could_not_write_0(page.filename));
@@ -368,56 +363,5 @@ let Renderer = (() => {
             return true;
         }
     };
-    _Renderer_themeName_accessor_storage = new WeakMap();
-    _Renderer_cleanOutputDir_accessor_storage = new WeakMap();
-    _Renderer_cname_accessor_storage = new WeakMap();
-    _Renderer_githubPages_accessor_storage = new WeakMap();
-    _Renderer_cacheBust_accessor_storage = new WeakMap();
-    _Renderer_lightTheme_accessor_storage = new WeakMap();
-    _Renderer_darkTheme_accessor_storage = new WeakMap();
-    _Renderer_highlightLanguages_accessor_storage = new WeakMap();
-    _Renderer_pretty_accessor_storage = new WeakMap();
-    __setFunctionName(_classThis, "Renderer");
-    (() => {
-        const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(_classSuper[Symbol.metadata] ?? null) : void 0;
-        _themeName_decorators = [(0, utils_1.Option)("theme")];
-        _cleanOutputDir_decorators = [(0, utils_1.Option)("cleanOutputDir")];
-        _cname_decorators = [(0, utils_1.Option)("cname")];
-        _githubPages_decorators = [(0, utils_1.Option)("githubPages")];
-        _cacheBust_decorators = [(0, utils_1.Option)("cacheBust")];
-        _lightTheme_decorators = [(0, utils_1.Option)("lightHighlightTheme")];
-        _darkTheme_decorators = [(0, utils_1.Option)("darkHighlightTheme")];
-        _highlightLanguages_decorators = [(0, utils_1.Option)("highlightLanguages")];
-        _pretty_decorators = [(0, utils_1.Option)("pretty")];
-        __esDecorate(_classThis, null, _themeName_decorators, { kind: "accessor", name: "themeName", static: false, private: false, access: { has: obj => "themeName" in obj, get: obj => obj.themeName, set: (obj, value) => { obj.themeName = value; } }, metadata: _metadata }, _themeName_initializers, _themeName_extraInitializers);
-        __esDecorate(_classThis, null, _cleanOutputDir_decorators, { kind: "accessor", name: "cleanOutputDir", static: false, private: false, access: { has: obj => "cleanOutputDir" in obj, get: obj => obj.cleanOutputDir, set: (obj, value) => { obj.cleanOutputDir = value; } }, metadata: _metadata }, _cleanOutputDir_initializers, _cleanOutputDir_extraInitializers);
-        __esDecorate(_classThis, null, _cname_decorators, { kind: "accessor", name: "cname", static: false, private: false, access: { has: obj => "cname" in obj, get: obj => obj.cname, set: (obj, value) => { obj.cname = value; } }, metadata: _metadata }, _cname_initializers, _cname_extraInitializers);
-        __esDecorate(_classThis, null, _githubPages_decorators, { kind: "accessor", name: "githubPages", static: false, private: false, access: { has: obj => "githubPages" in obj, get: obj => obj.githubPages, set: (obj, value) => { obj.githubPages = value; } }, metadata: _metadata }, _githubPages_initializers, _githubPages_extraInitializers);
-        __esDecorate(_classThis, null, _cacheBust_decorators, { kind: "accessor", name: "cacheBust", static: false, private: false, access: { has: obj => "cacheBust" in obj, get: obj => obj.cacheBust, set: (obj, value) => { obj.cacheBust = value; } }, metadata: _metadata }, _cacheBust_initializers, _cacheBust_extraInitializers);
-        __esDecorate(_classThis, null, _lightTheme_decorators, { kind: "accessor", name: "lightTheme", static: false, private: false, access: { has: obj => "lightTheme" in obj, get: obj => obj.lightTheme, set: (obj, value) => { obj.lightTheme = value; } }, metadata: _metadata }, _lightTheme_initializers, _lightTheme_extraInitializers);
-        __esDecorate(_classThis, null, _darkTheme_decorators, { kind: "accessor", name: "darkTheme", static: false, private: false, access: { has: obj => "darkTheme" in obj, get: obj => obj.darkTheme, set: (obj, value) => { obj.darkTheme = value; } }, metadata: _metadata }, _darkTheme_initializers, _darkTheme_extraInitializers);
-        __esDecorate(_classThis, null, _highlightLanguages_decorators, { kind: "accessor", name: "highlightLanguages", static: false, private: false, access: { has: obj => "highlightLanguages" in obj, get: obj => obj.highlightLanguages, set: (obj, value) => { obj.highlightLanguages = value; } }, metadata: _metadata }, _highlightLanguages_initializers, _highlightLanguages_extraInitializers);
-        __esDecorate(_classThis, null, _pretty_decorators, { kind: "accessor", name: "pretty", static: false, private: false, access: { has: obj => "pretty" in obj, get: obj => obj.pretty, set: (obj, value) => { obj.pretty = value; } }, metadata: _metadata }, _pretty_initializers, _pretty_extraInitializers);
-        __esDecorate(null, _classDescriptor = { value: _classThis }, _classDecorators, { kind: "class", name: _classThis.name, metadata: _metadata }, null, _classExtraInitializers);
-        Renderer = _classThis = _classDescriptor.value;
-        if (_metadata) Object.defineProperty(_classThis, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
-    })();
-    /** @event */
-    _classThis.EVENT_BEGIN_PAGE = events_1.PageEvent.BEGIN;
-    /** @event */
-    _classThis.EVENT_END_PAGE = events_1.PageEvent.END;
-    /** @event */
-    _classThis.EVENT_BEGIN = events_1.RendererEvent.BEGIN;
-    /** @event */
-    _classThis.EVENT_END = events_1.RendererEvent.END;
-    /** @event */
-    _classThis.EVENT_PREPARE_INDEX = events_1.IndexEvent.PREPARE_INDEX;
-    (() => {
-        __runInitializers(_classThis, _classExtraInitializers);
-    })();
-    return Renderer = _classThis;
 })();
-exports.Renderer = Renderer;
-// HACK: THIS HAS TO STAY DOWN HERE
-// if you try to move it up to the top of the file, then you'll run into stuff being used before it has been defined.
-require("./plugins");
+export { Renderer };

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

@@ -1,8 +1,9 @@
-import type { ProjectReflection } from "../models/reflections/project";
-import type { RenderTemplate, UrlMapping } from "./models/UrlMapping";
-import { RendererComponent } from "./components";
-import type { PageEvent } from "./events";
-import type { Reflection } from "../models";
+import type { ProjectReflection } from "../models/reflections/project.js";
+import type { RenderTemplate, UrlMapping } from "./models/UrlMapping.js";
+import { RendererComponent } from "./components.js";
+import type { PageEvent } from "./events.js";
+import type { Reflection } from "../models/index.js";
+import type { Slugger } from "./themes/default/Slugger.js";
 /**
  * Base class of all themes.
  *
@@ -12,6 +13,7 @@ import type { Reflection } from "../models";
  * {@link Renderer} to control and manipulate the output process.
  */
 export declare abstract class Theme extends RendererComponent {
+    private sluggers;
     /**
      * Map the models of the given project to the desired output files.
      * It is assumed that with the project structure:
@@ -33,4 +35,6 @@ export declare abstract class Theme extends RendererComponent {
      * Renders the provided page to a string, which will be written to disk by the {@link Renderer}
      */
     abstract render(page: PageEvent<Reflection>, template: RenderTemplate<PageEvent<Reflection>>): string;
+    setSlugger(reflection: Reflection, slugger: Slugger): void;
+    getSlugger(reflection: Reflection): Slugger;
 }

package/dist/lib/output/theme.js

@@ -1,46 +1,4 @@
-"use strict";
-var __esDecorate = (this && this.__esDecorate) || function (ctor, descriptorIn, decorators, contextIn, initializers, extraInitializers) {
-    function accept(f) { if (f !== void 0 && typeof f !== "function") throw new TypeError("Function expected"); return f; }
-    var kind = contextIn.kind, key = kind === "getter" ? "get" : kind === "setter" ? "set" : "value";
-    var target = !descriptorIn && ctor ? contextIn["static"] ? ctor : ctor.prototype : null;
-    var descriptor = descriptorIn || (target ? Object.getOwnPropertyDescriptor(target, contextIn.name) : {});
-    var _, done = false;
-    for (var i = decorators.length - 1; i >= 0; i--) {
-        var context = {};
-        for (var p in contextIn) context[p] = p === "access" ? {} : contextIn[p];
-        for (var p in contextIn.access) context.access[p] = contextIn.access[p];
-        context.addInitializer = function (f) { if (done) throw new TypeError("Cannot add initializers after decoration has completed"); extraInitializers.push(accept(f || null)); };
-        var result = (0, decorators[i])(kind === "accessor" ? { get: descriptor.get, set: descriptor.set } : descriptor[key], context);
-        if (kind === "accessor") {
-            if (result === void 0) continue;
-            if (result === null || typeof result !== "object") throw new TypeError("Object expected");
-            if (_ = accept(result.get)) descriptor.get = _;
-            if (_ = accept(result.set)) descriptor.set = _;
-            if (_ = accept(result.init)) initializers.unshift(_);
-        }
-        else if (_ = accept(result)) {
-            if (kind === "field") initializers.unshift(_);
-            else descriptor[key] = _;
-        }
-    }
-    if (target) Object.defineProperty(target, contextIn.name, descriptor);
-    done = true;
-};
-var __runInitializers = (this && this.__runInitializers) || function (thisArg, initializers, value) {
-    var useValue = arguments.length > 2;
-    for (var i = 0; i < initializers.length; i++) {
-        value = useValue ? initializers[i].call(thisArg, value) : initializers[i].call(thisArg);
-    }
-    return useValue ? value : void 0;
-};
-var __setFunctionName = (this && this.__setFunctionName) || function (f, name, prefix) {
-    if (typeof name === "symbol") name = name.description ? "[".concat(name.description, "]") : "";
-    return Object.defineProperty(f, "name", { configurable: true, value: prefix ? "".concat(prefix, " ", name) : name });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Theme = void 0;
-const components_1 = require("./components");
-const component_1 = require("../utils/component");
+import { RendererComponent } from "./components.js";
 /**
  * Base class of all themes.
  *
@@ -49,22 +7,16 @@ const component_1 = require("../utils/component");
  * and templates to use. Additionally themes can subscribe to the events emitted by
  * {@link Renderer} to control and manipulate the output process.
  */
-let Theme = (() => {
-    let _classDecorators = [(0, component_1.Component)({ name: "theme", internal: true })];
-    let _classDescriptor;
-    let _classExtraInitializers = [];
-    let _classThis;
-    let _classSuper = components_1.RendererComponent;
-    var Theme = _classThis = class extends _classSuper {
-    };
-    __setFunctionName(_classThis, "Theme");
-    (() => {
-        const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(_classSuper[Symbol.metadata] ?? null) : void 0;
-        __esDecorate(null, _classDescriptor = { value: _classThis }, _classDecorators, { kind: "class", name: _classThis.name, metadata: _metadata }, null, _classExtraInitializers);
-        Theme = _classThis = _classDescriptor.value;
-        if (_metadata) Object.defineProperty(_classThis, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
-        __runInitializers(_classThis, _classExtraInitializers);
-    })();
-    return Theme = _classThis;
-})();
-exports.Theme = Theme;
+export class Theme extends RendererComponent {
+    sluggers = new Map();
+    setSlugger(reflection, slugger) {
+        this.sluggers.set(reflection, slugger);
+    }
+    getSlugger(reflection) {
+        if (this.sluggers.has(reflection)) {
+            return this.sluggers.get(reflection);
+        }
+        // A slugger should always be defined at least for the project
+        return this.getSlugger(reflection.parent);
+    }
+}