Fix anchor link for $

Resolves #3065

Author: Gerrit0

CHANGELOG.md

@@ -4,6 +4,10 @@ title: Changelog
 
 ## Unreleased
 
+### Bug Fixes
+
+- Fixed anchor link generation to members named `$`, #3065.
+
 ## v0.28.16 (2026-01-12)
 
 ### Bug Fixes

src/lib/output/themes/default/Slugger.ts

@@ -18,19 +18,24 @@ export class Slugger {
         // # test <t>
         // both of the above should slug to test-t
 
-        return (
-            value
-                .trim()
-                // remove unwanted chars
-                .replace(
-                    /[\u2000-\u206F\u2E00-\u2E7F\\'!"#$%&()*+,./:;<=>?@[\]^`{|}~]/g,
-                    "",
-                )
-                // change whitespace to dash
-                .replace(/\s/g, "-")
-                // combine adjacent dashes
-                .replace(/--+/, "-")
-        );
+        const slug = value
+            .trim()
+            // remove unwanted chars
+            .replace(
+                /[\u2000-\u206F\u2E00-\u2E7F\\'!"#$%&()*+,./:;<=>?@[\]^`{|}~]/g,
+                "",
+            )
+            // change whitespace to dash
+            .replace(/\s/g, "-")
+            // combine adjacent dashes
+            .replace(/--+/, "-");
+
+        // #3065 unfortunately some headers might result in a desired slug which is
+        // completely empty. In that case, we still need to return *something* so that
+        // we don't end up generating an empty anchor, which is invalid according to the
+        // spec. GitHub's slugger rules don't handle this, so I've somewhat arbitrarily
+        // chosen "_" here. If GitHub ever fixes that issue, this might need to be adjusted.
+        return slug || "_";
     }
 
     constructor(private options: TypeDocOptionMap["sluggerConfiguration"]) {}

src/lib/utils/options/declaration.ts

@@ -125,8 +125,9 @@ export type TypeDocOptions = {
         TypeDocOptionMap[K] extends ManuallyValidatedOption<
             infer ManuallyValidated
         > ? ManuallyValidated :
-        TypeDocOptionMap[K] extends
-            NormalizedPath[] | NormalizedPathOrModule[] | NormalizedPathOrModuleOrFunction[] | GlobString[] ? string[] :
+        TypeDocOptionMap[K] extends NormalizedPathOrModuleOrFunction[] ?
+            Array<string | ((app: Application) => Promise<void> | void)> :
+        TypeDocOptionMap[K] extends NormalizedPath[] | NormalizedPathOrModule[] | GlobString[] ? string[] :
         TypeDocOptionMap[K] extends NormalizedPath ? string :
         TypeDocOptionMap[K] extends
             | string

src/test/output/Slugger.test.ts

@@ -24,4 +24,10 @@ describe("Slugger", () => {
         const slugger = new Slugger({ lowercase: true });
         equal(slugger.slug("test    test2"), "test-test2");
     });
+
+    it("Handles empty slugs", () => {
+        const slugger = new Slugger({ lowercase: true });
+        equal(slugger.slug("$"), "_");
+        equal(slugger.slug("$"), "_-1");
+    });
 });