typedoc-plugin-hash-link-references

Write TypeDoc inline links that stay readable in editors, then publish them as working links to TypeDoc reflections.

typedoc-plugin-hash-link-references resolves inline TypeDoc link tags such as {@link src/widgets/Button.ts#Button} against the converted project's source files and reflections. That lets source comments keep the familiar path#Symbol shape while generated documentation links to the actual Button reflection.

TypeDoc treats text before ! as a literal module name, not a source-file path. For that reason, the plugin attaches a concrete reflection target for file paths instead of producing an invalid src/widgets/Button.ts!Button module reference. Module-like sources such as @scope/package#Export retain the @scope/package!Export declaration-reference fallback.

Install

npm install --save-dev typedoc typedoc-plugin-hash-link-references

Configure

Add the plugin to your TypeDoc config:

{
 "plugin": ["typedoc-plugin-hash-link-references"]
}

If you use a JavaScript or TypeScript TypeDoc config, the same value belongs in the plugin array.

Link Behavior

The plugin processes only inline TypeDoc tags:

• {@link path/to/file.ts#ExportedName}
• {@linkcode path/to/file.ts#ExportedName}
• {@linkplain path/to/file.ts#ExportedName}

For a file path, the symbol name must identify one unambiguous source-backed reflection in that file. Repository-relative paths and paths relative to the comment owner's source file are supported. The plugin leaves URL targets, anchor-only links, existing TypeDoc declaration references, and plain text untouched.

Example

/**
 * Creates the default widget.
 *
 * @see {@link src/widgets/create-widget.ts#CreateWidgetOptions}
 */
export function createWidget() {}

The plugin finds the CreateWidgetOptions reflection whose source is src/widgets/create-widget.ts and attaches it as the TypeDoc link target. The generated docs therefore contain a real link without making source comments harder to read.

API

Most projects only need the TypeDoc plugin entrypoint. The package also exports typedoc-plugin-hash-link-references/core for tests or custom integrations that want to call the low-level path#Symbol to path!Symbol text-rewrite helper directly. Source-file reflection resolution is provided by the TypeDoc plugin entrypoint because it requires a converted TypeDoc project.

Full docs and generated API reference are published with the repository site: https://nick2bad4u.github.io/typedoc-plugin-hash-link-references/.