typedoc-umlclass

This is a plugin for TypeDoc that automatically inserts a UML class diagrams into the doc pages of your classes and interfaces.

Example:

Installation

This plugin should be installed as a dev dependency using npm:

$ npm install --save-dev typedoc-umlclass

Requirements

This plugin requires the following software to be installed on your system:

• JAVA (latest version)
• Graphviz (latest version)
• TypeDoc (supported versions: 0.24.x and 0.25.x)

You need to activate the plugin with a TypeDoc command line argument or the plugin option in your TypeDoc config file (see example below).

After this step TypeDoc can be used normally and you can configure this plugin as described below.

Options

The option umlClassDiagram is added to TypeDoc when the plugin is installed. The option is an object whose properties can be used to configure the plugin within your TypeDoc config file. Here is an example using a strictly-typed JavaScript config file:

/** @type { import('typedoc').TypeDocOptionMap & import('typedoc-umlclass').Config } */
module.exports = {
    entryPoints: ["./src/index.ts"],
    out: "doc",
    plugin: ["typedoc-umlclass"],
    umlClassDiagram: {
        type: "detailed",
        location: "local",
        format: "svg"
    }
};

Basic settings

HTML output

Class diagram formating

Other settings

Bugs

Please report bugs here. Thanks for your contribution!

Credits

I thank the following people that influenced this project:

• Meir Gottlieb for his typedoc-plantuml plugin of which this plugin first was a fork of.
• Michael K for his (unfinished) extension/fork to that plugin which gave me some insights into TypeDoc renderer events.
• Gerrit Birkeland for his help on questions about TypeDoc.
• Youssef Boujraf for his impulse to create a separate plugin and help with testing it.

Donate

If you find this plugin helpful, please consider a donation. Any amount is greatly appreciated and motivates me to keep this project up to date.

License

Licensed under ISC.