Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

regression: broken support for custom themes #1701

Closed
vladmandic opened this issue Sep 18, 2021 · 4 comments
Closed

regression: broken support for custom themes #1701

vladmandic opened this issue Sep 18, 2021 · 4 comments
Labels
bug Functionality does not match expectation no bug This is expected behavior

Comments

@vladmandic
Copy link

typedoc version: typedoc 0.22.3
other versions: typescript 4.4.3 with node 16.5.0 on ubuntu 21.04 inside wsl2 on windows 11

typedoc --theme custom test.js

throws error:

Error: The theme 'custom' is not defined. The available themes are: default
Error: Documentation could not be generated due to the errors above.

same when using typedoc via api and setting td.options.theme (which is a type: string, so not much else to do there)

this used to work before latest update

@vladmandic vladmandic added the bug Functionality does not match expectation label Sep 18, 2021
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Sep 18, 2021

HTML output is now rendered with JSX instead of Handlebars, closes #1631.
This change provides major performance benefits, reducing rendering time by up to 10x for several benchmarked projects.
It also allows themes to be easily type checked, preventing mistakes when creating custom themes.
Removing Handlebars also fixed memory leaks when --watch was specified due to Handlebar's caching mechanism.
This change breaks all existing custom themes, so a theme created for v0.21 or earlier will not work in v0.22.
See internal-docs/custom-themes.md for documentation on how to create a custom theme in v0.22.

https://github.com/TypeStrong/typedoc/releases/tag/v0.22.0

@Gerrit0 Gerrit0 added the no bug This is expected behavior label Sep 18, 2021
@vladmandic
Copy link
Author

that's fair - but cli output should be noting that input param is not pointing to a valid theme

@Gerrit0
Copy link
Collaborator

Gerrit0 commented Sep 18, 2021

Error: The theme 'custom' is not defined. The available themes are: default

It does, you even included it in your original post!

@vladmandic
Copy link
Author

this is anything but clear

Error: The theme 'custom' is not defined

but ok, closing as by-design

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Functionality does not match expectation no bug This is expected behavior
Projects
None yet
Development

No branches or pull requests

2 participants