Typedoc: Create a "How to write a typedoc plugin" for boosting community plugins

Created on 1 Jun 2017  路  6Comments  路  Source: TypeStrong/typedoc

I don't know if typedoc is currently plugin-ready, meaning the code structure exporting the right classes and methods for 3rd party developers, but since there already exist a few nice plugins it would be good to have a short "Typedoc plugin 101" so one can write our own plugins in order to boost company.

docs question

Most helpful comment

I would be 100% for this. Making it entirely pluggable would unleash the full power of the community. I'd be willing to give it a few pull requests, as soon as I have a better understanding of the code base.

All 6 comments

I would be 100% for this. Making it entirely pluggable would unleash the full power of the community. I'd be willing to give it a few pull requests, as soon as I have a better understanding of the code base.

Looking forward to have it.

Same for me, I'm looking for a way to write a local plugin for my project. It would be nice to specify a single plugin ts file.

You can specify plugins to be loaded with --plugin /absolute/path/to/my-plugin.js

I think this issue needs to wait for a stable release - or at least until the @Component decorator is removed since that will change everything anyways.

Any progress on this? Existing plugins get outdated and it becomes hard to figure out what the process for creating one is.

I have started https://typedoc.org/guides/development/, which focuses on developing TypeDoc proper, but will likely be useful for plugin developers.

I am in the middle right now of making library mode a thing, which has required changing quite a lot of the codebase (okay, I admit some didn't have to be changed, but I've wanted to for a while, and while I'm breaking everything anyways....) as a part of this, I'm taking good notes for what plugin developers need to know. I'll publish a hello world of plugin development guide as a draft once it is ready for a PR.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

Bibliofile picture Bibliofile  路  3Comments

cfischer picture cfischer  路  4Comments

Rycochet picture Rycochet  路  4Comments

euberdeveloper picture euberdeveloper  路  3Comments

mirismaili picture mirismaili  路  3Comments