typedoc 0.26.11 → 0.27.0-beta.1

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

@@ -1,8 +1,8 @@
-import { ContextAwareRendererComponent } from "../components";
-import { type RendererEvent, MarkdownEvent, type PageEvent } from "../events";
+import { ContextAwareRendererComponent } from "../components.js";
+import { MarkdownEvent, RendererEvent, type PageEvent } from "../events.js";
 import type { BundledTheme } from "shiki" with { "resolution-mode": "import" };
-import type { DefaultThemeRenderContext } from "..";
-import { type CommentDisplayPart } from "../../models";
+import type { DefaultThemeRenderContext, Renderer } from "../index.js";
+import { type CommentDisplayPart } from "../../models/index.js";
 /**
  * Implements markdown and relativeURL helpers for templates.
  * @internal
@@ -13,18 +13,16 @@ export declare class MarkedPlugin extends ContextAwareRendererComponent {
     accessor markdownItOptions: Record<string, unknown>;
     accessor markdownLinkExternal: boolean;
     private parser?;
+    private renderedRelativeLinks;
     /**
      * 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 renderContext;
     private lastHeaderSlug;
+    constructor(owner: Renderer);
     /**
-     * Create a new MarkedPlugin instance.
-     */
-    initialize(): void;
-    /**
-     * Highlight the syntax of the given text using HighlightJS.
+     * Highlight the syntax of the given text using Shiki.
      *
      * @param text  The text that should be highlighted.
      * @param lang  The language that should be used to highlight the string.
@@ -39,6 +37,7 @@ export declare class MarkedPlugin extends ContextAwareRendererComponent {
      */
     parseMarkdown(input: string | readonly CommentDisplayPart[], page: PageEvent<any>, context: DefaultThemeRenderContext): string;
     private displayPartsToMarkdown;
