search

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
1.04k stars 118 forks source link

Project logo 200x50 px trunks project tile and brief. #17

Open S0NN1 opened 3 years ago

S0NN1 commented 3 years ago

[System configuration]

OS: Ubuntu 20.04 L.T.S Browser: Google Chrome v90.0.4430.93 Doxygen version: 1.9.1 Doxygen Awesome mode: sidebar_only PROJECT_LOGO: 200 px width 55 px height (max dimensions from Doxygen manual) PROJECT_NAME: "Contiki-NG + Kafka Contact Tracing" (placeholder) PROJECT_BRIEF: "A simple integration between Contiki-NG and Apache Kafka"

[Expected result]

Sidebar scales in order to fit logo, brief, and name.

[Actual result]

Logo trunks project name and brief forcing side nav to move under the floating search bar.

[Temporary solution]

Use a squared logo.

ACTUAL RESULT SCREENSHOT

image

TEMPORARY SOLUTION SCREENSHOT

image

jothepro commented 3 years ago

  1. You can customize the sidebar width by overriding the CSS variable --side-nav-fixed-width. (Default is 350px) If you found a value that works for you, make sure to update the Doyxgen variable TREEVIEW_WIDTH to the same value. I cannot remember exactly why that's required but I think otherwise the sidebar may glitch.

  2. I see that even in your second screenshot the spacings are not right because the title & brief both wrap, making the title area too high. I don't think that it's possible to make the sidebar title area adjust in height automatically because I rely on the html generated by doxygen and do some nasty things to force it into this sidebar only theme. My personal workaround for this limitation is to choose a title & brief that fits in the tight space 🙈. But maybe it makes sense to parameterize the height with a css variable like --titlearea-fixed-height, allowing the user to fine-tune how much height he needs for the title area to fit.

Pls give me feedback if (1.) resolves the issue for you. I may provide (2.) in the future and will notify you about it. A PR from you would or course be welcome as well! :)

S0NN1 commented 3 years ago

Hi, thank you for your reply.

For the (1.) workaround I noticed that even with --side-nav-fixed-width: 550px; the side nav is moved. chrome_Eq8S8HUieW Only after increasing the --top-height parameter with, for example, 120px, the result is the one expected chrome_G8wOfSvd9w