Skip to main content

TypeDoc plugin

typedoc-plugin-hash-link-references

Use editor-friendly hash links and let TypeDoc publish declaration-reference links.

Editor-first authoring

Keeps authoring links such as src/file.ts#MySymbol readable in editors and code review.

TypeDoc resolver friendly

Rewrites eligible inline tags before TypeDoc's link resolver consumes them.

Testable core

Ships a small core helper API so behavior can be tested without running TypeDoc.

  • npm license
  • npm total downloads
  • latest GitHub release
  • GitHub open issues
  • Codecov

Read the API

Inspect the generated TypeDoc API for the load hook and exported core helpers.

Open section

Start quickly

Install the plugin, add it to TypeDoc, and keep writing path#Symbol links in comments.

Open section

Understand link behavior

See which inline tags are rewritten and which URL-like or plain text targets are left alone.

Open section