v2.0.1

Move along, there's nothing to see!

This patch includes all the minor stuff that I've overlooked when doing the release yesterday.

Added

• documentation on how to disable dark-mode (75eabdc, #54)
• documentation on how to configure the sidebar width for the sidebar-only theme variant. (75eabdc)

Changed

• reduced the default sidebar width for the sidebar-only theme variant to 335px. (7071e18)
• Text overflowing the sidebar-only title is now not wrapping to a new line and instead cut of. This is to make sure the layout below doesn't break. Choose your sidebar width wisely! (75eabdc)

Fixed

• the hover-effect on the mobile main menu's expand/collapse buttons wasn't... perfect. The coloring has been tweaked a bit to fix the appearance. (7c59e23)
• <hr> tags do now also expand beyond it's bounds on small screens (7c35531)

v2.0.0

Now even more awesome! ✨

I've finally implemented all the ideas I've accumulated over the past year, many of them based on your feedback. Have fun! 😊

I've applied a lot of dirty hacks to push this theme to the limits and some changes I introduced might be controversial. Please share any problem and/or feedback that you have!

This is a release containing breaking changes. Consult the migration instructions below on how to update!
If you had issue updating please let me know so I can improve the documentation!

Added

• Scrollbars in the sidebar navigation, in code fragments, etc. are styled to blend in better with the theme. On Firefox scrollbars are smaller and therefore less intrusive. In Safari and Chromium based browsers (Chrome, Edge, ...) scrollbars are only visible when hovering the scrollable area. (9fd4cb0)
  
• A new optional extension for providing a copy button in every code fragment has been added. When clicked, the content of the fragment is copied to the clipboard. The feature is inspired by a similar functionality from github. (acfed44)
  
• A new optional extension for providing a simple way to create anchor links to headlines has been added. (acfed44)
  

Changes

• Many colors of the theme have been adjusted.
• Blockquotes now come with a fancy new style (f02a9eb)
• Tables do now have rounded corners (ae166c8)
• The appearance of the member documentation has been overhauled. Support for small screens has been improved. (a263408)
• The button to disable panel synchronization in the sidebar has been moved to the bottom. (685af0c)

Breaking Changes

• Code fragments do now come in a light appearance in light-mode. (da3c666)
  
• The dark-mode toggle extension (doxygen-awesome-darkmode-toggle.js) has been overhauled to support vector graphics as icon and the initialization is now easier.

Removed

• The CSS variables --primary-lighter-color & --primary-lightest-color have been removed. (a263408)

Fixed

• \todo and \remarks blocks are now supported. Thx @briederer! (d4c30c7)
• Graphs can now be scrolled when they are getting too wide. (b6a3373)
• The "Class Index" page from Doxygen 1.8 is now supported. (#62)
• and many more...

Migration Guide

• Some variables have been removed/added. If you are currently overriding variables to alter the appearance, check if they still exist in the new release.
• If you have installed the dark-mode toggle button, make sure to remove all previous initialization logic from the footer template. The extension can now be initialized in the header with just one line:

  DoxygenAwesomeDarkModeToggle.init()

---

🇺🇦 STOP PUTIN! STOP WAR! 🇺🇦

v1.6.1

Fixing incompatibilities with Doxygen 1.9.2 🔥 🚒

This release provides some fixes, mostly related to making the theme more compatible with Doxygen 1.9.2 while maintaining backwards compatibility with Doxygen 1.9.1 as well.

If you are still experiencing issues related to Doxygen 1.9.2, pls let me know!

Thanks to @dmadison, @nilsleiffischer and @leomccormack for reporting bugs and helping me to resolve them! 🥳

Changed

• The demo page is updated to Doxygen 1.9.2: jothepro.github.io/doxygen-awesome-css/

Fixed

• The introduction of the color-scheme CSS-property introduced a bug in Chrome where iframes would sometimes have a black background in Chrome. (#51)
  All graphics should always have a transparent background now.
• On small screens the search bar was overlapping with the new hamburger menu that was introduced in Doxygen 1.9.2. (#47)
  The search bar is now giving enough space for the hamburger menu, while still working with the old menu style from Doxygen 1.9.1
• The dark-mode toggle button was disappearing on window resize in Doxygen 1.9.2 and on small screens it collided with the search bar. (#52)
  Both issues are resolved. For the button not to disappear, you have to update your footer.html:

  // update your JS to inject the toggle button:
  $(function() {
    toggleButton = document.createElement('doxygen-awesome-dark-mode-toggle')
    toggleButton.title = "Toggle Light/Dark Mode"
  
    $(document).ready(function(){
      document.getElementById("MSearchBox").parentNode.appendChild(toggleButton)
    })
    // every resize will remove the button, which is why it has to be added again:
    $(window).resize(function(){
      document.getElementById("MSearchBox").parentNode.appendChild(toggleButton)
    })
  })

v1.6.0

Just a Boring Maintenance Release 🤷

This release brings some small fixes and improvements.
Doxygen 1.9.2 should now be supported. If you find any issues that may be related to the new doxygen version, pls reopen #44!

Thanks to @Nambers, @ghost, @AleixFerre, @ProkopRandacek, @Super-Lovers and @leomccormack for contributing bugreports and improvements to this release! 💪

Added

• Doxygen 1.9.2 is now supported (#44)
• The color-scheme CSS-property has been added, so the browser can make adjustments to it's user interface accordingly, e.g. by showing a dark scroll-bar in dark-mode. (#39)

Changed

• The default content-width is now 1000px instead of 900px.
• The documentation was improved, especially the instructions on how to install the dark-mode toggle. (#33)
• doxygen-awesome-sidebar-only.css now uses the html instead of the :root selector for setting variables, like doxygen-awesome.css does.
• The readability of @note blocks in dark-mode has been improved (#41, 61aeb3e)

Fixed

• The dark mode is more consistently applied to all graphics, now including the "Graph Legend" and the "Class Hierarchy" graph. (#37)
• Color scheme changes are now applied to all open tabs. (864eddc)

Known issues

• In doxygen 1.9.2 the searchbar overlaps with the hamburger menu (#47)

Upgrading to doxygen 1.9.2

If you upgrade from doxygen 1.9.1 to 1.9.2 and you use the darkmode toggle from this repository, make sure to update your footer template! The call to initialize the toggle button now has to be wrapped in $(function() { ... }):

<script type="text/javascript">
  $(function() {
      $(document).ready(function(){
         toggleButton = document.createElement('doxygen-awesome-dark-mode-toggle')
         toggleButton.title = "Toggle Light/Dark Mode"
         document.getElementById("MSearchBox").parentNode.appendChild(toggleButton)
     })
  })
</script>

v1.5.0

Come to the dark side, we have cookies! 🍪

This release is all about fine tuning the appearance of the theme and fixing bugs. The biggest new feature is the toggle button that let's you enable the dark mode manually. Follow me to the dark side! 🌛

Thanks to @r0ckarong, @kuenzign, @Bernd1995, @jpgarza93 and @TheRolfFR for helping me to make this theme more awesome!

Added

• Experimental and optional toggle to enable the dark theme manually. (#2)
  
• Support for Graphviz graphs in the dark theme (#27, #28)
• The sidebar now by default has a subtle gray background in the light theme.
  
• The opacity of the arrows in the side-nav is now configurable: --side-nav-arrow-opacity, --side-nav-arrow-hover-opacity. (#24)

Changed

• Minor changes to hyperlinks to improve their overall color consistency and appearance. Hyperlinks do now have the color --primary-color instead of --primary-dark-color.
• Improved arrow style for nav-tree, tables & file tree.
• The readability of search results in the dark theme was improved. (#15)
  

Fixed

• Graphics bug for code fragments longer than 626 lines. (#18)
• Issue with top menu dropdown sub arrows. They are now colored in the body foreground color instead of the titlebar header foreground color to allow a dark top menu. (#22)

v1.4.0

Code Fragment Improvements

Added

• variable --fragment-lineheight: controls the line-height of code listings.
• variable --fragment-keywordflow: controls the color of program flow keywords in code fragments. (#10)

Changed

• Improved search box close button positioning on small screens.

Fixed

• Line indentation in code fragments was broken due to my attemts to make listings overflow-scroll instead of wrap at the end of the line. This is now fixed. (#9)

Removed

• --fragment-whitespace variable. The variable is not compatible with the fix for code indentation. It's removal means that you can no longer disable the overflow-scroll in code fragments.

v1.3.0

Improvements Based on your Feedback. Thank you! 🚀

Added

• Support for @invariant & @pre (fixes #4)
• Basic support for HTML_DYNAMIC_MENUS = NO (fixes #3 (comment))
• Search has a focus ring in the primary theme color when in focus:
  
• Small layout improvements to improve mobile usability:
  • Member function tables can be scrolled horizontally if the content is too wide for the screen
  • Member titles do wrap if they are too long for the screen
    
• Improved keyboard navigation: Enabled focus rings for treeview. This makes navigation with Tab much easier:
  
• Allow inline code to break if the line would get too long.

Changed

• Increased font size on mobile to improve readability and avoid the search bar being zoomed in on iOS devices (iOS requires at least 16px font size on text input fields, see here)

Fixed

• Class Index odd rows do blend in better in dark mode (fixes #5)

v1.2.2

Function interface layout improvements

I messed up the layout of multi-parameter function interfaces in the last minor release (v1.2.0) because I wanted to improve the mobile usability. In this release I am rolling back most of these changes to fix the layout. 😣

Fixes

• Super small fix for super small graphical issue in Safari
• Restored original layout of multiple parameter function interfaces:
  • Before (broken since v1.2.0):
    
  • After:
    

v1.2.1

Patch for code fragments

Fixed

• (1) Long lines in code fragments had mysterious blank lines following them on Safari (macOS + iOS). These are now removed.
• (2) Code fragments inside lists on small screens do have no right & left spacing any more.

v1.2.0

Improvements for mobile and dark mode

Added

• Improved configuration documentation
• License headers in CSS-files

Changed

• Long words in the header are now force-wrapped to to improve readability on small screens
• The searchbars contrast has been improved in dark mode:
  
• Code fragments do not wrap content any more, instead they scroll horizontally if content is too long. On small screens fragments also do waste less space left and right:
  
  If you want to restore the previous behaviour where lines did wrap if they where too long, set the CSS-variable --fragment-whitespace to initial.
• Member function interfaces do wrap better on small screens.

Fixed

• Code fragments do not force a horizontal scrollbar on the website if the fragment lines are too long. Instead the do have a scrollbar themselves.
• In the Sidebar-only variant on touch-devices the sidebar does not show a big touch-optimized resize bar any more. It is not needed because the sidebar width is fixed.
• The navigation breadcrumps do not shrink to the right of the searchbar if GENERATE_TREEVIEW is disabled:
  
• The Content is not overlapping with the footer in the sidebar-only variant any more.