typedoc-plugin-merge-modules

    3.0.2 • Public • Published

    NPM Version Donate

    typedoc-plugin-merge-modules

    This is a plugin for TypeDoc that merges the content of modules.

    Use cases:

    • If you want to document an entire application and not a library, you can specify all files that you want to have documented as entry points for TypeDoc and use this plugin to merge all modules into the project root removing the extra module layer.
    • If you want to merge the content of some modules in the TypeDoc output, you can use this plugin and module annotations in your files to specify which modules should be combined.

    Installation

    This module can be installed using npm:

    $ npm install typedoc-plugin-merge-modules --save-dev

    TypeDoc automatically detects plugins installed via npm. After installation TypeDoc can be used normally and you can configure this plugin as described below.

    Example

    When running TypeDoc with two module files module1.ts and module2.ts as entry points produces the following result:

    Before

    Using this plugin will make the result look like this:

    After

    Options

    The following options are added to TypeDoc when the plugin is installed:

    Name & Format Description Default
    mergeModulesRenameDefaults <boolean> Defines if the plugin should rename default exports to their original name. true
    mergeModulesMergeMode <"project"|"module"|"off"> Defines if the plugin should merge all modules into the project or if it should merge modules based on their name or module annotation. You can use the value "off" to disable the plugin. "project"

    Bugs

    Please report bugs here. Thanks for your contribution!

    Credits

    Special thanks go to the following people that contributed to this project:

    Donate

    If you find this piece of software helpful, please consider a donation. Any amount is greatly appreciated.

    Donate

    Install

    npm i typedoc-plugin-merge-modules

    DownloadsWeekly Downloads

    2,199

    Version

    3.0.2

    License

    ISC

    Unpacked Size

    16.9 kB

    Total Files

    9

    Last publish

    Collaborators

    • krisztianb