Nihilist Postmodern Mistake

    typedoc-plugin-external-link
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.3 • Public • Published

    typedoc-plugin-external-link

    A typedoc plugin to add custom external links.

    GitHub codecov npm

    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

    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.

    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!

    Buy Me A Coffee Buy Me A Coffee Buy Me a Coffee at ko-fi.com

    Contributors

    Thanks goes to these wonderful people (emoji key):


    Parbez

    💻 🚧 🤔

    WhiteSource Renovate

    🚧

    This project follows the all-contributors specification. Contributions of any kind welcome!

    Install

    npm i typedoc-plugin-external-link

    DownloadsWeekly Downloads

    318

    Version

    1.0.3

    License

    MIT

    Unpacked Size

    14.3 kB

    Total Files

    7

    Last publish

    Collaborators

    • imranbarbhuiya