@starbeam-dev/typedoc-theme

A TypeDoc theme and plugin for projects using Starbeam Dev

Usage

npm install --save-dev @starbeam-dev/typedoc-theme

{
  "plugin": ["@starbeam-dev/typedoc-theme"],
  "theme": "@starbeam-dev"
}

Features

• 🌸🦋 A prettier version of the default theme
• 🫧🧹 Dynamically removes categories from the navigation that don't have any members based on the currently selected filters.
• 🥇 @primary overloads: If an overload is marked @primary, it will be moved to the top of the overload list, with additional whitespace following it. This allows you to put the primary documentation alongside the most general overload, even though it needs to appear last for type system reasons.
• 📋 Inlining: If a type declaration is marked with @inline, all references to that type declaration will be replaced with the body of the declaration.

Limitations

• 🔍⚠️ Non-exhaustive: This theme was built for packages using starbeam-dev and may not fully cover all TypeDoc features (but patches are welcome!).
• 🧷 Somewhat brittle: This theme was built on top of the CSS, DOM structure and HTML of TypeDoc's default theme. These details are not really public API. It is also built on assumptions of TypeDoc as of 0.25 and TypeScript as of 5.2.2. These assumptions may change and would break the theme.

Maintainers

The Starbeam team.

Contributing

See the contributing file!

License

MIT © 2023 Yehuda Katz