typedoc 0.26.6 → 0.26.8

package/dist/lib/converter/comments/discovery.js

@@ -263,6 +263,13 @@ function findJsDocForComment(node, ranges) {
         const jsDocs = typescript_1.default
             .getJSDocCommentsAndTags(node)
             .map((doc) => typescript_1.default.findAncestor(doc, typescript_1.default.isJSDoc));
+        if (typescript_1.default.isSourceFile(node)) {
+            if (node.statements.length) {
+                jsDocs.push(...typescript_1.default
+                    .getJSDocCommentsAndTags(node.statements[0])
+                    .map((doc) => typescript_1.default.findAncestor(doc, typescript_1.default.isJSDoc)));
+            }
+        }
         return jsDocs.find((doc) => doc.pos === ranges[0].pos);
     }
 }

package/dist/lib/converter/comments/linkResolver.d.ts

@@ -1,4 +1,4 @@
-import { type Comment, type CommentDisplayPart, type Reflection, ReflectionSymbolId } from "../../models";
+import { type Comment, type CommentDisplayPart, Reflection, ReflectionSymbolId } from "../../models";
 import { type DeclarationReference } from "./declarationReference";
 export type ExternalResolveResult = {
     target: string;

package/dist/lib/converter/comments/linkResolver.js

@@ -36,6 +36,11 @@ function processPart(reflection, part, externalResolver, options) {
     return part;
 }
 function resolveLinkTag(reflection, part, externalResolver, options) {
+    // This tag may have already been resolved to if we are running in packages mode
+    // or when reading in a JSON file. #2680.
+    if (typeof part.target === "string" || part.target instanceof models_1.Reflection) {
+        return part;
+    }
     let defaultDisplayText = "";
     let pos = 0;
     const end = part.text.length;
@@ -55,16 +60,19 @@ function resolveLinkTag(reflection, part, externalResolver, options) {
                 part.tsLinkText ||
                     (options.preserveLinkText ? part.text : target.name);
         }
-        else if (declRef) {
+        else {
             // If we didn't find a target, we might be pointing to a symbol in another project that will be merged in
             // or some external symbol, so ask external resolvers to try resolution. Don't use regular declaration ref
             // resolution in case it matches something that would have been merged in later.
-            const externalResolveResult = externalResolver(declRef[0], reflection, part, part.target instanceof models_1.ReflectionSymbolId
-                ? part.target
-                : undefined);
-            defaultDisplayText = options.preserveLinkText
-                ? part.text
-                : part.text.substring(0, pos);
+            if (declRef) {
+                pos = declRef[1];
+            }
+            const externalResolveResult = externalResolver(declRef?.[0] ?? part.target.toDeclarationReference(), reflection, part, part.target);
+            defaultDisplayText =
+                part.tsLinkText ||
+                    (options.preserveLinkText
+                        ? part.text
+                        : part.text.substring(0, pos));
             switch (typeof externalResolveResult) {
                 case "string":
                     target = externalResolveResult;

package/dist/lib/converter/comments/parser.js

@@ -514,6 +514,10 @@ function inlineTag(lexer, block, config, i18n, warning) {
     };
     if (tagName.tsLinkTarget) {
         inlineTag.target = tagName.tsLinkTarget;
+    }
+    // Separated from tsLinkTarget to avoid storing a useless empty string
+    // if TS doesn't have an opinion on what the link text should be.
+    if (tagName.tsLinkText) {
         inlineTag.tsLinkText = tagName.tsLinkText;
     }
     block.push(inlineTag);

package/dist/lib/converter/convert-expression.js

@@ -28,10 +28,16 @@ function convertExpression(expression) {
         case typescript_1.default.SyntaxKind.FalseKeyword:
         case typescript_1.default.SyntaxKind.NullKeyword:
         case typescript_1.default.SyntaxKind.NumericLiteral:
-        case typescript_1.default.SyntaxKind.PrefixUnaryExpression:
+        case typescript_1.default.SyntaxKind.BigIntLiteral:
         case typescript_1.default.SyntaxKind.Identifier:
             return expression.getText();
     }
+    if (typescript_1.default.isPrefixUnaryExpression(expression)) {
+        const inner = convertExpression(expression.operand);
+        if (inner != "...") {
+            return expression.getText();
+        }
+    }
     if (typescript_1.default.isArrayLiteralExpression(expression) &&
         expression.elements.length === 0) {
         return "[]";

package/dist/lib/converter/factories/signature.js

@@ -100,6 +100,10 @@ function createConstructSignatureWithType(context, signature, classType) {
     context.converter.trigger(converter_events_1.ConverterEvents.CREATE_SIGNATURE, context, sigRef, declaration, signature);
 }
 function convertParameters(context, sigRef, parameters, parameterNodes) {
+    // #2698 if `satisfies` is used to imply a this parameter, we might have
+    // more parameters than parameter nodes and need to shift the parameterNode
+    // access index. Very ugly, but it does the job.
+    const parameterNodeOffset = parameterNodes?.length !== parameters.length ? -1 : 0;
     return parameters.map((param, i) => {
         const declaration = param.valueDeclaration;
         (0, assert_1.default)(!declaration ||
@@ -139,7 +143,7 @@ function convertParameters(context, sigRef, parameters, parameterNodes) {
         if (isOptional) {
             paramRefl.type = (0, reflections_1.removeUndefined)(paramRefl.type);
         }
-        paramRefl.defaultValue = (0, convert_expression_1.convertDefaultValue)(parameterNodes?.[i]);
+        paramRefl.defaultValue = (0, convert_expression_1.convertDefaultValue)(parameterNodes?.[i + parameterNodeOffset]);
         paramRefl.setFlag(models_1.ReflectionFlag.Optional, isOptional);
         // If we have no declaration, then this is an implicitly defined parameter in JS land
         // because the method body uses `arguments`... which is always a rest argument
@@ -151,7 +155,7 @@ function convertParameters(context, sigRef, parameters, parameterNodes) {
                     typescript_1.default.isJSDocVariadicType(declaration.typeExpression.type);
         }
         paramRefl.setFlag(models_1.ReflectionFlag.Rest, isRest);
-        checkForDestructuredParameterDefaults(paramRefl, parameterNodes?.[i]);
+        checkForDestructuredParameterDefaults(paramRefl, parameterNodes?.[i + parameterNodeOffset]);
         return paramRefl;
     });
 }

package/dist/lib/converter/plugins/CommentPlugin.js

@@ -237,6 +237,15 @@ let CommentPlugin = (() => {
             if (reflection.kindOf(models_1.ReflectionKind.Interface)) {
                 comment.removeModifier("@interface");
             }
+            if (comment.hasModifier("@abstract")) {
+                if (reflection.kindOf(models_1.ReflectionKind.SomeSignature)) {
+                    reflection.parent.setFlag(models_1.ReflectionFlag.Abstract);
+                }
+                else {
+                    reflection.setFlag(models_1.ReflectionFlag.Abstract);
+                }
+                comment.removeModifier("@abstract");
+            }
             if (comment.hasModifier("@private")) {
                 reflection.setFlag(models_1.ReflectionFlag.Private);
                 if (reflection.kindOf(models_1.ReflectionKind.CallSignature)) {
@@ -406,12 +415,14 @@ let CommentPlugin = (() => {
                     reflection.comment.removeModifier("@hideconstructor");
                 }
             }
-            if (reflection instanceof models_1.DeclarationReflection && reflection.comment) {
-                let sigs;
+            if ((reflection instanceof models_1.DeclarationReflection ||
+                reflection instanceof models_1.ParameterReflection) &&
+                reflection.comment) {
+                let sigs = [];
                 if (reflection.type instanceof models_1.ReflectionType) {
                     sigs = reflection.type.declaration.getNonIndexSignatures();
                 }
-                else {
+                else if (reflection instanceof models_1.DeclarationReflection) {
                     sigs = reflection.getNonIndexSignatures();
                 }
                 // For variables and properties, the symbol might own the comment but we might also

package/dist/lib/internationalization/locales/zh.cjs

@@ -21,61 +21,64 @@ module.exports = (0, translatable_1.buildIncompleteTranslation)({
     no_entry_points_to_merge: "没有提供合并的入口点",
     entrypoint_did_not_match_files_0: "入口点 glob {0} 与任何文件均不匹配",
     failed_to_parse_json_0: "无法将 {0} 处的文件解析为 json",
-    failed_to_read_0_when_processing_document_tag_in_1: "处理 {1} 中注释的 @document 标记时无法读取文件 {0}",
+    failed_to_read_0_when_processing_document_tag_in_1: "处理 {1} 中注释的 @document 标签时无法读取文件 {0}",
     failed_to_read_0_when_processing_project_document: "添加项目文档时无法读取文件 {0}",
     failed_to_read_0_when_processing_document_child_in_1: "处理 {1} 中的文档子项时无法读取文件 {0}",
     frontmatter_children_0_should_be_an_array_of_strings_or_object_with_string_values: "{0} 中的 Frontmatter 子项应为字符串数组或具有字符串值的对象",
     converting_union_as_interface: "在联合类型上使用 @interface 将丢弃联合所有分支上不存在的属性。TypeDoc 的输出可能无法准确描述您的源代码",
     converting_0_as_class_requires_value_declaration: "将 {0} 转换为类需要表示非类型值的声明",
     converting_0_as_class_without_construct_signatures: "{0} 正在转换为类，但没有任何构造签名",
-    comment_for_0_should_not_contain_block_or_modifier_tags: "{0} 的注释不应包含任何块或修饰符标签",
+    comment_for_0_should_not_contain_block_or_modifier_tags: "{0} 的注释不应包含任何块级标签或修饰符标签",
     symbol_0_has_multiple_declarations_with_comment: "{0} 有多个带注释的声明。将使用任意注释",
     comments_for_0_are_declared_at_1: "{0} 的注释声明于：\n{1}",
-    multiple_type_parameters_on_template_tag_unsupported: "TypeDoc 不支持在带有注释的单个 @template 标记中定义多个类型参数",
+    multiple_type_parameters_on_template_tag_unsupported: "TypeDoc 不支持在带有注释的单个 @template 标签中定义多个类型参数",
     failed_to_find_jsdoc_tag_for_name_0: "解析注释后无法找到 {0} 的 JSDoc 标签，请提交错误报告",
-    // relative_path_0_is_not_a_file_and_will_not_be_copied_to_output
-    inline_inheritdoc_should_not_appear_in_block_tag_in_comment_at_0: "内联 @inheritDoc 标记不应出现在块标记内，因为它不会在 {0} 处的注释中被处理。",
+    relative_path_0_is_not_a_file_and_will_not_be_copied_to_output: "找不到相对路径 {0} 对应的文件，该文件不会被复制至输出目录",
+    inline_inheritdoc_should_not_appear_in_block_tag_in_comment_at_0: "内联 @inheritDoc 标签不应出现在块级标签内，因为它不会在 {0} 处的注释中被处理。",
     at_most_one_remarks_tag_expected_in_comment_at_0: "注释中最多应有一个 @remarks 标签，忽略 {0} 处注释中除第一个标签之外的所有标签",
     at_most_one_returns_tag_expected_in_comment_at_0: "注释中最多应有一个 @returns 标签，忽略 {0} 处注释中除第一个标签之外的所有标签",
     at_most_one_inheritdoc_tag_expected_in_comment_at_0: "注释中最多应有一个 @inheritDoc 标签，忽略 {0} 处注释中除第一个标签之外的所有标签",
-    content_in_summary_overwritten_by_inheritdoc_in_comment_at_0: "摘要部分的内容将被 {0} 处注释中的 @inheritDoc 标记覆盖",
-    content_in_remarks_block_overwritten_by_inheritdoc_in_comment_at_0: "@remarks 块中的内容将被 {0} 处注释中的 @inheritDoc 标记覆盖",
-    example_tag_literal_name: "示例标签的第一行将按字面意思理解为示例名称，并且只能包含文本",
+    content_in_summary_overwritten_by_inheritdoc_in_comment_at_0: "摘要部分的内容将被 {0} 处注释中的 @inheritDoc 标签覆盖",
+    content_in_remarks_block_overwritten_by_inheritdoc_in_comment_at_0: "@remarks 块中的内容将被 {0} 处注释中的 @inheritDoc 标签覆盖",
+    example_tag_literal_name: "示例标签的第一行将按原样作为示例名称，并且只能包含文本",
     inheritdoc_tag_properly_capitalized: "@inheritDoc 标签应正确大写",
     treating_unrecognized_tag_0_as_modifier: "将无法识别的标签 {0} 视为修饰标签",
     unmatched_closing_brace: "不匹配的右括号",
     unescaped_open_brace_without_inline_tag: "遇到未转义的无内联标签的开括号",
-    unknown_block_tag_0: "遇到未知的区块标记 {0}",
-    unknown_inline_tag_0: "遇到未知的内联标记 {0}",
+    unknown_block_tag_0: "遇到未知的块级标签 {0}",
+    unknown_inline_tag_0: "遇到未知的内联标签 {0}",
     open_brace_within_inline_tag: "在内联标签中遇到左括号，这可能是一个错误",
     inline_tag_not_closed: "内联标签未关闭",
-    failed_to_resolve_link_to_0_in_comment_for_1: "无法解析“{1}”评论中的“{0}”链接",
+    failed_to_resolve_link_to_0_in_comment_for_1: "无法解析 {1} 注释中指向 “{0}” 的链接",
+    failed_to_resolve_link_to_0_in_comment_for_1_may_have_meant_2: "无法解析 {1} 的注释中指向 “{0}” 的链接。您可能想要 “{2}”",
+    failed_to_resolve_link_to_0_in_readme_for_1: "无法解析 {1} 的自述文件中指向 “{0}” 的链接",
+    failed_to_resolve_link_to_0_in_readme_for_1_may_have_meant_2: "无法解析 {1} 的自述文件中指向 “{0}” 的链接。您可能想要 “{2}”",
+    failed_to_resolve_link_to_0_in_document_1: "无法解析文档 {1} 中指向 “{0}” 的链接",
+    failed_to_resolve_link_to_0_in_document_1_may_have_meant_2: "无法解析文档 {1} 中指向 “{0}” 的链接。您可能想要 “{2}”",
     type_0_defined_in_1_is_referenced_by_2_but_not_included_in_docs: "{0} 在 {1} 中定义，被 {2} 引用，但未包含在文档中",
     reflection_0_kind_1_defined_in_2_does_not_have_any_documentation: "{0} ({1})，在 {2} 中定义，没有任何文档",
     invalid_intentionally_not_exported_symbols_0: "以下符号被标记为有意不导出，但未在文档中引用，或已被导出：\n{0}",
     not_all_search_category_boosts_used_0: "文档中并未使用 searchCategoryBoosts 中指定的所有类别。未使用的类别包括：\n{0}",
     not_all_search_group_boosts_used_0: "文档中并未使用 searchGroupBoosts 中指定的所有组。未使用的组为：\n{0}",
-    comment_for_0_includes_categoryDescription_for_1_but_no_child_in_group: "{0} 的评论包含“{1}”的 @categoryDe​​scription，但该类别中没有子项",
-    comment_for_0_includes_groupDescription_for_1_but_no_child_in_group: "对 {0} 的评论包含“{1}”的 @groupDescription，但该组中没有子项",
+    comment_for_0_includes_categoryDescription_for_1_but_no_child_in_group: "{0} 的注释包含“{1}”的 @categoryDe​​scription，但该类别中没有子项",
+    comment_for_0_includes_groupDescription_for_1_but_no_child_in_group: "{0} 的注释包含“{1}”的 @groupDescription，但该组中没有子项",
     label_0_for_1_cannot_be_referenced: "无法使用声明引用来引用 {1} 的标签“{0}”。标签只能包含 A-Z、0-9 和 _，并且不能以数字开头",
-    modifier_tag_0_is_mutually_exclusive_with_1_in_comment_for_2: "修饰符标记 {0} 与 {2} 注释中的 {1} 互斥",
+    modifier_tag_0_is_mutually_exclusive_with_1_in_comment_for_2: "修饰符标签 {0} 与 {2} 注释中的 {1} 互斥",
     signature_0_has_unused_param_with_name_1: "签名 {0} 有一个名为“{1}”的 @param，但未被使用",
     declaration_reference_in_inheritdoc_for_0_not_fully_parsed: "@inheritDoc 中对 {0} 的声明引用未完全解析，可能会解析不正确",
-    failed_to_find_0_to_inherit_comment_from_in_1: "在 {1} 的评论中找不到要继承的评论“{0}”",
-    failed_to_resolve_link_to_0_in_comment_for_1_may_have_meant_2: `无法解析 {1} 的注释中指向"{0}"的链接。您可能想要"{2}"`,
-    failed_to_resolve_link_to_0_in_readme_for_1: `无法解析 {1} 的自述文件中指向"{0}"的链接`,
-    failed_to_resolve_link_to_0_in_readme_for_1_may_have_meant_2: `无法解析 {1} 的自述文件中指向"{0}"的链接。您可能想要"{2}"`,
+    failed_to_find_0_to_inherit_comment_from_in_1: "在 {1} 的注释中找不到要继承的注释“{0}”",
     reflection_0_tried_to_copy_comment_from_1_but_source_had_no_comment: "{0} 尝试使用 @inheritDoc 从 {1} 复制注释，但源没有相关注释",
     inheritdoc_circular_inheritance_chain_0: "@inheritDoc 指定循环继承链：{0}",
     provided_readme_at_0_could_not_be_read: "提供的 README 路径无法读取 {0}",
     defaulting_project_name: "未指定 --name 选项，并且未找到 package.json。将项目名称默认为“Documentation”",
-    disable_git_set_but_not_source_link_template: "已设置 disableGit，但未设置 sourceLinkTemplate，因此无法生成源链接。设置 sourceLinkTemplate 或 disableSources 以阻止源跟踪",
+    disable_git_set_but_not_source_link_template: "已设置 disableGit，但未设置 sourceLinkTemplate，因此无法生成源代码链接。设置 sourceLinkTemplate 或 disableSources 以停用源代码跟踪",
     disable_git_set_and_git_revision_used: "disableGit 已设置，并且 sourceLinkTemplate 包含 {gitRevision}，由于未提供修订，因此将替换为空字符串",
     git_remote_0_not_valid: "提供的 git 远程“{0}”无效。源链接将失效",
     custom_css_file_0_does_not_exist: "{0} 处的自定义 CSS 文件不存在",
-    unsupported_highlight_language_0_not_highlighted_in_comment_for_1: "不支持的突出显示语言 {0} 将不会在 {1} 的评论中突出显示",
-    unloaded_language_0_not_highlighted_in_comment_for_1: "语言为 {0} 的代码块将不会在 {1} 的注释中突出显示，因为它未包含在 highlightLanguages 选项中",
-    yaml_frontmatter_not_an_object: "预期 YAML 前置内容为对象",
+    custom_js_file_0_does_not_exist: "{0} 处的自定义 JavaScript 文件不存在",
+    unsupported_highlight_language_0_not_highlighted_in_comment_for_1: "不支持的高亮语言 {0} 将不会在 {1} 的注释中高亮",
+    unloaded_language_0_not_highlighted_in_comment_for_1: "语言为 {0} 的代码块将不会在 {1} 的注释中高亮，因为它未包含在 highlightLanguages 选项中",
+    yaml_frontmatter_not_an_object: "YAML Frontmatter 应当为对象",
     could_not_write_0: "无法写入 {0}",
     could_not_empty_output_directory_0: "无法清空输出目录 {0}",
     could_not_create_output_directory_0: "无法创建输出目录 {0}",
@@ -93,12 +96,12 @@ module.exports = (0, translatable_1.buildIncompleteTranslation)({
     entry_point_0_did_not_match_any_packages: "入口点 glob {0} 与任何包含 package.json 的目录不匹配",
     file_0_not_an_object: "文件 {0} 不是对象",
     serialized_project_referenced_0_not_part_of_project: "序列化项目引用了反射 {0}，但它不是项目的一部分",
-    // saved_relative_path_0_resolved_from_1_is_not_a_file
+    saved_relative_path_0_resolved_from_1_is_not_a_file: "序列化项目引用的 {0} 不存在或无法在 {1} 下找到",
     circular_reference_extends_0: "{0} 的“extends”字段出现循环引用",
     failed_resolve_0_to_file_in_1: "无法将 {0} 解析为 {1} 中的文件",
     option_0_can_only_be_specified_by_config_file: "“{0}”选项只能通过配置文件指定",
     option_0_expected_a_value_but_none_provided: "--{0} 需要一个值，但没有给出任何参数",
-    unknown_option_0_may_have_meant_1: "未知选项：{0}，你可能指的是：\n{1}",
+    unknown_option_0_may_have_meant_1: "未知选项：{0}，你可能指的是：\n\t{1}",
     typedoc_key_in_0_ignored: "{0} 中的“typedoc”键已被旧包 entryPointStrategy 使用，将被忽略",
     typedoc_options_must_be_object_in_0: "无法解析 {0} 中的“typedocOptions”字段，请确保它存在且包含对象",
     tsconfig_file_0_does_not_exist: "tsconfig 文件 {0} 不存在",
@@ -139,8 +142,9 @@ module.exports = (0, translatable_1.buildIncompleteTranslation)({
     help_theme: "指定用于呈现文档的主题名称",
     help_lightHighlightTheme: "指定浅色模式下的代码高亮主题",
     help_darkHighlightTheme: "指定暗黑模式下的代码高亮主题",
-    help_highlightLanguages: "指定渲染时将加载哪些语言来突出显示代码",
+    help_highlightLanguages: "指定渲染时将加载哪些语言来高亮代码",
     help_customCss: "要导入主题的自定义 CSS 文件的路径",
+    help_customJs: "要导入的自定义 JS 文件的路径",
     help_markdownItOptions: "指定传递给 markdown-it（TypeDoc 使用的 Markdown 解析器）的选项",
     help_markdownItLoader: "指定加载 markdown-it 实例时要调用的回调。将传递 TypeDoc 将使用的解析器实例",
     help_maxTypeConversionDepth: "设置要转换类型的最大深度",
@@ -152,10 +156,11 @@ module.exports = (0, translatable_1.buildIncompleteTranslation)({
     help_gitRemote: "使用指定的远程链接到 GitHub/Bitbucket 源文件。如果设置了 disableGit 或 disableSources，则无效",
     help_disableGit: "假设所有内容都可以通过 sourceLinkTemplate 进行链接，如果启用此功能，则必须设置 sourceLinkTemplate。{path} 将以 basePath 为根",
     help_basePath: "指定显示文件路径时使用的基本路径",
-    help_excludeTags: "从文档注释中删除列出的块/修饰符标签",
+    help_excludeTags: "从文档注释中删除列出的块级/修饰符标签",
     help_readme: "应显示在索引页上的自述文件路径。传递“none”以禁用索引页并在全局页上启动文档",
     help_cname: "设置 CNAME 文件文本，这对于 GitHub Pages 上的自定义域很有用",
-    help_sourceLinkExternal: "指定源链接应被视为外部链接，并在新选项卡中打开",
+    help_sourceLinkExternal: "指定哪些源代码链接应被视为外部链接，并在新选项卡中打开",
+    help_markdownLinkExternal: "指定注释与 Markdown 文件中哪些 http[s]:// 链接应被视为外部链接，并在新选项卡中打开",
     help_githubPages: "生成 .nojekyll 文件以防止 GitHub Pages 中出现 404 错误。默认为“true”",
     help_hostedBaseUrl: "指定用于在我们的输出文件夹和规范链接中生成 sitemap.xml 的基本 URL。如果未指定，则不会生成站点地图",
     help_useHostedBaseUrlForAbsoluteLinks: "如果设置，TypeDoc 将使用 hostingBaseUrl 选项生成到您网站页面的绝对链接",
@@ -164,7 +169,7 @@ module.exports = (0, translatable_1.buildIncompleteTranslation)({
     help_customFooterHtmlDisableWrapper: "如果设置，则禁用 customFooterHtml 的包装元素",
     help_hideParameterTypesInTitle: "隐藏签名标题中的参数类型，以便于扫描",
     help_cacheBust: "在静态资产链接中包含生成时间",
-    help_searchInComments: "如果设置，搜索索引还将包括评论。这将大大增加搜索索引的大小",
+    help_searchInComments: "如果设置，搜索索引还将包括注释。这将大大增加搜索索引的大小",
     help_searchInDocuments: "如果设置，搜索索引还将包含文档。这将大大增加搜索索引的大小",
     help_cleanOutputDir: "如果设置，TypeDoc 将在写入输出之前删除输出目录",
     help_titleLink: "设置页眉中的标题指向的链接。默认为文档主页",
@@ -179,7 +184,7 @@ module.exports = (0, translatable_1.buildIncompleteTranslation)({
     help_commentStyle: "确定 TypeDoc 如何搜索注释",
     help_useTsLinkResolution: "使用 TypeScript 的链接解析来确定 @link 标签指向的位置。这仅适用于 JSDoc 样式注释",
     help_preserveLinkText: "如果设置，不带链接文本的 @link 标签将使用文本内容作为链接。如果未设置，将使用目标反射名称",
-    help_blockTags: "TypeDoc 在解析注释时应该识别的块标签",
+    help_blockTags: "TypeDoc 在解析注释时应该识别的块级标签",
     help_inlineTags: "TypeDoc 在解析注释时应该识别的内联标签",
     help_modifierTags: "TypeDoc 在解析注释时应该识别的修饰符标签",
     help_categorizeByGroup: "指定是否在组级别进行分类",
@@ -241,11 +246,11 @@ module.exports = (0, translatable_1.buildIncompleteTranslation)({
     kind_index_signature: "索引签名",
     kind_constructor_signature: "构造函数签名",
     kind_parameter: "范围",
-    kind_type_literal: "类型文字",
+    kind_type_literal: "类型字面量",
     kind_type_parameter: "类型参数",
     kind_accessor: "访问器",
-    kind_get_signature: "获取签名",
-    kind_set_signature: "设置签名",
+    kind_get_signature: "Getter 签名",
+    kind_set_signature: "Setter 签名",
     kind_type_alias: "类型别名",
     kind_reference: "参考",
     kind_document: "文档",
@@ -255,21 +260,21 @@ module.exports = (0, translatable_1.buildIncompleteTranslation)({
     kind_plural_enum: "枚举",
     kind_plural_enum_member: "枚举成员",
     kind_plural_variable: "变量",
-    kind_plural_function: "功能",
+    kind_plural_function: "函数",
     kind_plural_class: "类",
     kind_plural_interface: "接口",
     kind_plural_constructor: "构造函数",
-    kind_plural_property: "特性",
+    kind_plural_property: "属性",
     kind_plural_method: "方法",
-    kind_plural_call_signature: "呼叫签名",
+    kind_plural_call_signature: "调用签名",
     kind_plural_index_signature: "索引签名",
     kind_plural_constructor_signature: "构造函数签名",
     kind_plural_parameter: "参数",
-    kind_plural_type_literal: "类型文字",
+    kind_plural_type_literal: "类型字面量",
     kind_plural_type_parameter: "类型参数",
     kind_plural_accessor: "访问器",
-    kind_plural_get_signature: "获取签名",
-    kind_plural_set_signature: "设置签名",
+    kind_plural_get_signature: "Getter 签名",
+    kind_plural_set_signature: "Setter 签名",
     kind_plural_type_alias: "类型别名",
     kind_plural_reference: "参考",
     kind_plural_document: "文档",
@@ -294,7 +299,7 @@ module.exports = (0, translatable_1.buildIncompleteTranslation)({
     theme_defined_in: "定义于",
     theme_implementation_of: "实现了",
     theme_inherited_from: "继承自",
-    theme_overrides: "覆写了",
+    theme_overrides: "重写了",
     theme_returns: "返回",
     theme_re_exports: "重新导出",
     theme_renames_and_re_exports: "重命名并重新导出",
@@ -311,12 +316,74 @@ module.exports = (0, translatable_1.buildIncompleteTranslation)({
     theme_search: "搜索",
     theme_menu: "菜单",
     theme_permalink: "永久链接",
-    tag_see: "参阅",
-    tag_group: "所属分组",
-    tag_example: "示例",
     theme_copy: "复制",
     theme_copied: "已复制！",
     theme_normally_hidden: "由于您的过滤器设置，该成员已被隐藏。",
     theme_class_hierarchy_title: "类继承图表",
     theme_loading: "加载中……",
+    tag_defaultValue: "默认值",
+    tag_deprecated: "已被弃用",
+    tag_example: "示例",
+    tag_param: "参数",
+    tag_privateRemarks: "私有备注",
+    tag_remarks: "备注",
+    tag_returns: "返回",
+    tag_see: "参阅",
+    tag_throws: "抛出",
+    tag_typeParam: "类型参数",
+    tag_author: "作者",
+    tag_callback: "回调",
+    tag_category: "类别",
+    tag_categoryDescription: "类别描述",
+    tag_default: "默认值",
+    tag_document: "文档",
+    tag_extends: "继承自",
+    tag_augments: "继承自",
+    tag_yields: "生成",
+    tag_group: "分组",
+    tag_groupDescription: "分组描述",
+    tag_import: "导入",
+    tag_inheritDoc: "继承文档",
+    tag_jsx: "JSX",
+    tag_license: "许可协议",
+    tag_module: "模块",
+    tag_prop: "属性",
+    tag_property: "属性",
+    tag_return: "返回",
+    tag_satisfies: "满足",
+    tag_since: "添加于",
+    tag_template: "类型参数",
+    tag_type: "类型",
+    tag_typedef: "类型定义",
+    tag_link: "链接",
+    tag_label: "标记",
+    tag_linkcode: "链接",
+    tag_linkplain: "链接",
+    tag_alpha: "alpha",
+    tag_beta: "beta",
+    tag_eventProperty: "事件属性",
+    tag_experimental: "实验性",
+    tag_internal: "内部成员",
+    tag_override: "重写",
+    tag_packageDocumentation: "包文档",
+    tag_public: "公共成员",
+    tag_readonly: "只读",
+    tag_sealed: "无法继承",
+    tag_virtual: "虚函数",
+    tag_abstract: "抽象类",
+    tag_class: "类",
+    tag_enum: "枚举",
+    tag_event: "事件",
+    tag_hidden: "隐藏",
+    tag_hideCategories: "在类别中隐藏",
+    tag_hideconstructor: "隐藏构造器",
+    tag_hideGroups: "在分组中隐藏",
+    tag_ignore: "隐藏",
+    tag_interface: "接口",
+    tag_namespace: "命名空间",
+    tag_overload: "重载",
+    tag_private: "私有成员",
+    tag_protected: "受保护成员",
+    tag_showCategories: "在类别中显示",
+    tag_showGroups: "在分组中显示",
 });

package/dist/lib/internationalization/translatable.d.ts

@@ -76,6 +76,7 @@ export declare const translatable: {
     readonly disable_git_set_and_git_revision_used: "disableGit is set and sourceLinkTemplate contains {gitRevision}, which will be replaced with an empty string as no revision was provided";
     readonly git_remote_0_not_valid: "The provided git remote \"{0}\" was not valid. Source links will be broken";
     readonly custom_css_file_0_does_not_exist: "Custom CSS file at {0} does not exist";
+    readonly custom_js_file_0_does_not_exist: "Custom JavaScript file at {0} does not exist";
     readonly unsupported_highlight_language_0_not_highlighted_in_comment_for_1: "Unsupported highlight language {0} will not be highlighted in comment for {1}";
     readonly unloaded_language_0_not_highlighted_in_comment_for_1: "Code block with language {0} will not be highlighted in comment for {1} as it was not included in the highlightLanguages option";
     readonly yaml_frontmatter_not_an_object: "Expected YAML frontmatter to be an object";
@@ -144,6 +145,7 @@ export declare const translatable: {
     readonly help_darkHighlightTheme: "Specify the code highlighting theme in dark mode";
     readonly help_highlightLanguages: "Specify the languages which will be loaded to highlight code when rendering";
     readonly help_customCss: "Path to a custom CSS file to for the theme to import";
+    readonly help_customJs: "Path to a custom JS file to import";
     readonly help_markdownItOptions: "Specify the options passed to markdown-it, the Markdown parser used by TypeDoc";
     readonly help_markdownItLoader: "Specify a callback to be called when loading the markdown-it instance. Will be passed the instance of the parser which TypeDoc will use";
     readonly help_maxTypeConversionDepth: "Set the maximum depth of types to be converted";
@@ -159,6 +161,7 @@ export declare const translatable: {
     readonly help_readme: "Path to the readme file that should be displayed on the index page. Pass `none` to disable the index page and start the documentation on the globals page";
     readonly help_cname: "Set the CNAME file text, it's useful for custom domains on GitHub Pages";
     readonly help_sourceLinkExternal: "Specifies that source links should be treated as external links to be opened in a new tab";
+    readonly help_markdownLinkExternal: "Specifies that http[s]:// links in comments and markdown files should be treated as external links to be opened in a new tab";
     readonly help_githubPages: "Generate a .nojekyll file to prevent 404 errors in GitHub Pages. Defaults to `true`";
     readonly help_hostedBaseUrl: "Specify a base URL to be used in generating a sitemap.xml in our output folder and canonical links. If not specified, no sitemap will be generated";
     readonly help_useHostedBaseUrlForAbsoluteLinks: "If set, TypeDoc will produce absolute links to pages on your site using the hostedBaseUrl option";

package/dist/lib/internationalization/translatable.js

@@ -88,6 +88,7 @@ exports.translatable = {
     git_remote_0_not_valid: `The provided git remote "{0}" was not valid. Source links will be broken`,
     // output plugins
     custom_css_file_0_does_not_exist: `Custom CSS file at {0} does not exist`,
+    custom_js_file_0_does_not_exist: `Custom JavaScript file at {0} does not exist`,
     unsupported_highlight_language_0_not_highlighted_in_comment_for_1: `Unsupported highlight language {0} will not be highlighted in comment for {1}`,
     unloaded_language_0_not_highlighted_in_comment_for_1: `Code block with language {0} will not be highlighted in comment for {1} as it was not included in the highlightLanguages option`,
     yaml_frontmatter_not_an_object: `Expected YAML frontmatter to be an object`,
@@ -162,6 +163,7 @@ exports.translatable = {
     help_darkHighlightTheme: "Specify the code highlighting theme in dark mode",
     help_highlightLanguages: "Specify the languages which will be loaded to highlight code when rendering",
     help_customCss: "Path to a custom CSS file to for the theme to import",
+    help_customJs: "Path to a custom JS file to import",
     help_markdownItOptions: "Specify the options passed to markdown-it, the Markdown parser used by TypeDoc",
     help_markdownItLoader: "Specify a callback to be called when loading the markdown-it instance. Will be passed the instance of the parser which TypeDoc will use",
     help_maxTypeConversionDepth: "Set the maximum depth of types to be converted",
@@ -177,6 +179,7 @@ exports.translatable = {
     help_readme: "Path to the readme file that should be displayed on the index page. Pass `none` to disable the index page and start the documentation on the globals page",
     help_cname: "Set the CNAME file text, it's useful for custom domains on GitHub Pages",
     help_sourceLinkExternal: "Specifies that source links should be treated as external links to be opened in a new tab",
+    help_markdownLinkExternal: "Specifies that http[s]:// links in comments and markdown files should be treated as external links to be opened in a new tab",
     help_githubPages: "Generate a .nojekyll file to prevent 404 errors in GitHub Pages. Defaults to `true`",
     help_hostedBaseUrl: "Specify a base URL to be used in generating a sitemap.xml in our output folder and canonical links. If not specified, no sitemap will be generated",
     help_useHostedBaseUrlForAbsoluteLinks: "If set, TypeDoc will produce absolute links to pages on your site using the hostedBaseUrl option",

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

@@ -1,5 +1,6 @@
 import ts from "typescript";
 import type { JSONOutput, Serializer } from "../../serialization/index";
+import type { DeclarationReference } from "../../converter/comments/declarationReference";
 /**
  * See {@link ReflectionSymbolId}
  */
@@ -30,6 +31,7 @@ export declare class ReflectionSymbolId {
     constructor(symbol: ts.Symbol, declaration?: ts.Declaration);
     constructor(json: JSONOutput.ReflectionSymbolId);
     getStableKey(): ReflectionSymbolIdString;
+    toDeclarationReference(): DeclarationReference;
     toObject(serializer: Serializer): {
         sourceFileName: string;
         qualifiedName: string;

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

@@ -12,6 +12,7 @@ const fs_2 = require("../../utils/fs");
 const paths_1 = require("../../utils/paths");
 const tsutils_1 = require("../../utils/tsutils");
 const validation_1 = require("../../utils/validation");
+const utils_1 = require("./utils");
 let transientCount = 0;
 const transientIds = new WeakMap();
 /**
@@ -30,7 +31,7 @@ class ReflectionSymbolId {
             else {
                 this.qualifiedName = (0, tsutils_1.getQualifiedName)(symbol, symbol.name);
             }
-            this.pos = declaration?.pos ?? Infinity;
+            this.pos = declaration?.getStart() ?? Infinity;
             if (symbol.flags & typescript_1.default.SymbolFlags.Transient) {
                 this.transientId = transientIds.get(symbol) ?? ++transientCount;
                 transientIds.set(symbol, this.transientId);
@@ -54,6 +55,18 @@ class ReflectionSymbolId {
             return `${this.fileName}\0${this.qualifiedName}`;
         }
     }
+    toDeclarationReference() {
+        return {
+            resolutionStart: "global",
+            moduleSource: (0, fs_2.findPackageForPath)(this.fileName),
+            symbolReference: {
+                path: (0, utils_1.splitUnquotedString)(this.qualifiedName, ".").map((path) => ({
+                    navigation: ".",
+                    path,
+                })),
+            },
+        };
+    }
     toObject(serializer) {
         const sourceFileName = (0, path_1.isAbsolute)(this.fileName)
             ? (0, paths_1.normalizePath)((0, path_1.relative)(serializer.projectRoot, resolveDeclarationMaps(this.fileName)))

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

@@ -150,8 +150,10 @@ class DeclarationReflection extends container_1.ContainerReflection {
         this.type = de.revive(obj.type, (t) => de.constructType(t));
         this.signatures = de.reviveMany(obj.signatures, (r) => de.constructReflection(r));
         // TypeDoc 0.25, remove check with 0.28.
+        // eslint-disable-next-line @typescript-eslint/no-deprecated
         if (obj.indexSignature) {
             this.indexSignatures = [
+                // eslint-disable-next-line @typescript-eslint/no-deprecated
                 de.revive(obj.indexSignature, (r) => de.constructReflection(r)),
             ];
         }

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

@@ -61,7 +61,9 @@ class SignatureReflection extends abstract_1.Reflection {
     fromObject(de, obj) {
         super.fromObject(de, obj);
         this.sources = de.reviveMany(obj.sources, (t) => new file_1.SourceReference(t.fileName, t.line, t.character));
+        // eslint-disable-next-line @typescript-eslint/no-deprecated
         if (obj.typeParameter) {
+            // eslint-disable-next-line @typescript-eslint/no-deprecated
             this.typeParameters = de.reviveMany(obj.typeParameter, (t) => de.constructReflection(t));
         }
         else {

package/dist/lib/models/types.js

@@ -754,20 +754,6 @@ class ReferenceType extends Type {
             .fileName.replace(/\\/g, "/");
         if (!symbolPath)
             return ref;
-        // Attempt to decide package name from path if it contains "node_modules"
-        let startIndex = symbolPath.lastIndexOf("node_modules/");
-        if (startIndex !== -1) {
-            startIndex += "node_modules/".length;
-            let stopIndex = symbolPath.indexOf("/", startIndex);
-            // Scoped package, e.g. `@types/node`
-            if (symbolPath[startIndex] === "@") {
-                stopIndex = symbolPath.indexOf("/", stopIndex + 1);
-            }
-            const packageName = symbolPath.substring(startIndex, stopIndex);
-            ref.package = packageName;
-            return ref;
-        }
-        // Otherwise, look for a "package.json" file in a parent path
         ref.package = (0, fs_1.findPackageForPath)(symbolPath);
         return ref;
     }

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

@@ -57,7 +57,7 @@ export interface PageHeading {
  * @see {@link Renderer.EVENT_BEGIN_PAGE}
  * @see {@link Renderer.EVENT_END_PAGE}
  */
-export declare class PageEvent<out Model = unknown> extends Event {
+export declare class PageEvent<out Model = unknown> {
     /**
      * The project the renderer is currently processing.
      */
@@ -107,6 +107,8 @@ export declare class PageEvent<out Model = unknown> extends Event {
      * @event
      */
     static readonly END = "endPage";
+    constructor(model: Model);
+    /** @deprecated use the single constructor arg instead, will be removed in 0.27 */
     constructor(name: string, model: Model);
 }
 /**

package/dist/lib/output/events.js

@@ -45,7 +45,7 @@ class RendererEvent {
      * @returns A newly created {@link PageEvent} instance.
      */
     createPageEvent(mapping) {
-        const event = new PageEvent(PageEvent.BEGIN, mapping.model);
+        const event = new PageEvent(mapping.model);
         event.project = this.project;
         event.url = mapping.url;
         event.filename = Path.join(this.outputDirectory, mapping.url);
@@ -70,7 +70,7 @@ RendererEvent.END = "endRender";
  * @see {@link Renderer.EVENT_BEGIN_PAGE}
  * @see {@link Renderer.EVENT_END_PAGE}
  */
-class PageEvent extends Event {
+class PageEvent {
     /**
      * Start a new section of the page. Sections are collapsible within
      * the "On This Page" sidebar.
@@ -82,8 +82,7 @@ class PageEvent extends Event {
             headings: this.pageHeadings,
         });
     }
-    constructor(name, model) {
-        super(name);
+    constructor(nameOrModel, model) {
         /**
          * Links to content within this page that should be rendered in the page navigation.
          * This is built when rendering the document content.
@@ -98,7 +97,12 @@ class PageEvent extends Event {
                 headings: this.pageHeadings,
             },
         ];
-        this.model = model;
+        if (typeof nameOrModel === "string") {
+            this.model = model;
+        }
+        else {
+            this.model = nameOrModel;
+        }
     }
 }
 exports.PageEvent = PageEvent;

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

@@ -4,8 +4,8 @@ import { RendererComponent } from "../components";
  * source folder to the output directory.
  */
 export declare class AssetsPlugin extends RendererComponent {
-    /** @internal */
-    accessor customCss: string;
+    private accessor customCss;
+    private accessor customJs;
     getTranslatedStrings(): {
         copy: import("../../internationalization").TranslatedString;
         copied: import("../../internationalization").TranslatedString;

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

@@ -63,7 +63,7 @@ const path_1 = require("path");
  * source folder to the output directory.
  */
 let AssetsPlugin = (() => {
-    var _AssetsPlugin_customCss_accessor_storage;
+    var _AssetsPlugin_customCss_accessor_storage, _AssetsPlugin_customJs_accessor_storage;
     let _classDecorators = [(0, components_1.Component)({ name: "assets" })];
     let _classDescriptor;
     let _classExtraInitializers = [];
@@ -72,10 +72,14 @@ let AssetsPlugin = (() => {
     let _customCss_decorators;
     let _customCss_initializers = [];
     let _customCss_extraInitializers = [];
+    let _customJs_decorators;
+    let _customJs_initializers = [];
+    let _customJs_extraInitializers = [];
     var AssetsPlugin = _classThis = class extends _classSuper {
-        /** @internal */
         get customCss() { return __classPrivateFieldGet(this, _AssetsPlugin_customCss_accessor_storage, "f"); }
         set customCss(value) { __classPrivateFieldSet(this, _AssetsPlugin_customCss_accessor_storage, value, "f"); }
+        get customJs() { return __classPrivateFieldGet(this, _AssetsPlugin_customJs_accessor_storage, "f"); }
+        set customJs(value) { __classPrivateFieldSet(this, _AssetsPlugin_customJs_accessor_storage, value, "f"); }
         getTranslatedStrings() {
             return {
                 copy: this.application.i18n.theme_copy(),
@@ -100,6 +104,14 @@ let AssetsPlugin = (() => {
                     this.application.logger.error(this.application.i18n.custom_css_file_0_does_not_exist(this.customCss));
                 }
             }
+            if (this.customJs) {
+                if ((0, fs_2.existsSync)(this.customJs)) {
+                    (0, fs_1.copySync)(this.customJs, (0, path_1.join)(dest, "custom.js"));
+                }
+                else {
+                    this.application.logger.error(this.application.i18n.custom_js_file_0_does_not_exist(this.customJs));
+                }
+            }
         }
         /**
          * Triggered before the renderer starts rendering a project.
@@ -128,15 +140,19 @@ let AssetsPlugin = (() => {
         constructor() {
             super(...arguments);
             _AssetsPlugin_customCss_accessor_storage.set(this, __runInitializers(this, _customCss_initializers, void 0));
-            __runInitializers(this, _customCss_extraInitializers);
+            _AssetsPlugin_customJs_accessor_storage.set(this, (__runInitializers(this, _customCss_extraInitializers), __runInitializers(this, _customJs_initializers, void 0)));
+            __runInitializers(this, _customJs_extraInitializers);
         }
     };
     _AssetsPlugin_customCss_accessor_storage = new WeakMap();
+    _AssetsPlugin_customJs_accessor_storage = new WeakMap();
     __setFunctionName(_classThis, "AssetsPlugin");
     (() => {
         const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(_classSuper[Symbol.metadata] ?? null) : void 0;
         _customCss_decorators = [(0, utils_1.Option)("customCss")];
+        _customJs_decorators = [(0, utils_1.Option)("customJs")];
         __esDecorate(_classThis, null, _customCss_decorators, { kind: "accessor", name: "customCss", static: false, private: false, access: { has: obj => "customCss" in obj, get: obj => obj.customCss, set: (obj, value) => { obj.customCss = value; } }, metadata: _metadata }, _customCss_initializers, _customCss_extraInitializers);
+        __esDecorate(_classThis, null, _customJs_decorators, { kind: "accessor", name: "customJs", static: false, private: false, access: { has: obj => "customJs" in obj, get: obj => obj.customJs, set: (obj, value) => { obj.customJs = value; } }, metadata: _metadata }, _customJs_initializers, _customJs_extraInitializers);
         __esDecorate(null, _classDescriptor = { value: _classThis }, _classDecorators, { kind: "class", name: _classThis.name, metadata: _metadata }, null, _classExtraInitializers);
         AssetsPlugin = _classThis = _classDescriptor.value;
         if (_metadata) Object.defineProperty(_classThis, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });

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

@@ -100,13 +100,11 @@ export interface RendererEvents {
  *
  *    * {@link Renderer.EVENT_BEGIN_PAGE}<br>
  *      Triggered before a document will be rendered. The listener receives an instance of
- *      {@link PageEvent}. By calling {@link PageEvent.preventDefault} the generation of the
- *      document can be canceled.
+ *      {@link PageEvent}.
  *
  *    * {@link Renderer.EVENT_END_PAGE}<br>
  *      Triggered after a document has been rendered, just before it is written to disc. The
- *      listener receives an instance of {@link PageEvent}. When calling
- *      {@link PageEvent.preventDefault} the the document will not be saved to disc.
+ *      listener receives an instance of {@link PageEvent}.
  *
  *  * {@link Renderer.EVENT_END}<br>
  *    Triggered after the renderer has written all documents. The listener receives

package/dist/lib/output/renderer.js

@@ -108,13 +108,11 @@ const jsx_1 = require("../utils/jsx");
  *
  *    * {@link Renderer.EVENT_BEGIN_PAGE}<br>
  *      Triggered before a document will be rendered. The listener receives an instance of
- *      {@link PageEvent}. By calling {@link PageEvent.preventDefault} the generation of the
- *      document can be canceled.
+ *      {@link PageEvent}.
  *
  *    * {@link Renderer.EVENT_END_PAGE}<br>
  *      Triggered after a document has been rendered, just before it is written to disc. The
- *      listener receives an instance of {@link PageEvent}. When calling
- *      {@link PageEvent.preventDefault} the the document will not be saved to disc.
+ *      listener receives an instance of {@link PageEvent}.
  *
  *  * {@link Renderer.EVENT_END}<br>
  *    Triggered after the renderer has written all documents. The listener receives

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

@@ -11,6 +11,7 @@ export declare class MarkedPlugin extends ContextAwareRendererComponent {
     accessor lightTheme: BundledTheme;
     accessor darkTheme: BundledTheme;
     accessor markdownItOptions: Record<string, unknown>;
+    accessor markdownLinkExternal: boolean;
     private parser?;
     /**
      * This needing to be here really feels hacky... probably some nicer way to do this.

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

@@ -75,7 +75,7 @@ function getDefaultSlugger(logger) {
  * @internal
  */
 let MarkedPlugin = (() => {
-    var _MarkedPlugin_lightTheme_accessor_storage, _MarkedPlugin_darkTheme_accessor_storage, _MarkedPlugin_markdownItOptions_accessor_storage;
+    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 = [];
@@ -90,13 +90,17 @@ let MarkedPlugin = (() => {
     let _markdownItOptions_decorators;
     let _markdownItOptions_initializers = [];
     let _markdownItOptions_extraInitializers = [];
+    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)));
-            this.parser = __runInitializers(this, _markdownItOptions_extraInitializers);
+            _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.
@@ -110,6 +114,8 @@ let MarkedPlugin = (() => {
         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"); }
         /**
          * Create a new MarkedPlugin instance.
          */
@@ -290,6 +296,16 @@ let MarkedPlugin = (() => {
                 const token = tokens[idx];
                 const href = token.attrGet("href")?.replace(/^#(?:md:)?(.+)/, "#md:$1");
                 if (href) {
+                    // Note: This doesn't catch @link tags to reflections as those
+                    // will be relative links. This will likely have to change with
+                    // the introduction of support for customized routers whenever
+                    // that becomes a real thing.
+                    if (this.markdownLinkExternal && /https?:\/\//i.test(href)) {
+                        token.attrSet("target", "_blank");
+                        const classes = token.attrGet("class")?.split(" ") || [];
+                        classes.push("external");
+                        token.attrSet("class", classes.join(" "));
+                    }
                     token.attrSet("href", href);
                 }
                 return self.renderToken(tokens, idx, options);
@@ -307,15 +323,18 @@ let MarkedPlugin = (() => {
     _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 });

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

@@ -258,6 +258,9 @@ class DefaultTheme extends theme_1.Theme {
                     children,
                 };
             }
+            if (opts.excludeReferences && element instanceof models_1.ReferenceReflection) {
+                return;
+            }
             return {
                 text: (0, lib_1.getDisplayName)(element),
                 path: element.url,

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

@@ -17,6 +17,7 @@ const defaultLayout = (context, template, props) => (utils_1.JSX.createElement("
         utils_1.JSX.createElement("link", { rel: "stylesheet", href: context.relativeURL("assets/highlight.css", true) }),
         context.options.getValue("customCss") && (utils_1.JSX.createElement("link", { rel: "stylesheet", href: context.relativeURL("assets/custom.css", true) })),
         utils_1.JSX.createElement("script", { defer: true, src: context.relativeURL("assets/main.js", true) }),
+        context.options.getValue("customJs") && (utils_1.JSX.createElement("script", { defer: true, src: context.relativeURL("assets/custom.js", true) })),
         utils_1.JSX.createElement("script", { async: true, src: context.relativeURL("assets/icons.js", true), id: "tsd-icons-script" }),
         utils_1.JSX.createElement("script", { async: true, src: context.relativeURL("assets/search.js", true), id: "tsd-search-script" }),
         utils_1.JSX.createElement("script", { async: true, src: context.relativeURL("assets/navigation.js", true), id: "tsd-nav-script" }),

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

@@ -30,11 +30,12 @@ function commentTags(context, props) {
                 : context.internationalization.translateTagName(item.tag);
             const anchor = props.getUniqueAliasInPage(name);
             return (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
-                utils_1.JSX.createElement("h4", { class: "tsd-anchor-link" },
-                    utils_1.JSX.createElement("a", { id: anchor, class: "tsd-anchor" }),
-                    name,
-                    (0, anchor_icon_1.anchorIcon)(context, anchor)),
-                utils_1.JSX.createElement(utils_1.Raw, { html: context.markdown(item.content) })));
+                utils_1.JSX.createElement("div", { class: `tsd-tag-${name}` },
+                    utils_1.JSX.createElement("h4", { class: "tsd-anchor-link" },
+                        utils_1.JSX.createElement("a", { id: anchor, class: "tsd-anchor" }),
+                        name,
+                        (0, anchor_icon_1.anchorIcon)(context, anchor)),
+                    utils_1.JSX.createElement(utils_1.Raw, { html: context.markdown(item.content) }))));
         })),
         afterTags));
 }

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

@@ -24,11 +24,22 @@ function memberDeclaration(context, props) {
         }
     }
     const visitor = { reflection: renderTypeDeclaration };
+    /** Fix for #2717. If type is the same as value the type is omitted */
+    function shouldRenderType() {
+        if (props.type && props.type.type === "literal") {
+            const reflectionTypeString = props.type.toString();
+            const defaultValue = props.defaultValue;
+            if (defaultValue === undefined || reflectionTypeString === defaultValue.toString()) {
+                return false;
+            }
+        }
+        return true;
+    }
     return (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
         utils_1.JSX.createElement("div", { class: "tsd-signature" },
             utils_1.JSX.createElement("span", { class: (0, lib_1.getKindClass)(props) }, (0, lib_1.wbr)(props.name)),
             (0, lib_1.renderTypeParametersSignature)(context, props.typeParameters),
-            props.type && (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
+            shouldRenderType() && (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
                 utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" },
                     !!props.flags.isOptional && "?",
                     ":"),

package/dist/lib/output/themes/default/templates/reflection.js

@@ -35,7 +35,7 @@ function reflectionTemplate(context, props) {
                 utils_1.JSX.createElement("h4", { class: "tsd-before-signature" }, context.i18n.theme_indexable()),
                 utils_1.JSX.createElement("ul", { class: "tsd-signatures" }, props.model.indexSignatures.map((index) => renderIndexSignature(context, index))))),
             !props.model.signatures && context.memberSources(props.model))),
-        !!props.model.children?.length && context.index(props.model),
+        !!props.model.childrenIncludingDocuments?.length && context.index(props.model),
         context.members(props.model)));
 }
 function renderIndexSignature(context, index) {

package/dist/lib/utils/fs.js

@@ -330,6 +330,17 @@ function discoverPackageJson(dir) {
 // dir -> package name according to package.json in this or some parent dir
 const packageCache = new Map();
 function findPackageForPath(sourcePath) {
+    // Attempt to decide package name from path if it contains "node_modules"
+    let startIndex = sourcePath.lastIndexOf("node_modules/");
+    if (startIndex !== -1) {
+        startIndex += "node_modules/".length;
+        let stopIndex = sourcePath.indexOf("/", startIndex);
+        // Scoped package, e.g. `@types/node`
+        if (sourcePath[startIndex] === "@") {
+            stopIndex = sourcePath.indexOf("/", stopIndex + 1);
+        }
+        return sourcePath.substring(startIndex, stopIndex);
+    }
     const dir = (0, path_1.dirname)(sourcePath);
     const cache = packageCache.get(dir);
     if (cache) {

package/dist/lib/utils/options/declaration.d.ts

@@ -85,6 +85,7 @@ export interface TypeDocOptionMap {
     disableSources: boolean;
     sourceLinkTemplate: string;
     sourceLinkExternal: boolean;
+    markdownLinkExternal: boolean;
     disableGit: boolean;
     gitRevision: string;
     gitRemote: string;
@@ -98,6 +99,7 @@ export interface TypeDocOptionMap {
     darkHighlightTheme: ShikiTheme;
     highlightLanguages: string[];
     customCss: string;
+    customJs: string;
     markdownItOptions: ManuallyValidatedOption<Record<string, unknown>>;
     /**
      * Will be called when TypeDoc is setting up the markdown parser to use to render markdown.
@@ -142,6 +144,7 @@ export interface TypeDocOptionMap {
         includeGroups: boolean;
         includeFolders: boolean;
         compactFolders: boolean;
+        excludeReferences: boolean;
     };
     visibilityFilters: ManuallyValidatedOption<{
         protected?: boolean;

package/dist/lib/utils/options/sources/typedoc.js

@@ -298,6 +298,11 @@ function addTypeDocOptions(options) {
         help: (i18n) => i18n.help_customCss(),
         type: declaration_1.ParameterType.Path,
     });
+    options.addDeclaration({
+        name: "customJs",
+        help: (i18n) => i18n.help_customJs(),
+        type: declaration_1.ParameterType.Path,
+    });
     options.addDeclaration({
         name: "markdownItOptions",
         help: (i18n) => i18n.help_markdownItOptions(),
@@ -393,6 +398,12 @@ function addTypeDocOptions(options) {
         help: (i18n) => i18n.help_sourceLinkExternal(),
         type: declaration_1.ParameterType.Boolean,
     });
+    options.addDeclaration({
+        name: "markdownLinkExternal",
+        help: (i18n) => i18n.help_markdownLinkExternal(),
+        type: declaration_1.ParameterType.Boolean,
+        defaultValue: true,
+    });
     options.addDeclaration({
         name: "githubPages",
         help: (i18n) => i18n.help_githubPages(),
@@ -403,7 +414,7 @@ function addTypeDocOptions(options) {
         name: "hostedBaseUrl",
         help: (i18n) => i18n.help_hostedBaseUrl(),
         validate(value, i18n) {
-            if (!/https?:\/\//.test(value)) {
+            if (!/https?:\/\//i.test(value)) {
                 throw new Error(i18n.hostedBaseUrl_must_start_with_http());
             }
         },
@@ -502,6 +513,7 @@ function addTypeDocOptions(options) {
             includeGroups: false,
             includeFolders: true,
             compactFolders: true,
+            excludeReferences: false,
         },
     });
     options.addDeclaration({

package/dist/lib/utils/options/tsdoc-defaults.d.ts

@@ -3,4 +3,4 @@ export declare const blockTags: readonly ["@defaultValue", "@deprecated", "@exam
 export declare const tsdocInlineTags: readonly ["@link", "@inheritDoc", "@label"];
 export declare const inlineTags: readonly ["@link", "@inheritDoc", "@label", "@linkcode", "@linkplain"];
 export declare const tsdocModifierTags: readonly ["@alpha", "@beta", "@eventProperty", "@experimental", "@internal", "@override", "@packageDocumentation", "@public", "@readonly", "@sealed", "@virtual"];
-export declare const modifierTags: readonly ["@alpha", "@beta", "@eventProperty", "@experimental", "@internal", "@override", "@packageDocumentation", "@public", "@readonly", "@sealed", "@virtual", "@class", "@enum", "@event", "@hidden", "@hideCategories", "@hideconstructor", "@hideGroups", "@ignore", "@interface", "@namespace", "@overload", "@private", "@protected", "@showCategories", "@showGroups"];
+export declare const modifierTags: readonly ["@alpha", "@beta", "@eventProperty", "@experimental", "@internal", "@override", "@packageDocumentation", "@public", "@readonly", "@sealed", "@virtual", "@abstract", "@class", "@enum", "@event", "@hidden", "@hideCategories", "@hideconstructor", "@hideGroups", "@ignore", "@interface", "@namespace", "@overload", "@private", "@protected", "@showCategories", "@showGroups"];

package/dist/lib/utils/options/tsdoc-defaults.js

@@ -62,6 +62,7 @@ exports.tsdocModifierTags = [
 ];
 exports.modifierTags = [
     ...exports.tsdocModifierTags,
+    "@abstract",
     "@class",
     "@enum",
     "@event",

package/dist/lib/utils/sort.js

@@ -46,14 +46,14 @@ const sorts = {
         return false;
     },
     alphabetical(a, b) {
-        return a.name < b.name;
+        return a.name.localeCompare(b.name) < 0;
     },
     "alphabetical-ignoring-documents"(a, b) {
         if (a.kindOf(kind_1.ReflectionKind.Document) ||
             b.kindOf(kind_1.ReflectionKind.Document)) {
             return false;
         }
-        return a.name < b.name;
+        return a.name.localeCompare(b.name) < 0;
     },
     "enum-value-ascending"(a, b) {
         if (a.kind == kind_1.ReflectionKind.EnumMember &&

package/dist/lib/validation/links.js

@@ -8,7 +8,7 @@ function getBrokenPartLinks(parts) {
     for (const part of parts) {
         if (part.kind === "inline-tag" &&
             linkTags.includes(part.tag) &&
-            !part.target) {
+            (!part.target || part.target instanceof models_1.ReflectionSymbolId)) {
             links.push(part.text.trim());
         }
     }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "typedoc",
   "description": "Create api documentation for TypeScript projects.",
-  "version": "0.26.6",
+  "version": "0.26.8",
   "homepage": "https://typedoc.org",
   "exports": {
     ".": "./dist/index.js",
@@ -27,27 +27,27 @@
     "lunr": "^2.3.9",
     "markdown-it": "^14.1.0",
     "minimatch": "^9.0.5",
-    "shiki": "^1.9.1",
-    "yaml": "^2.4.5"
+    "shiki": "^1.16.2",
+    "yaml": "^2.5.1"
   },
   "peerDependencies": {
-    "typescript": "4.6.x || 4.7.x || 4.8.x || 4.9.x || 5.0.x || 5.1.x || 5.2.x || 5.3.x || 5.4.x || 5.5.x"
+    "typescript": "4.6.x || 4.7.x || 4.8.x || 4.9.x || 5.0.x || 5.1.x || 5.2.x || 5.3.x || 5.4.x || 5.5.x || 5.6.x"
   },
   "devDependencies": {
     "@types/lunr": "^2.3.7",
-    "@types/markdown-it": "^14.1.1",
+    "@types/markdown-it": "^14.1.2",
     "@types/mocha": "^10.0.7",
     "@types/node": "18",
     "@typestrong/fs-fixture-builder": "github:TypeStrong/fs-fixture-builder#34113409e3a171e68ce5e2b55461ef5c35591cfe",
     "c8": "^10.1.2",
-    "esbuild": "^0.21.5",
-    "eslint": "^9.5.0",
-    "mocha": "^10.5.2",
-    "prettier": "3.3.2",
-    "puppeteer": "^22.12.1",
+    "esbuild": "^0.23.1",
+    "eslint": "^9.9.1",
+    "mocha": "^10.7.3",
+    "prettier": "3.3.3",
+    "puppeteer": "^23.3.0",
     "ts-node": "^10.9.2",
-    "typescript": "5.5.2",
-    "typescript-eslint": "^8.0.1"
+    "typescript": "5.6.1-rc",
+    "typescript-eslint": "^8.4.0"
   },
   "files": [
     "/bin",

package/tsdoc.json

@@ -67,6 +67,10 @@
             "tagName": "@class",
             "syntaxKind": "modifier"
         },
+        {
+            "tagName": "@abstract",
+            "syntaxKind": "modifier"
+        },
         {
             "tagName": "@document",
             "syntaxKind": "block"