Detalhes do pacote

@jsprismarine/typedoc-material-theme

dmnsgn55MIT1.0.4

A TypeDoc theme based on Material 3.

typedoc-theme, typedoc-plugin, material, material-design

readme (leia-me)

typedoc-material-theme

npm version stability-stable npm minzipped size dependencies types Conventional Commits styled with prettier linted with eslint license

A TypeDoc theme based on Material 3.

paypal coinbase twitter

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):

Documentation

Example generated docs of this package

License

MIT. See license file.

changelog (log de mudanças)

Changelog

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

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