Skip to content

Function: linkTrackedSources()

Documentation / @wtf/project-typedoc / plugins / linkTrackedSources

function linkTrackedSources(__namedParameters): TypedocPlugin;

Defined in: packages/project-typedoc/src/plugins.ts:111

A “Defined in:” linked to its source only where git tracks its file, as TypeDoc links one with git on. TypeDoc finds a repository only by a .git folder, and in a git worktree .git is a file: it takes the checkout around the worktree, which tracks none of its files, and links no source. So the config turns git off and names the revision, and TypeDoc then links every file, a declaration in node_modules too, to a page that is not there: this unlinks each one git does not track.

Parameters

ParameterType
__namedParametersLinkTrackedSourcesOptions

Returns

TypedocPlugin