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
Allow customization of JavascriptIndexPlugin #1953
Comments
Can be achieved by setting I'm okay with adding an event to |
Yesterday when I checked, this new option was still undocumented |
The |
Well, in the original post, when I said that "it was recently implemented", I was talking about typedoc. Indeed, I'm overriding the |
User docs - true, there's a branch fixing it that'll be merged soon. Options map API doc - true, and unless someone else puts a comment there, it won't. None of the other options discuss implementation details either as comments which aren't right next to the implementation are even more likely to become out of date than normal. |
Great! I'll test this in my next plugin version! Have an excellent weekend |
Search Terms
JavascriptIndexPlugin, search, weight, extension
Problem
I'm writing a plugin that alters some custom reflections in the javascript index. It needs to modify weight of custom reflections (which was implemented in a very recent release) and format the reflection name with a special pattern. Since I wasn't able to alter how reflections are gathered, I had to override the plugin entierly, which complexifies my workflow in order to always stay up to date with Typedoc.
Suggested Solution
Ideally, plugins should be able to alter what is iterated on here:
typedoc/src/lib/output/plugins/JavascriptIndexPlugin.ts
Lines 50 to 52 in ba58696
Maybe the
JavascriptIndexPlugin
could be converted to an event emitter we could hook events on.The text was updated successfully, but these errors were encountered: