Adding support for typedoc-plugin-coverage

[SalahAdDin]

Hello again,

Right now we are testing the coverage plugin for creating a badge showing the documentation coverage on the API documentation; unfortunately, it does not work:

However, the badge is created as an svg file:

It should be enough to automatically add it to the intro.md file to show it.

What do you think?

[tgreyuk]

I think that plugin simply creates the SVG. Where exactly would you want it placed? Underneath the API heading on index page only?

[SalahAdDin]

I think that plugin simply creates the SVG. Where exactly would you want it placed? Underneath the API heading on index page only?

Place in the index would be enough, but if it is added to the API heading, I would be amazing!

[tgreyuk]

Because the coverage-plugin doesn't currently let you configure the path, you need to copy the badge to your static directory and then you can reference it using a hook with a custom plugin.

I have added an example stackblitz of this being done:

https://stackblitz.com/~/github.com/tgreyuk/docusaurus-plugin-typedoc-example

This is the code for the custom plugin:

https://github.com/tgreyuk/docusaurus-plugin-typedoc-example/blob/main/docs-website/typedoc-copy-coverage.mjs

You just reference it in the plugins option lilke this:

plugin: ["typedoc-plugin-coverage", "./typedoc-copy-coverage.mjs"],

[SalahAdDin]

@tgreyuk The plugin has type issues:

Could you check it?

[tgreyuk]

Can you make sure you are using the latest version of all plugins please?

[SalahAdDin]

Can you make sure you are using the latest version of all plugins, please?

Yeah, they are in the latest version:

[tgreyuk]

Yeah, they are in the latest version:

please update to 4.0.0-next.53

[SalahAdDin]

Yeah, they are in the latest version:

please update to 4.0.0-next.53

Done, it works!