search

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
705 stars 175 forks source link

Support for categories (docusaurus plugin) #499

Closed FC5570 closed 5 months ago

FC5570 commented 11 months ago

I have the @category tag to group certain interfaces/classes under categories. This works normally using standalone typedoc (I have navigation.includeCategories set to true in both configs) but not using this plugin, docs generated have classes and interface sections only.

My config:

  plugins: [
    [
      'docusaurus-plugin-typedoc',
      {
        entryPoints: ['../path-to-folder/index.ts'],
        tsconfig: '../path-to-folder/tsconfig.json',
        out: 'documentation',
        excludeExternals: true,
        navigation: {
            includeCategories: true
        },
      },
    ],
  ]
tgreyuk commented 10 months ago

thanks. This will be available in next version.

fgatti675 commented 10 months ago

Hi @tgreyuk I have a similar use case. I have a bunch of types with the @group tag. I tried the next version but could not get the output categorised by groups? Am I missing something? Thank you and congrats on the plugin!

tgreyuk commented 5 months ago

categories and groups are now supported:

docusaurus-plugin-typedoc@1.0.0 typedoc-plugin-markdown@4.0.0