+    private onEnd;
     /**
      * Triggered before the renderer starts rendering a project.
      *

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

@@ -1,4 +1,3 @@
-"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";
@@ -33,54 +32,20 @@ var __runInitializers = (this && this.__runInitializers) || function (thisArg, i
     }
     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 });
-};
-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;
-};
-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 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;
-}
+import MarkdownIt from "markdown-it";
+import { ContextAwareRendererComponent } from "../components.js";
+import { MarkdownEvent, RendererEvent } from "../events.js";
+import { Option, renderElement, assertNever } from "../../utils/index.js";
+import { highlight, isLoadedLanguage, isSupportedLanguage } from "../../utils/highlighter.js";
+import { escapeHtml } from "../../utils/html.js";
+import { anchorIcon } from "./default/partials/anchor-icon.js";
+import { ReflectionKind, } from "../../models/index.js";
 /**
  * Implements markdown and relativeURL helpers for templates.
  * @internal
  */
 let MarkedPlugin = (() => {
-    var _MarkedPlugin_lightTheme_accessor_storage, _MarkedPlugin_darkTheme_accessor_storage, _MarkedPlugin_markdownItOptions_accessor_storage, _MarkedPlugin_markdownLinkExternal_accessor_storage;
-    let _classDecorators = [(0, components_1.Component)({ name: "marked" })];
-    let _classDescriptor;
-    let _classExtraInitializers = [];
-    let _classThis;
-    let _classSuper = components_1.ContextAwareRendererComponent;
+    let _classSuper = ContextAwareRendererComponent;
     let _lightTheme_decorators;
     let _lightTheme_initializers = [];
     let _lightTheme_extraInitializers = [];
@@ -93,38 +58,46 @@ let MarkedPlugin = (() => {
     let _markdownLinkExternal_decorators;
     let _markdownLinkExternal_initializers = [];
     let _markdownLinkExternal_extraInitializers = [];
-    var MarkedPlugin = _classThis = class extends _classSuper {
-        constructor() {
-            super(...arguments);
-            _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)));
-            _MarkedPlugin_markdownLinkExternal_accessor_storage.set(this, (__runInitializers(this, _markdownItOptions_extraInitializers), __runInitializers(this, _markdownLinkExternal_initializers, void 0)));
-            this.parser = __runInitializers(this, _markdownLinkExternal_extraInitializers);
-            /**
-             * 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.renderContext = null;
-            this.lastHeaderSlug = "";
+    return class MarkedPlugin extends _classSuper {
+        static {
+            const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(_classSuper[Symbol.metadata] ?? null) : void 0;
+            _lightTheme_decorators = [Option("lightHighlightTheme")];
+            _darkTheme_decorators = [Option("darkHighlightTheme")];
+            _markdownItOptions_decorators = [Option("markdownItOptions")];
+            _markdownLinkExternal_decorators = [Option("markdownLinkExternal")];
+            __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, _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(this, null, _markdownLinkExternal_decorators, { kind: "accessor", name: "markdownLinkExternal", static: false, private: false, access: { has: obj => "markdownLinkExternal" in obj, get: obj => obj.markdownLinkExternal, set: (obj, value) => { obj.markdownLinkExternal = value; } }, metadata: _metadata }, _markdownLinkExternal_initializers, _markdownLinkExternal_extraInitializers);
+            if (_metadata) Object.defineProperty(this, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
         }
-        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"); }
-        get markdownLinkExternal() { return __classPrivateFieldGet(this, _MarkedPlugin_markdownLinkExternal_accessor_storage, "f"); }
-        set markdownLinkExternal(value) { __classPrivateFieldSet(this, _MarkedPlugin_markdownLinkExternal_accessor_storage, value, "f"); }
+        #lightTheme_accessor_storage = __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; }
+        #markdownItOptions_accessor_storage = (__runInitializers(this, _darkTheme_extraInitializers), __runInitializers(this, _markdownItOptions_initializers, void 0));
+        get markdownItOptions() { return this.#markdownItOptions_accessor_storage; }
+        set markdownItOptions(value) { this.#markdownItOptions_accessor_storage = value; }
+        #markdownLinkExternal_accessor_storage = (__runInitializers(this, _markdownItOptions_extraInitializers), __runInitializers(this, _markdownLinkExternal_initializers, void 0));
+        get markdownLinkExternal() { return this.#markdownLinkExternal_accessor_storage; }
+        set markdownLinkExternal(value) { this.#markdownLinkExternal_accessor_storage = value; }
+        parser = __runInitializers(this, _markdownLinkExternal_extraInitializers);
+        renderedRelativeLinks = [];
         /**
-         * Create a new MarkedPlugin instance.
+         * 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.
          */
-        initialize() {
-            super.initialize();
-            this.owner.on(events_1.MarkdownEvent.PARSE, this.onParseMarkdown.bind(this));
+        renderContext = null;
+        lastHeaderSlug = "";
+        constructor(owner) {
+            super(owner);
+            this.owner.on(MarkdownEvent.PARSE, this.onParseMarkdown.bind(this));
+            this.owner.on(RendererEvent.END, this.onEnd.bind(this));
         }
         /**
-         * Highlight the syntax of the given text using HighlightJS.
+         * Highlight the syntax of the given text using Shiki.
          *
          * @param text  The text that should be highlighted.
          * @param lang  The language that should be used to highlight the string.
@@ -133,15 +106,15 @@ let MarkedPlugin = (() => {
         getHighlighted(text, lang) {
             lang = lang || "typescript";
             lang = lang.toLowerCase();
-            if (!(0, highlighter_1.isSupportedLanguage)(lang)) {
+            if (!isSupportedLanguage(lang)) {
                 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;
             }
-            if (!(0, highlighter_1.isLoadedLanguage)(lang)) {
+            if (!isLoadedLanguage(lang)) {
                 this.application.logger.warn(this.application.i18n.unloaded_language_0_not_highlighted_in_comment_for_1(lang, this.page?.model.getFriendlyFullName() ?? "(unknown)"));
                 return text;
             }
-            return (0, highlighter_1.highlight)(text, lang);
+            return highlight(text, lang);
         }
         /**
          * Parse the given markdown string and return the resulting html.
@@ -155,8 +128,8 @@ let MarkedPlugin = (() => {
                 markdown = this.displayPartsToMarkdown(page, context, markdown);
             }
             this.renderContext = context;
-            const event = new events_1.MarkdownEvent(page, markdown, markdown);
-            this.owner.trigger(events_1.MarkdownEvent.PARSE, event);
+            const event = new MarkdownEvent(page, markdown, markdown);
+            this.owner.trigger(MarkdownEvent.PARSE, event);
             this.renderContext = null;
             return event.parsedText;
         }
@@ -187,7 +160,7 @@ let MarkedPlugin = (() => {
                                         // No point in trying to resolve a ReflectionSymbolId at this point, we've already
                                         // tried and failed during the resolution step.
                                         url = context.urlTo(part.target);
-                                        kindClass = models_1.ReflectionKind.classString(part.target.kind);
+                                        kindClass = ReflectionKind.classString(part.target.kind);
                                     }
                                     if (useHtml) {
                                         const text = part.tag === "@linkcode" ? `<code>${part.text}</code>` : part.text;
@@ -215,14 +188,29 @@ let MarkedPlugin = (() => {
                     case "relative-link":
                         switch (typeof part.target) {
                             case "number": {
-                                const refl = page.project.files.resolve(part.target);
+                                const refl = page.project.files.resolve(part.target, page.model.project);
+                                let url;
                                 if (typeof refl === "object") {
-                                    result.push(context.urlTo(refl));
-                                    break;
+                                    url = context.urlTo(refl);
+                                }
+                                else {
+                                    const fileName = page.project.files.getName(part.target);
+                                    if (fileName) {
+                                        url = context.relativeURL(`media/${fileName}`);
+                                    }
                                 }
-                                const fileName = page.project.files.getName(part.target);
-                                if (fileName) {
-                                    result.push(context.relativeURL(`media/${fileName}`));
+                                if (url) {
+                                    if (part.targetAnchor) {
+                                        url += "#" + part.targetAnchor;
+                                        if (typeof refl === "object") {
+                                            this.renderedRelativeLinks.push({
+                                                source: this.page.model,
+                                                target: refl,
+                                                link: part,
+                                            });
+                                        }
+                                    }
+                                    result.push(url);
                                     break;
                                 }
                             }
@@ -233,11 +221,24 @@ let MarkedPlugin = (() => {
                         }
                         break;
                     default:
-                        (0, utils_1.assertNever)(part);
+                        assertNever(part);
                 }
             }
             return result.join("");
         }
+        onEnd() {
+            for (const { source, target, link } of this.renderedRelativeLinks) {
+                const slugger = this.owner.theme.getSlugger(target);
+                if (!slugger.hasAnchor(link.targetAnchor)) {
+                    this.application.logger.warn(this.application.i18n.reflection_0_links_to_1_but_anchor_does_not_exist_try_2(source.getFriendlyFullName(), link.text, slugger
+                        .getSimilarAnchors(link.targetAnchor)
+                        .map((a) => link.text.replace(/#.*/, "#" + a))
+                        .join("\n\t")));
+                }
+            }
+            // In case we're in watch mode
+            this.renderedRelativeLinks = [];
+        }
         /**
          * Triggered before the renderer starts rendering a project.
          *
@@ -248,10 +249,7 @@ let MarkedPlugin = (() => {
             this.setupParser();
         }
         getSlugger() {
-            if ("getSlugger" in this.owner.theme) {
-                return this.owner.theme.getSlugger(this.page.model);
-            }
-            return getDefaultSlugger(this.application.logger);
+            return this.owner.theme.getSlugger(this.page.model);
         }
         /**
          * Creates an object with options that are passed to the markdown parser.
@@ -259,7 +257,7 @@ let MarkedPlugin = (() => {
          * @returns The options object for the markdown parser.
          */
         setupParser() {
-            this.parser = (0, markdown_it_1.default)({
+            this.parser = MarkdownIt({
                 ...this.markdownItOptions,
                 highlight: (code, lang) => {
                     code = this.getHighlighted(code, lang || "ts");
@@ -267,9 +265,10 @@ let MarkedPlugin = (() => {
                     if (!lang) {
                         return `<pre><code>${code}</code><button>${this.application.i18n.theme_copy()}</button></pre>\n`;
                     }
-                    return `<pre><code class="${(0, html_1.escapeHtml)(lang)}">${code}</code><button type="button">${this.application.i18n.theme_copy()}</button></pre>\n`;
+                    return `<pre><code class="${escapeHtml(lang)}">${code}</code><button type="button">${this.application.i18n.theme_copy()}</button></pre>\n`;
                 },
             });
+            githubAlertMarkdownPlugin(this.parser, this.application.i18n);
             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
@@ -279,22 +278,21 @@ let MarkedPlugin = (() => {
                 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}`,
+                    link: `#${slug}`,
                     text: content,
                     level,
                 });
-                return `<a id="md:${slug}" class="tsd-anchor"></a><${token.tag} class="tsd-anchor-link">`;
+                return `<a id="${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}>`;
+                return `${renderElement(anchorIcon(this.renderContext, 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");
+                const href = token.attrGet("href");
                 if (href) {
                     // Note: This doesn't catch @link tags to reflections as those
                     // will be relative links. This will likely have to change with
@@ -310,6 +308,11 @@ let MarkedPlugin = (() => {
                 }
                 return self.renderToken(tokens, idx, options);
             };
+            this.parser.renderer.rules["alert_open"] = (tokens, idx) => {
+                const icon = this.renderContext.icons[tokens[idx].attrGet("icon")];
+                const iconHtml = renderElement(icon());
+                return `<div class="${tokens[idx].attrGet("class")}"><div class="tsd-alert-title">${iconHtml}<span>${tokens[idx].attrGet("alert")}</span></div>`;
+            };
         }
         /**
          * Triggered when {@link MarkedPlugin} parses a markdown string.
@@ -320,32 +323,64 @@ let MarkedPlugin = (() => {
             event.parsedText = this.parser.render(event.parsedText);
         }
     };
-    _MarkedPlugin_lightTheme_accessor_storage = new WeakMap();
-    _MarkedPlugin_darkTheme_accessor_storage = new WeakMap();
-    _MarkedPlugin_markdownItOptions_accessor_storage = new WeakMap();
-    _MarkedPlugin_markdownLinkExternal_accessor_storage = new WeakMap();
-    __setFunctionName(_classThis, "MarkedPlugin");
-    (() => {
-        const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(_classSuper[Symbol.metadata] ?? null) : void 0;
-        _lightTheme_decorators = [(0, utils_1.Option)("lightHighlightTheme")];
-        _darkTheme_decorators = [(0, utils_1.Option)("darkHighlightTheme")];
-        _markdownItOptions_decorators = [(0, utils_1.Option)("markdownItOptions")];
-        _markdownLinkExternal_decorators = [(0, utils_1.Option)("markdownLinkExternal")];
-        __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(_classThis, null, _markdownLinkExternal_decorators, { kind: "accessor", name: "markdownLinkExternal", static: false, private: false, access: { has: obj => "markdownLinkExternal" in obj, get: obj => obj.markdownLinkExternal, set: (obj, value) => { obj.markdownLinkExternal = value; } }, metadata: _metadata }, _markdownLinkExternal_initializers, _markdownLinkExternal_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 });
-        __runInitializers(_classThis, _classExtraInitializers);
-    })();
-    return MarkedPlugin = _classThis;
 })();
-exports.MarkedPlugin = MarkedPlugin;
+export { MarkedPlugin };
 function getTokenTextContent(token) {
     if (token.children) {
         return token.children.map(getTokenTextContent).join("");
     }
     return token.content;
 }
+const kindNames = ["note", "tip", "important", "warning", "caution"];
+const iconNames = ["alertNote", "alertTip", "alertImportant", "alertWarning", "alertCaution"];
+const kindTranslations = [
+    (i18n) => i18n.alert_note(),
+    (i18n) => i18n.alert_tip(),
+    (i18n) => i18n.alert_important(),
+    (i18n) => i18n.alert_warning(),
+    (i18n) => i18n.alert_caution(),
+];
+function githubAlertMarkdownPlugin(md, i18n) {
+    md.core.ruler.after("block", "typedoc-github-alert-plugin", (state) => {
+        const bqStarts = [];
+        for (let i = 0; i < state.tokens.length; ++i) {
+            const token = state.tokens[i];
+            if (token.type === "blockquote_open") {
+                bqStarts.push(i);
+            }
+            else if (token.type === "blockquote_close") {
+                if (bqStarts.length === 1) {
+                    checkForAlert(state.tokens, bqStarts[0], i, i18n);
+                }
+                bqStarts.pop();
+            }
+        }
+    });
+}
+function checkForAlert(tokens, start, end, i18n) {
+    let alertKind = -1;
+    // Search for the first "inline" token. That will be the blockquote text.
+    for (let i = start; i < end; ++i) {
+        if (tokens[i].type === "inline") {
+            // Check for `[!NOTE]`
+            const kindString = tokens[i].content.match(/^\[!(\w+)\]/);
+            const kindIndex = kindNames.indexOf(kindString?.[1].toLowerCase() || "");
+            if (kindIndex !== -1) {
+                tokens[i].content = tokens[i].content.substring(kindString[0].length);
+                alertKind = kindIndex;
+            }
+            break;
+        }
+    }
+    // If we found an alert, then replace the blockquote_open and blockquote_close tokens with
+    // alert_open and alert_close tokens that can be rendered specially.
+    if (alertKind === -1)
+        return;
+    tokens[start].type = "alert_open";
+    tokens[start].tag = "div";
+    tokens[start].attrPush(["class", `tsd-alert tsd-alert-${kindNames[alertKind]}`]);
+    tokens[start].attrPush(["alert", kindTranslations[alertKind](i18n)]);
+    tokens[start].attrPush(["icon", iconNames[alertKind]]);
+    tokens[end].type = "alert_close";
+    tokens[end].tag = "div";
+}

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

@@ -1,11 +1,11 @@
-import { Theme } from "../../theme";
-import type { Renderer } from "../../renderer";
-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";
-import { JSX } from "../../../utils";
+import { Theme } from "../../theme.js";
+import type { Renderer } from "../../renderer.js";
+import { ReflectionKind, ProjectReflection, type ContainerReflection, DeclarationReflection, type Reflection, type DocumentReflection } from "../../../models/index.js";
+import { type RenderTemplate, UrlMapping } from "../../models/UrlMapping.js";
+import type { PageEvent } from "../../events.js";
+import type { MarkedPlugin } from "../../plugins/index.js";
+import { DefaultThemeRenderContext } from "./DefaultThemeRenderContext.js";
+import { JSX } from "../../../utils/index.js";
 export interface NavigationElement {
     text: string;
     path?: string;
@@ -13,19 +13,9 @@ 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.
- */
 export declare class DefaultTheme extends Theme {
+    usedFileNames: Set<string>;
+    private accessor sluggerConfiguration;
     /** @internal */
     markedPlugin: MarkedPlugin;
     /**
@@ -73,6 +63,11 @@ export declare class DefaultTheme extends Theme {
         menu: () => JSX.Element;
         chevronSmall: () => JSX.Element;
         folder: () => JSX.Element;
+        alertNote: () => JSX.Element;
+        alertTip: () => JSX.Element;
+        alertImportant: () => JSX.Element;
+        alertWarning: () => JSX.Element;
+        alertCaution: () => JSX.Element;
     };
     getRenderContext(pageEvent: PageEvent<Reflection>): DefaultThemeRenderContext;
     documentTemplate: (pageEvent: PageEvent<DocumentReflection>) => JSX.Element;
@@ -101,14 +96,9 @@ export declare class DefaultTheme extends Theme {
      */
     getUrls(project: ProjectReflection): UrlMapping[];
     /**
-     * Return a url for the given reflection.
-     *
      * @param reflection  The reflection the url should be generated for.
-     * @param relative    The parent reflection the url generation should stop on.
-     * @param separator   The separator used to generate the url.
-     * @returns           The generated url.
      */
-    static getUrl(reflection: Reflection, relative?: Reflection, separator?: string): string;
+    getFileName(reflection: Reflection): string;
     /**
      * Return the template mapping for the given reflection.
      *
@@ -131,13 +121,11 @@ 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.
      *
      * @param reflection  The reflection an anchor url should be created for.
      * @param container   The nearest reflection having an own document.
      */
-    static applyAnchorUrl(reflection: Reflection, container: Reflection): void;
+    applyAnchorUrl(reflection: Reflection, container: Reflection): void;
 }