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

Document plugin API #1132

Closed
FranklinYu opened this issue Nov 13, 2019 · 2 comments
Closed

Document plugin API #1132

FranklinYu opened this issue Nov 13, 2019 · 2 comments

Comments

@FranklinYu
Copy link

I see that there were several typedoc plugins mentioned in ReadMe. Is the plugin API documented somewhere? Or new plugin authors are supposed to look at existing plugins to get an idea?

@Gerrit0
Copy link
Collaborator

Gerrit0 commented Nov 14, 2019

Unfortunately the best I can offer you right now is to look at existing plugins. The exposed plugin api needs some serious consideration. Right now almost every plugin uses APIs that we don't export directly from the root instance, which is less than ideal, but unfortunately necessary due to the @Component architecture that is used. #521 is tracking making a guide, but I've been putting it off until we get around to removing that decorator.

@FranklinYu
Copy link
Author

@Gerrit0 Thanks for the pointer. I would follow that issue instead so we have less open issue hanging around.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants