Skip to content

jeppevinkel/typedoc-cross-link-types

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

typedoc-cross-link-types

npm

TypeDoc plugin that enables cross-linking to types from other packages.

Installation

Use npm to install the package.

npm install typedoc-cross-link-types

Usage

Add the following to your typedoc.json:

{
  "cross-package-definitions": [
    "package//type => url"
  ]
}

Here's an example:

{
  "cross-package-definitions": [
    "moment//moment.Moment => https://momentjs.com/docs/"
  ]
}

License

MIT

About

Create custom cross package links for types

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published