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

Docusaurus Sidebar Category Support #213

Closed
dustinlacewell opened this issue Apr 22, 2021 · 5 comments
Closed

Docusaurus Sidebar Category Support #213

dustinlacewell opened this issue Apr 22, 2021 · 5 comments
Labels
next Fix available in the '@next' release

Comments

@dustinlacewell
Copy link

It would be great to have the @category grouping reflected in the generated sidebars.

@tgreyuk
Copy link
Member

tgreyuk commented Apr 27, 2021

The sidebars themselves currently only nest one level deep so not too sure how this would work in practice. The categories should appear on the secondary TOC on the right?

@dustinlacewell
Copy link
Author

Dunno, I'm just a dumb user. I guess it's a question of design. But the categories are there and it'd be nice to reflect them on the the front-end one way or another.

@gpbl
Copy link

gpbl commented Nov 29, 2021

I believe the idea is to output the reflections by categories first.

For example, in https://react-day-picker.js.org/reference, in the sidebar there's "Functions", while I would like to have "Components" when the function is a component.

Maybe @dustinlacewell was suggesting to use the @category tag?

@tgreyuk
Copy link
Member

tgreyuk commented May 14, 2023

@category support for sidebar implemented in docusaurus-plugin-typedoc@next

@tgreyuk tgreyuk added the next Fix available in the '@next' release label May 14, 2023
@tgreyuk
Copy link
Member

tgreyuk commented May 3, 2024

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