typedoc-plugin-markdown icon indicating copy to clipboard operation
typedoc-plugin-markdown copied to clipboard

Docusaurus Sidebar Category Support

Open dustinlacewell opened this issue 4 years ago • 4 comments
trafficstars

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

dustinlacewell avatar Apr 22 '21 05:04 dustinlacewell

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?

tgreyuk avatar Apr 27 '21 20:04 tgreyuk

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.

dustinlacewell avatar Apr 27 '21 23:04 dustinlacewell

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?

gpbl avatar Nov 29 '21 12:11 gpbl

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

tgreyuk avatar May 14 '23 00:05 tgreyuk