Skip to content

Function: preventMediaFiles()

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

function preventMediaFiles(__namedParameters): TypedocPlugin;

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

No file copied into api/_media/: TypeDoc copies each file a page links to, which is not a reflection of its own, and the guides, the READMEs and the sources of the repo ship where they are. A file outside the docs package, or in a folder of exclude, is never registered as media, and its link is left as it is written.

Parameters

ParameterType
__namedParametersPreventMediaFilesOptions

Returns

TypedocPlugin