typedoc-plugin-external-link

A typedoc plugin to add custom external links.

Description

A typedoc plugin to add custom external links.

Install

You can use the following command to install this package, or replace npm install with your package manager of choice.

npm install -D typedoc-plugin-external-link

Note: This plugin requires typedoc >=0.24.0.

Usage

Create a file with name externalConfig.js at the root of the project. The file should export packageNames and a getURL function.

Example

const packageNames = ['typedoc', 'typedoc-plugin-external-link'];

/**
 *
 * @type {import('typedoc-plugin-external-link').getURL}
 */
function getURL(packageName, type) {
	return 'https://github.com/imranbarbhuiya/typedoc-plugin-external-link';
}

module.exports = { packageNames, getURL };

You can specify custom config file path by adding externalLinkPath in typedoc.json file.

Warning: for entryPointStrategy=Package, you need to add externalLinkPath to all packages in typedoc.json file.

Buy me some doughnuts

If you want to support me by donating, you can do so by using any of the following methods. Thank you very much in advance!

Contributors ✨

Thanks goes to these wonderful people: