typedoc-material-theme

A TypeDoc theme based on Material 3.

Installation

npm install typedoc-material-theme

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'

or in typedoc.js:

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

Default fonts (changeable with customCss):

• Space Grotesk
• Space Mono

Documentation

Example generated docs of this package

License

MIT. See license file.

Changelog

All notable changes to this project will be documented in this file. See commit-and-tag-version for commit guidelines.

1.4.0 (2025-04-10)

Features

• update style for new search box to support typedoc@0.28 (8fab28d)

1.3.0 (2025-01-21)

Bug Fixes

• update search input top position to support typedoc@0.27 (1cd3beb), closes #17 #18

1.2.0 (2024-11-26)

Bug Fixes

• bare-minimum scrollbar not working on Chrome 121+ (#10) (17a9de7)
• changed package.json to use non-fixed version of typedoc (d69cc96)
• page-toolbar styling issue with overlapping elements (#8) (e89fa11)
• updated typdoc to include 0.26.11 (676f344)

Features

• add word-break for long page title (86be2b3)

1.1.0 (2024-07-02)

Features

• add back support for typedoc 0.25.13 (7cf777d)
• support typedoc v0.26 (8901412)

Reverts

• Revert "chore: remove included build files" (e164d88)

1.0.3 (2024-06-20)

1.0.2 (2024-01-04)

1.0.1 (2023-11-24)

Bug Fixes

• use the themeColor options in the renderer hooks after it has been parsed (02bd492), closes #1

1.0.0 (2023-11-09)

Features

• add initial plugin (f58dea2)