typedoc-theme-hierarchy
TypeScript icon, indicating that this package has built-in type declarations

4.1.2 • Public • Published

Typedoc Theme Hierarchy

Hierarchy theme for typedoc


Requires node ^15


typedoc-theme-hierarchy (latest) typedoc-theme-hierarchy (downloads) typedoc-theme-hierarchy (stars)

example

Installing


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

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

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

# For typedoc >=0.24.0
npm i typedoc-theme-hierarchy@^4.0.0 -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"
}

Package Sidebar

Install

npm i typedoc-theme-hierarchy

Weekly Downloads

11,881

Version

4.1.2

License

MIT

Unpacked Size

24.9 kB

Total Files

16

Last publish

Collaborators

  • difuks