typedoc 0.25.13 → 0.26.0-beta.1

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

@@ -1,20 +1,4 @@
 "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,13 +33,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 });
@@ -71,67 +48,68 @@ var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (
     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;
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MarkedPlugin = void 0;
-const fs = __importStar(require("fs"));
-const Path = __importStar(require("path"));
-const Marked = __importStar(require("marked"));
+const markdown_it_1 = __importDefault(require("markdown-it"));
 const components_1 = require("../components");
 const events_1 = require("../events");
 const utils_1 = require("../../utils");
 const highlighter_1 = require("../../utils/highlighter");
 const html_1 = require("../../utils/html");
+const DefaultTheme_1 = require("./default/DefaultTheme");
+const anchor_icon_1 = require("./default/partials/anchor-icon");
+const models_1 = require("../../models");
+let defaultSlugger;
+function getDefaultSlugger(logger) {
+    if (!defaultSlugger) {
+        logger.warn(logger.i18n.custom_theme_does_not_define_getSlugger());
+        defaultSlugger = new DefaultTheme_1.Slugger();
+    }
+    return defaultSlugger;
+}
 /**
  * Implements markdown and relativeURL helpers for templates.
  * @internal
  */
 let MarkedPlugin = (() => {
-    var _MarkedPlugin_includeSource_accessor_storage, _MarkedPlugin_mediaSource_accessor_storage, _MarkedPlugin_lightTheme_accessor_storage, _MarkedPlugin_darkTheme_accessor_storage;
+    var _MarkedPlugin_lightTheme_accessor_storage, _MarkedPlugin_darkTheme_accessor_storage, _MarkedPlugin_markdownItOptions_accessor_storage;
     let _classDecorators = [(0, components_1.Component)({ name: "marked" })];
     let _classDescriptor;
     let _classExtraInitializers = [];
     let _classThis;
     let _classSuper = components_1.ContextAwareRendererComponent;
-    let _includeSource_decorators;
-    let _includeSource_initializers = [];
-    let _includeSource_extraInitializers = [];
-    let _mediaSource_decorators;
-    let _mediaSource_initializers = [];
-    let _mediaSource_extraInitializers = [];
     let _lightTheme_decorators;
     let _lightTheme_initializers = [];
     let _lightTheme_extraInitializers = [];
     let _darkTheme_decorators;
     let _darkTheme_initializers = [];
     let _darkTheme_extraInitializers = [];
+    let _markdownItOptions_decorators;
+    let _markdownItOptions_initializers = [];
+    let _markdownItOptions_extraInitializers = [];
     var MarkedPlugin = _classThis = class extends _classSuper {
         constructor() {
             super(...arguments);
-            _MarkedPlugin_includeSource_accessor_storage.set(this, __runInitializers(this, _includeSource_initializers, void 0));
-            _MarkedPlugin_mediaSource_accessor_storage.set(this, (__runInitializers(this, _includeSource_extraInitializers), __runInitializers(this, _mediaSource_initializers, void 0)));
-            _MarkedPlugin_lightTheme_accessor_storage.set(this, (__runInitializers(this, _mediaSource_extraInitializers), __runInitializers(this, _lightTheme_initializers, void 0)));
+            _MarkedPlugin_lightTheme_accessor_storage.set(this, __runInitializers(this, _lightTheme_initializers, void 0));
             _MarkedPlugin_darkTheme_accessor_storage.set(this, (__runInitializers(this, _lightTheme_extraInitializers), __runInitializers(this, _darkTheme_initializers, void 0)));
+            _MarkedPlugin_markdownItOptions_accessor_storage.set(this, (__runInitializers(this, _darkTheme_extraInitializers), __runInitializers(this, _markdownItOptions_initializers, void 0)));
+            this.parser = __runInitializers(this, _markdownItOptions_extraInitializers);
             /**
-             * The path referenced files are located in.
-             */
-            this.includes = __runInitializers(this, _darkTheme_extraInitializers);
-            /**
-             * The pattern used to find references in markdown.
+             * 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.
              */
-            this.includePattern = /\[\[include:([^\]]+?)\]\]/g;
-            /**
-             * The pattern used to find media links.
-             */
-            this.mediaPattern = /media:\/\/([^ ")\]}]+)/g;
+            this.renderContext = null;
+            this.lastHeaderSlug = "";
         }
-        get includeSource() { return __classPrivateFieldGet(this, _MarkedPlugin_includeSource_accessor_storage, "f"); }
-        set includeSource(value) { __classPrivateFieldSet(this, _MarkedPlugin_includeSource_accessor_storage, value, "f"); }
-        get mediaSource() { return __classPrivateFieldGet(this, _MarkedPlugin_mediaSource_accessor_storage, "f"); }
-        set mediaSource(value) { __classPrivateFieldSet(this, _MarkedPlugin_mediaSource_accessor_storage, value, "f"); }
         get lightTheme() { return __classPrivateFieldGet(this, _MarkedPlugin_lightTheme_accessor_storage, "f"); }
         set lightTheme(value) { __classPrivateFieldSet(this, _MarkedPlugin_lightTheme_accessor_storage, value, "f"); }
         get darkTheme() { return __classPrivateFieldGet(this, _MarkedPlugin_darkTheme_accessor_storage, "f"); }
         set darkTheme(value) { __classPrivateFieldSet(this, _MarkedPlugin_darkTheme_accessor_storage, value, "f"); }
+        get markdownItOptions() { return __classPrivateFieldGet(this, _MarkedPlugin_markdownItOptions_accessor_storage, "f"); }
+        set markdownItOptions(value) { __classPrivateFieldSet(this, _MarkedPlugin_markdownItOptions_accessor_storage, value, "f"); }
         /**
          * Create a new MarkedPlugin instance.
          */
@@ -150,14 +128,7 @@ let MarkedPlugin = (() => {
             lang = lang || "typescript";
             lang = lang.toLowerCase();
             if (!(0, highlighter_1.isSupportedLanguage)(lang)) {
-                // Extra newline because of the progress bar
-                this.application.logger.warn(`
-Unsupported highlight language "${lang}" will not be highlighted. Run typedoc --help for a list of supported languages.
-target code block :
-\t${text.split("\n").join("\n\t")}
-source files :${this.sources?.map((source) => `\n\t${source.fileName}`).join()}
-output file :
-\t${this.outputFileName}`);
+                this.application.logger.warn(this.application.i18n.unsupported_highlight_language_0_not_highlighted_in_comment_for_1(lang, this.page?.model.getFriendlyFullName() ?? "(unknown)"));
                 return text;
             }
             return (0, highlighter_1.highlight)(text, lang);
@@ -165,39 +136,18 @@ output file :
         /**
          * Parse the given markdown string and return the resulting html.
          *
-         * @param text  The markdown string that should be parsed.
+         * @param input  The markdown string that should be parsed.
          * @returns The resulting html string.
          */
-        parseMarkdown(text, page) {
-            if (this.includes) {
-                text = text.replace(this.includePattern, (_match, path) => {
-                    path = Path.join(this.includes, path.trim());
-                    if ((0, utils_1.isFile)(path)) {
-                        const contents = (0, utils_1.readFile)(path);
-                        const event = new events_1.MarkdownEvent(events_1.MarkdownEvent.INCLUDE, page, contents, contents);
-                        this.owner.trigger(event);
-                        return event.parsedText;
-                    }
-                    else {
-                        this.application.logger.warn("Could not find file to include: " + path);
-                        return "";
-                    }
-                });
-            }
-            if (this.mediaDirectory) {
-                text = text.replace(this.mediaPattern, (match, path) => {
-                    const fileName = Path.join(this.mediaDirectory, path);
-                    if ((0, utils_1.isFile)(fileName)) {
-                        return this.getRelativeUrl("media") + "/" + path;
-                    }
-                    else {
-                        this.application.logger.warn("Could not find media file: " + fileName);
-                        return match;
-                    }
-                });
+        parseMarkdown(input, page, context) {
+            let markdown = input;
+            if (typeof markdown !== "string") {
+                markdown = models_1.Comment.displayPartsToMarkdown(markdown, context.urlTo, !!this.markdownItOptions["html"]);
             }
-            const event = new events_1.MarkdownEvent(events_1.MarkdownEvent.PARSE, page, text, text);
+            this.renderContext = context;
+            const event = new events_1.MarkdownEvent(events_1.MarkdownEvent.PARSE, page, markdown, markdown);
             this.owner.trigger(event);
+            this.renderContext = null;
             return event.parsedText;
         }
         /**
@@ -207,63 +157,61 @@ output file :
          */
         onBeginRenderer(event) {
             super.onBeginRenderer(event);
-            Marked.marked.setOptions(this.createMarkedOptions());
-            delete this.includes;
-            if (this.includeSource) {
-                if (fs.existsSync(this.includeSource) && fs.statSync(this.includeSource).isDirectory()) {
-                    this.includes = this.includeSource;
-                }
-                else {
-                    this.application.logger.warn("Could not find provided includes directory: " + this.includeSource);
-                }
-            }
-            if (this.mediaSource) {
-                if (fs.existsSync(this.mediaSource) && fs.statSync(this.mediaSource).isDirectory()) {
-                    this.mediaDirectory = Path.join(event.outputDirectory, "media");
-                    (0, utils_1.copySync)(this.mediaSource, this.mediaDirectory);
-                }
-                else {
-                    this.mediaDirectory = undefined;
-                    this.application.logger.warn("Could not find provided media directory: " + this.mediaSource);
-                }
+            this.setupParser();
+        }
+        getSlugger() {
+            if ("getSlugger" in this.owner.theme) {
+                return this.owner.theme.getSlugger(this.page.model);
             }
+            return getDefaultSlugger(this.application.logger);
         }
         /**
          * Creates an object with options that are passed to the markdown parser.
          *
          * @returns The options object for the markdown parser.
          */
-        createMarkedOptions() {
-            const markedOptions = (this.application.options.getValue("markedOptions") ?? {});
-            // Set some default values if they are not specified via the TypeDoc option
-            markedOptions.highlight ??= (text, lang) => this.getHighlighted(text, lang);
-            if (!markedOptions.renderer) {
-                markedOptions.renderer = new Marked.Renderer();
-                markedOptions.renderer.link = (href, title, text) => {
-                    // Prefix the #anchor links `#md:`.
-                    const target = href?.replace(/^#(?:md:)?(.+)/, "#md:$1") || undefined;
-                    return (0, utils_1.renderElement)(utils_1.JSX.createElement("a", { href: target, title: title || undefined },
-                        utils_1.JSX.createElement(utils_1.JSX.Raw, { html: text })));
-                };
-                markedOptions.renderer.heading = (text, level, _, slugger) => {
-                    const slug = slugger.slug(text);
-                    // Prefix the slug with an extra `md:` to prevent conflicts with TypeDoc's anchors.
-                    this.page.pageHeadings.push({
-                        link: `#md:${slug}`,
-                        text: (0, html_1.getTextContent)(text),
-                        level,
-                    });
-                    const H = `h${level}`;
-                    return (0, utils_1.renderElement)(utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
-                        utils_1.JSX.createElement("a", { id: `md:${slug}`, class: "tsd-anchor" }),
-                        utils_1.JSX.createElement(H, null,
-                            utils_1.JSX.createElement("a", { href: `#md:${slug}` },
-                                utils_1.JSX.createElement(utils_1.JSX.Raw, { html: text })))));
-                };
-                markedOptions.renderer.code = renderCode;
-            }
-            markedOptions.mangle ??= false; // See https://github.com/TypeStrong/typedoc/issues/1395
-            return markedOptions;
+        setupParser() {
+            this.parser = (0, markdown_it_1.default)({
+                ...this.markdownItOptions,
+                highlight: (code, lang) => {
+                    code = (0, highlighter_1.highlight)(code, lang || "ts");
+                    code = code.replace(/\n$/, "") + "\n";
+                    if (!lang) {
+                        return `<pre><code>${code}</code><button>Copy</button></pre>\n`;
+                    }
+                    return `<pre><code class="${(0, html_1.escapeHtml)(lang)}">${code}</code><button type="button">Copy</button></pre>\n`;
+                },
+            });
+            const loader = this.application.options.getValue("markdownItLoader");
+            loader(this.parser);
+            // Add anchor links for headings in readme, and add them to the "On this page" section
+            this.parser.renderer.rules["heading_open"] = (tokens, idx) => {
+                const token = tokens[idx];
+                const content = tokens[idx + 1].content;
+                const level = token.markup.length;
+                const slug = this.getSlugger().slug(content);
+                this.lastHeaderSlug = slug;
+                // Prefix the slug with an extra `md:` to prevent conflicts with TypeDoc's anchors.
+                this.page.pageHeadings.push({
+                    link: `#md:${slug}`,
+                    text: (0, html_1.getTextContent)(content),
+                    level,
+                });
+                return `<a id="md:${slug}" class="tsd-anchor"></a><${token.tag} class="tsd-anchor-link">`;
+            };
+            this.parser.renderer.rules["heading_close"] = (tokens, idx) => {
+                return `${(0, utils_1.renderElement)((0, anchor_icon_1.anchorIcon)(this.renderContext, `md:${this.lastHeaderSlug}`))}</${tokens[idx].tag}>`;
+            };
+            // Rewrite anchor links inline in a readme file to links targeting the `md:` prefixed anchors
+            // that TypeDoc creates.
+            this.parser.renderer.rules["link_open"] = (tokens, idx, options, _env, self) => {
+                const token = tokens[idx];
+                const href = token.attrGet("href")?.replace(/^#(?:md:)?(.+)/, "#md:$1");
+                if (href) {
+                    token.attrSet("href", href);
+                }
+                return self.renderToken(tokens, idx, options);
+            };
         }
         /**
          * Triggered when {@link MarkedPlugin} parses a markdown string.
@@ -271,24 +219,21 @@ output file :
          * @param event
          */
         onParseMarkdown(event) {
-            event.parsedText = Marked.marked(event.parsedText);
+            event.parsedText = this.parser.render(event.parsedText);
         }
     };
-    _MarkedPlugin_includeSource_accessor_storage = new WeakMap();
-    _MarkedPlugin_mediaSource_accessor_storage = new WeakMap();
     _MarkedPlugin_lightTheme_accessor_storage = new WeakMap();
     _MarkedPlugin_darkTheme_accessor_storage = new WeakMap();
+    _MarkedPlugin_markdownItOptions_accessor_storage = new WeakMap();
     __setFunctionName(_classThis, "MarkedPlugin");
     (() => {
         const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(_classSuper[Symbol.metadata] ?? null) : void 0;
-        _includeSource_decorators = [(0, utils_1.Option)("includes")];
-        _mediaSource_decorators = [(0, utils_1.Option)("media")];
         _lightTheme_decorators = [(0, utils_1.Option)("lightHighlightTheme")];
         _darkTheme_decorators = [(0, utils_1.Option)("darkHighlightTheme")];
-        __esDecorate(_classThis, null, _includeSource_decorators, { kind: "accessor", name: "includeSource", static: false, private: false, access: { has: obj => "includeSource" in obj, get: obj => obj.includeSource, set: (obj, value) => { obj.includeSource = value; } }, metadata: _metadata }, _includeSource_initializers, _includeSource_extraInitializers);
-        __esDecorate(_classThis, null, _mediaSource_decorators, { kind: "accessor", name: "mediaSource", static: false, private: false, access: { has: obj => "mediaSource" in obj, get: obj => obj.mediaSource, set: (obj, value) => { obj.mediaSource = value; } }, metadata: _metadata }, _mediaSource_initializers, _mediaSource_extraInitializers);
+        _markdownItOptions_decorators = [(0, utils_1.Option)("markdownItOptions")];
         __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, _markdownItOptions_decorators, { kind: "accessor", name: "markdownItOptions", static: false, private: false, access: { has: obj => "markdownItOptions" in obj, get: obj => obj.markdownItOptions, set: (obj, value) => { obj.markdownItOptions = value; } }, metadata: _metadata }, _markdownItOptions_initializers, _markdownItOptions_extraInitializers);
         __esDecorate(null, _classDescriptor = { value: _classThis }, _classDecorators, { kind: "class", name: _classThis.name, metadata: _metadata }, null, _classExtraInitializers);
         MarkedPlugin = _classThis = _classDescriptor.value;
         if (_metadata) Object.defineProperty(_classThis, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
@@ -297,20 +242,3 @@ output file :
     return MarkedPlugin = _classThis;
 })();
 exports.MarkedPlugin = MarkedPlugin;
-// Basically a copy/paste of Marked's code, with the addition of the button
-// https://github.com/markedjs/marked/blob/v4.3.0/src/Renderer.js#L15-L39
-function renderCode(code, infostring, escaped) {
-    const lang = (infostring || "").match(/\S*/)[0];
-    if (this.options.highlight) {
-        const out = this.options.highlight(code, lang);
-        if (out != null && out !== code) {
-            escaped = true;
-            code = out;
-        }
-    }
-    code = code.replace(/\n$/, "") + "\n";
-    if (!lang) {
-        return `<pre><code>${escaped ? code : (0, html_1.escapeHtml)(code)}</code><button>Copy</button></pre>\n`;
-    }
-    return `<pre><code class="${this.options.langPrefix + (0, html_1.escapeHtml)(lang)}">${escaped ? code : (0, html_1.escapeHtml)(code)}</code><button>Copy</button></pre>\n`;
-}

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

@@ -1,7 +1,7 @@
 import { Theme } from "../../theme";
 import type { Renderer } from "../../renderer";
-import { Reflection, ReflectionKind, ProjectReflection, ContainerReflection, DeclarationReflection } from "../../../models";
-import { RenderTemplate, UrlMapping } from "../../models/UrlMapping";
+import { ReflectionKind, ProjectReflection, type ContainerReflection, DeclarationReflection, type Reflection, type DocumentReflection } from "../../../models";
+import { type RenderTemplate, UrlMapping } from "../../models/UrlMapping";
 import type { PageEvent } from "../../events";
 import type { MarkedPlugin } from "../../plugins";
 import { DefaultThemeRenderContext } from "./DefaultThemeRenderContext";
@@ -13,6 +13,14 @@ export interface NavigationElement {
     class?: string;
     children?: NavigationElement[];
 }
+/**
+ * Responsible for getting a unique anchor for elements within a page.
+ */
+export declare class Slugger {
+    private seen;
+    private serialize;
+    slug(value: string): string;
+}
 /**
  * Default theme implementation of TypeDoc. If a theme does not provide a custom
  * {@link Theme} implementation, this theme class will be used.
@@ -59,17 +67,19 @@ export declare class DefaultTheme extends Theme {
         1048576: () => JSX.Element;
         2097152: () => JSX.Element;
         4194304: () => JSX.Element;
+        8388608: () => JSX.Element;
         checkbox: () => JSX.Element;
         chevronDown: () => JSX.Element;
         menu: () => JSX.Element;
         chevronSmall: () => JSX.Element;
     };
     getRenderContext(pageEvent: PageEvent<Reflection>): DefaultThemeRenderContext;
+    documentTemplate: (pageEvent: PageEvent<DocumentReflection>) => JSX.Element;
     reflectionTemplate: (pageEvent: PageEvent<ContainerReflection>) => JSX.Element;
     indexTemplate: (pageEvent: PageEvent<ProjectReflection>) => JSX.Element;
     hierarchyTemplate: (pageEvent: PageEvent<ProjectReflection>) => JSX.Element;
     defaultLayoutTemplate: (pageEvent: PageEvent<Reflection>, template: RenderTemplate<PageEvent<Reflection>>) => JSX.Element;
-    getReflectionClasses(reflection: DeclarationReflection): string;
+    getReflectionClasses(reflection: DeclarationReflection | DocumentReflection): string;
     /**
      * Mappings of reflections kinds to templates used by this theme.
      */
@@ -112,7 +122,7 @@ export declare class DefaultTheme extends Theme {
      * @param urls        The array the url should be appended to.
      * @returns           The altered urls array.
      */
-    buildUrls(reflection: DeclarationReflection, urls: UrlMapping[]): UrlMapping[];
+    buildUrls(reflection: DeclarationReflection | DocumentReflection, urls: UrlMapping[]): UrlMapping[];
     render(page: PageEvent<Reflection>, template: RenderTemplate<PageEvent<Reflection>>): string;
     private _navigationCache;
     /**
@@ -120,6 +130,8 @@ export declare class DefaultTheme extends Theme {
      */
     getNavigation(project: ProjectReflection): NavigationElement[];
     buildNavigation(project: ProjectReflection): NavigationElement[];
+    private sluggers;
+    getSlugger(reflection: Reflection): Slugger;
     /**
      * Generate an anchor url for the given reflection and all of its children.
      *

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DefaultTheme = void 0;
+exports.DefaultTheme = exports.Slugger = void 0;
 const theme_1 = require("../../theme");
 const models_1 = require("../../../models");
 const UrlMapping_1 = require("../../models/UrlMapping");
@@ -8,6 +8,41 @@ const DefaultThemeRenderContext_1 = require("./DefaultThemeRenderContext");
 const utils_1 = require("../../../utils");
 const lib_1 = require("../lib");
 const icon_1 = require("./partials/icon");
+/**
+ * Responsible for getting a unique anchor for elements within a page.
+ */
+class Slugger {
+    constructor() {
+        this.seen = new Map();
+    }
+    serialize(value) {
+        // Extracted from marked@4.3.0
+        return (value
+            .toLowerCase()
+            .trim()
+            // remove html tags
+            .replace(/<[!/a-z].*?>/gi, "")
+            // remove unwanted chars
+            .replace(/[\u2000-\u206F\u2E00-\u2E7F\\'!"#$%&()*+,./:;<=>?@[\]^`{|}~]/g, "")
+            .replace(/\s/g, "-"));
+    }
+    slug(value) {
+        const originalSlug = this.serialize(value);
+        let slug = originalSlug;
+        let count = 0;
+        if (this.seen.has(slug)) {
+            count = this.seen.get(originalSlug);
+            do {
+                count++;
+                slug = originalSlug + "-" + count;
+            } while (this.seen.has(slug));
+        }
+        this.seen.set(originalSlug, count);
+        this.seen.set(slug, 0);
+        return slug;
+    }
+}
+exports.Slugger = Slugger;
 /**
  * Default theme implementation of TypeDoc. If a theme does not provide a custom
  * {@link Theme} implementation, this theme class will be used.
@@ -41,6 +76,9 @@ class DefaultTheme extends theme_1.Theme {
          * elements, so custom themes must also use svg elements.
          */
         this.icons = { ...icon_1.icons };
+        this.documentTemplate = (pageEvent) => {
+            return this.getRenderContext(pageEvent).documentTemplate(pageEvent);
+        };
         this.reflectionTemplate = (pageEvent) => {
             return this.getRenderContext(pageEvent).reflectionTemplate(pageEvent);
         };
@@ -92,7 +130,13 @@ class DefaultTheme extends theme_1.Theme {
                 directory: "variables",
                 template: this.reflectionTemplate,
             },
+            {
+                kind: [models_1.ReflectionKind.Document],
+                directory: "documents",
+                template: this.documentTemplate,
+            },
         ];
+        this.sluggers = new Map();
         this.markedPlugin = renderer.getComponent("marked");
     }
     /**
@@ -104,6 +148,7 @@ class DefaultTheme extends theme_1.Theme {
      */
     getUrls(project) {
         const urls = [];
+        this.sluggers.set(project, new Slugger());
         if (false == hasReadme(this.application.options.getValue("readme"))) {
             project.url = "index.html";
             urls.push(new UrlMapping_1.UrlMapping("index.html", project, this.reflectionTemplate));
@@ -122,11 +167,7 @@ class DefaultTheme extends theme_1.Theme {
         if ((0, lib_1.getHierarchyRoots)(project).length) {
             urls.push(new UrlMapping_1.UrlMapping("hierarchy.html", project, this.hierarchyTemplate));
         }
-        project.children?.forEach((child) => {
-            if (child instanceof models_1.DeclarationReflection) {
-                this.buildUrls(child, urls);
-            }
-        });
+        project.childrenIncludingDocuments?.forEach((child) => this.buildUrls(child, urls));
         return urls;
     }
     /**
@@ -166,11 +207,12 @@ class DefaultTheme extends theme_1.Theme {
             if (!reflection.url || !DefaultTheme.URL_PREFIX.test(reflection.url)) {
                 const url = [mapping.directory, DefaultTheme.getUrl(reflection) + ".html"].join("/");
                 urls.push(new UrlMapping_1.UrlMapping(url, reflection, mapping.template));
+                this.sluggers.set(reflection, new Slugger());
                 reflection.url = url;
                 reflection.hasOwnDocument = true;
             }
             reflection.traverse((child) => {
-                if (child instanceof models_1.DeclarationReflection) {
+                if (child.isDeclaration() || child.isDocument()) {
                     this.buildUrls(child, urls);
                 }
                 else {
@@ -204,9 +246,6 @@ class DefaultTheme extends theme_1.Theme {
         const theme = this;
         const opts = this.application.options.getValue("navigation");
         const leaves = this.application.options.getValue("navigationLeaves");
-        if (opts.fullTree) {
-            this.application.logger.warn(`The navigation.fullTree option no longer has any affect and will be removed in v0.26`);
-        }
         return getNavigationElements(project) || [];
         function toNavigation(element) {
             if (element instanceof models_1.ReflectionCategory || element instanceof models_1.ReflectionGroup) {
@@ -236,21 +275,24 @@ class DefaultTheme extends theme_1.Theme {
             if (leaves.includes(parent.getFullName())) {
                 return;
             }
-            if (!parent.kindOf(models_1.ReflectionKind.SomeModule | models_1.ReflectionKind.Project)) {
+            if (!parent.kindOf(models_1.ReflectionKind.MayContainDocuments) || parent.isDocument()) {
                 return;
             }
+            if (!parent.kindOf(models_1.ReflectionKind.SomeModule | models_1.ReflectionKind.Project)) {
+                // Tricky: Non-module children don't show up in the navigation pane,
+                //   but any documents added by them should.
+                return parent.documents?.map(toNavigation);
+            }
             if (parent.categories && shouldShowCategories(parent, opts)) {
                 return parent.categories.map(toNavigation);
             }
             if (parent.groups && shouldShowGroups(parent, opts)) {
                 return parent.groups.map(toNavigation);
             }
-            if (opts.includeFolders &&
-                parent.children?.every((child) => child.kindOf(models_1.ReflectionKind.Module)) &&
-                parent.children.some((child) => child.name.includes("/"))) {
-                return deriveModuleFolders(parent.children);
+            if (opts.includeFolders && parent.childrenIncludingDocuments?.some((child) => child.name.includes("/"))) {
+                return deriveModuleFolders(parent.childrenIncludingDocuments);
             }
-            return parent.children?.map(toNavigation);
+            return parent.childrenIncludingDocuments?.map(toNavigation);
         }
         function deriveModuleFolders(children) {
             const result = [];
@@ -300,6 +342,13 @@ class DefaultTheme extends theme_1.Theme {
             return result;
         }
     }
+    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);
+    }
     /**
      * Generate an anchor url for the given reflection and all of its children.
      *
@@ -335,7 +384,7 @@ function getReflectionClasses(reflection, filters) {
     // partials/navigation.tsx.
     for (const key of Object.keys(filters)) {
         if (key === "inherited") {
-            if (reflection.inheritedFrom) {
+            if (reflection.isDeclaration() && reflection.inheritedFrom) {
                 classes.push("tsd-is-inherited");
             }
         }