Add dark/light theme toggle to default themes

[cspotcode]

Search Terms

theme

Problem

These days, docsites often have a toggle to switch between light and dark themes, and they default to matching the OS's theme preference.

Suggested Solution

Colors from here: https://github.com/rockerBOO/typedoc-default-themes-dark
Toggle UI via https://github.com/GoogleChromeLabs/dark-mode-toggle
And ask Futuristick to give it their frontend polish and make it pretty.

[Rami-Sabbagh]

I really like TypeDoc and using it for many of my projects, and it would be very cool to have a dark mode.
As my own libraries documentation websites kill me at night 😬

[furkanarabaci]

Yes please, would be awesome!

[Gerrit0]

Will be available through typedoc@beta shortly - just need to fix a few more issues.

[aaclayton]

Is there a way to suggest the default theme that should be used? Currently the default for new users is "OS", but if I wanted to have the default theme prefer dark by default, is it possible?

[Gerrit0]

#1840 (comment)

[aaclayton]

Thanks, this isn't quite what I'm looking for because I'm not wanting to force all users to have a specific theme, but rather to change the default for a user who has not yet selected a preference to be "Dark" (desired default) instead of "OS" (current default). I can play with this plugin idea and likely accomplish it via a similar approach, unless that alters your answer.

It would be a nice thing for the default theme to expose as a configuration option I think.

[Gerrit0]

Re-reading my linked post... that's kind of confusing, but your desired behavior is what that plugin does.