typedoc-material-theme

A TypeDoc theme based on Material 3.

Installation

npm install typedoc-material-theme
Copy

Usage

This plugin add a themeColor option to typedoc: the Material 3 source color to derive the theme from.

In CLI:

typedoc src/** --plugin typedoc-material-theme --themeColor '#cb9820'
Copy

or in typedoc.js:

{
  plugin: ["typedoc-material-theme"],
  themeColor: "#cb9820",
  // ... other options
}
Copy

Default fonts (changeable with customCss):

• Space Grotesk
• Space Mono

Documentation

Example generated docs of this package

License

MIT. See license file.