Typedoc Theme Hierarchy

Hierarchy theme for typedoc

See example here

The plugin supports only expand and resolve values for the entryPointStrategy option. Support for packages is planned for the future. Please create an issue if you need it.

Installing

# For typedoc ^0.26.0 || ^0.27.0
npm i typedoc-theme-hierarchy@^5.0.0 -D

# For typedoc ^0.24.0 || ^0.25.0
npm i typedoc-theme-hierarchy@^4.0.0 -D

# For typedoc ^0.23.6
npm i typedoc-theme-hierarchy@^3.0.0 -D

# For typedoc 0.23.5
npm i typedoc-theme-hierarchy@^2.0.0 -D

# For typedoc ^0.22.0 || <=0.23.4
npm i typedoc-theme-hierarchy@^1.3.5 -D

Usage

From terminal:

typedoc --entryPoints src --entryPointStrategy expand --out docs --plugin typedoc-theme-hierarchy --theme hierarchy

From typedoc.json:

{
  "entryPoints": ["src"],
  "entryPointStrategy": "Expand",
  "out": "public/docs",
  "plugin": ["typedoc-theme-hierarchy"],
  "theme": "hierarchy",
  "tsconfig": "./tsconfig.json",
  "name": "Project name"
}