Hide "Call signature"?

[LekoArts]

Hello!

Thank you for your work on this plugin, it works great! I'm currently in the process of modifying the output as much as possible with the standard options before reaching into remark/custom plugin territory.

So let's assume I have this setup:

• Source code:

    /**
     * Description
     *
     * @example
     * ### Get the current user
     *
     * Description
     *
     * ```tsx {{ filename: 'src/Example.tsx' }}
     * some example code here
     * ```
     */
    export function useUser(): UseUserReturn {
      // code here
    }

• typedoc.config.mjs:

   /** @type {import("typedoc-plugin-markdown").PluginOptions} */
   const typedocPluginMarkdownOptions = {
     hidePageHeader: true,
     hideBreadcrumbs: true,
     hidePageTitle: true,
   };
   
   /** @type {Partial<import("typedoc").TypeDocOptions>} */
   const config = {
     out: './.typedoc/docs',
     // TODO: Once we're happy with the output the JSON should be written to a non-gitignored location as we want to consume it in other places
     json: './.typedoc/output.json',
     entryPointStrategy: 'packages',
     plugin: ['typedoc-plugin-markdown', "./custom-plugin.mjs"],
     packageOptions: {
       includeVersion: false,
       excludePrivate: true,
       sortEntryPoints: true,
       sort: 'alphabetical',
       excludeExternals: true,
       excludeInternal: true,
       excludeNotDocumented: true,
       gitRevision: 'main',
       blockTags: [...OptionDefaults.blockTags, '@warning', '@note', '@important', '@memberof'],
       modifierTags: [...OptionDefaults.modifierTags],
       exclude: ['src/**/*.test.ts', 'src/**/*.test.tsx'],
       readme: 'none',
       disableGit: true,
       disableSources: true,
     },
     entryPoints: ['packages/nextjs', 'packages/react', 'packages/shared', 'packages/types'], // getPackages(),
     ...typedocPluginMarkdownOptions,
   };
   
   export default config;

With this setup I get an output as such:

> **useUser**(): [`UseUserReturn`](../../types/interfaces/UseUserReturn.md)

Description

## Returns

[`UseUserReturn`](../../types/interfaces/UseUserReturn.md)

## Examples

EXAMPLES GO HERE

I'm wondering how I can turn off/remove the first line, the call signature. Is there an option for that? If not, any suggestions what I should do?

Thanks!

[tgreyuk]

Hello @LekoArts,

There is no option for it - but it would be trivial to implement. hideSignatures and hideDeclarations could potentially be useful options.

You can actually achieve this by creating a custom theme and over riding the relevant partial with an empty string.

A bit of an explanation here https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/devguide/typedoc-plugin-markdown/theme/documents/Custom%20Theme.md. This is not in the public docs as I don't really want this to strictly be viewed as a public api.

I have created a working demo your use-case is here https://github.com/typedoc2md/typedoc-plugin-markdown-scratchpad/tree/main/issues/770

Hope this helps - anything else let me know.

[LekoArts]

Yes, this works great. Thank you very much!

In https://github.com/typedoc2md/typedoc-plugin-markdown/blob/93e43a28aa8326195dbbaba120b1d163ad64c142/packages/typedoc-plugin-markdown/src/theme/context/partials/comments.comment.ts every blockTag comment gets turned into a heading. I actually want to turn @warning or @important blockTags into blockquotes instead of headings (to use alerts).

I suppose I should use the remark pipeline afterwards, right? Overwriting that comments partial would get outdated after a while if I do not update it with the source code here.

[tgreyuk]

want to turn @warning or @Important blockTags into blockquotes instead of headings

Yeah this probably would be good candidate for parsing with remark afterwards, as trying to override the comments partial for this will likely get a bit messy.

This is a good use-case to follow https://github.com/typedoc2md/typedoc-plugin-markdown-scratchpad/blob/main/issues/724/remark-add-playground.mjs . This example updates all code blocks with some extra metadata - in your case you would visit the headings and do some stuff!!

Again you have given me an idea that blockTagStyle/blockTagTemplate could be another useful option. It is always a balance between providing lots of flexibility without overloading and making things too complicated. 🤔

[LekoArts]

Thanks! Yeah, I can certainly feel your pain about public API surface. We (https://clerk.com/docs) already have a MDX/remark pipeline so it's not a problem 👍 If I'm the first person with that ask I wouldn't worry too much and wait for further interest :)

[LekoArts]

I'll make it myself easier by just putting the correct markdown into the comment directly, without using the blockTags. Works 👍

[tgreyuk]

Having thought about this further you could also parse the comments blocks to something else with just a another local typedoc plugin on the events Converter.EVENT_CREATE_DECLARATION and Converter.EVENT_CREATE_SIGNATURE . i will try to dig out an example of what i mean.