Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support for categories (docusaurus plugin) #499

Closed
FC5570 opened this issue Nov 9, 2023 · 3 comments
Closed

Support for categories (docusaurus plugin) #499

FC5570 opened this issue Nov 9, 2023 · 3 comments
Labels
next Fix available in the '@next' release

Comments

@FC5570
Copy link

FC5570 commented Nov 9, 2023

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
        },
      },
    ],
  ]
@FC5570 FC5570 changed the title Support for categories Support for categories (docusaurus plugin) Nov 10, 2023
@tgreyuk
Copy link
Member

tgreyuk commented Nov 19, 2023

thanks. This will be available in next version.

@tgreyuk tgreyuk added the next Fix available in the '@next' release label Nov 19, 2023
@fgatti675
Copy link

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
Copy link
Member

tgreyuk commented May 3, 2024

categories and groups are now supported:

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

@tgreyuk tgreyuk closed this as completed May 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
next Fix available in the '@next' release
Projects
None yet
Development

No branches or pull requests

3 participants