Feature request: ToC as side bar

jothepro / doxygen-awesome-css

Custom CSS theme for doxygen html-documentation with lots of customization parameters.

https://jothepro.github.io/doxygen-awesome-css/

MIT License

981 stars 112 forks source link

Feature request: ToC as side bar #81

Closed leissa closed 1 year ago

leissa commented 2 years ago

Would be really cool to have an option to render the ToC on the right hand side of the main area similar to this: https://rise-lang.org/doc/language-reference/rise-types/

Right now, the ToC box is quite small and headers are often broken into several lines - which makes the ToC box a bit harder to read. Furthermore, the ToC shrinks the space for code boxes and the "Copy to Clipboard" button isn't visible. Finally, having a ToC box anchored on the top right would also enhance the overall reading/navigation experience.

jothepro commented 2 years ago

That's a great idea! I've introduced an improved TOC in this commit.

In addition to your suggestion the new TOC also is hidden on mobile by default, to save some space.

The new feature still needs extensive testing before the next release though. I am looking forward to your feedback!

https://user-images.githubusercontent.com/21294002/185227486-d5655d34-9e24-4479-bd66-06ab3db93583.mov

Becheler commented 1 year ago

Hi @jothepro ! Any news on this (amazing) feature and maybe a planned release date?

jothepro commented 1 year ago

The feature has already been released with v2.1.0

I'll close this issue to avoid confusion.

leissa commented 1 year ago

Great work. Love it :)