typedoc-plugin-markdown icon indicating copy to clipboard operation
typedoc-plugin-markdown copied to clipboard

[FR] Ability to add a subtitle

Open sneko opened this issue 3 years ago • 1 comments
trafficstars

Hi,

In my case I have my /README.md with all setup information... and the technical documentation through Typedoc into /docs/*. The breadcrumb is great to navigate (through the technical documentation) but I'm not able to make a link to /README.md so they can come back to the main presentation.

I tried to specify as option:

  name: `${process.env.npm_package_name} _([show presentation](../README.md))_`,

But if the breadcrumb is enabled, since the name is also used as a link when we are on a page like /docs/classes/abc.md it will break the markdown due to nested links.

In the meantime I disabled the breadcrumb but I think it would be great to be able to allow a subtitle or something like that to point to the root project description.

Thank you,

sneko avatar May 12 '22 12:05 sneko

Hello. Thanks for this. I think what is really needed is the ability to easily customise the template, something I have been looking at.

tgreyuk avatar May 12 '22 21:05 tgreyuk

https://www.typedoc-plugin-markdown.org/docs/customizing-output

tgreyuk avatar May 04 '24 09:05 tgreyuk