typedoc2md / typedoc-plugin-markdown

A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.
https://typedoc-plugin-markdown.org
MIT License
725 stars 177 forks source link

`footer.generator` value not used in textContentMappings #561

Closed axel7083 closed 9 months ago

axel7083 commented 10 months ago

Using the following dependencies

The following config in docusaurus.config.js is used

...
[
      'docusaurus-plugin-typedoc',
      {
        id: 'api',
        plugin: ['typedoc-plugin-markdown'],
        entryPoints: [resolve('../packages/extension-api/src/extension-api.d.ts')],
        out: 'api',
        hideBreadcrumbs: true,
        readme: 'none',
        tsconfig: resolve('../packages/extension-api/tsconfig.json'),
        textContentMappings: {
          'footer.generator': '?',
        },
      },
    ],
...

However, I am getting the following in all markdown generated

***

Generated using [TypeDoc](https://typedoc.org) and [typedoc-plugin-markdown](https://typedoc-plugin-markdown.org).
tgreyuk commented 10 months ago

Thanks. Out of interest are you going to replace the text with something else or trying to get rid of the generator with an empty string. I ask because it can be removed from the output completely with hideGenerator: true.

axel7083 commented 10 months ago

Thanks. Out of interest are you going to replace the text with something else or trying to get rid of the generator with an empty string. I ask because it can be removed from the output completely with hideGenerator: true.

I will remove it completely

tgreyuk commented 10 months ago

I will remove it completely

ok cool - use hideGenerator for now. I'm actually thinking about just getting rid of it completely.

tgreyuk commented 9 months ago

Closing as generator text is now omitted as default.