v2.3.3

Maintenance Release

Thanks to @VolkerEnderlein, @OleksandrKvl and @marktsuchida for contributing bug reports and pull requests to this release!

Fixed

• Markdown separators do not overlay TOC anymore. Fixes #138. (9f97817)
• Function parameter coloring has been improved for Doxygen 1.10. Fixes #139. (a7ec802)

Full Changelog: v2.3.2...v2.3.3

v2.3.2

A Small Maintenance Release 👀

Fixed

• The TOC sidebar does now use the same font as the rest of the page. Fixes #131. (998eaf3)
• Tabs can now contain lists. Fixes #132. (c01e51e)
• Visual artifacts in the navigation tree appearing in Doxygen 1.10.0 have been removed. Fixes #136. (c4a2f64)

v2.3.1

Release fix for npm 🤦‍♂️

Nothing to see here! This release only fixes the package.json version. The new version can now be installed with npm as expected.

Changed

• The documentation was slightly improved. (b5d5b27)

Fixed

• I messed up the v2.3.0 release by forgetting to update the package.json version field. Fixes #130. (df88fe4)

v2.3.0

Colors, Tabs and Navigation Buttons 🕺

This release brings better compatibility with Doxygen 1.9.8, official support for page navigation buttons and improved tabs.

Thanks to @mr-c, @david-alvarez-rosa, @patricklaf, @dsieger and @traversebitree for reporting bugs, opening pull requests and providing feedback that influenced this release!

Added

• Official support for page navigation buttons was added. (db7f670, 4f33788, 9796bbf)
  
  They were originally introduced as a custom extension for the demo page, but people seemed to like them, so they are now part of doxygen-awesome.css. This feature is based on MR #120 by @patricklaf.
  Instructions on setting up page navigation can be found here.

Changed

• The coloring of text blocks like "note", "warning", "error", etc. was improved based on pmp-library/pmp-library@54e8e75. Fixes #123 (3831e5c)
• The Tabs extension was slightly improved. The height of the tab content is now always set to the maximum required space.
  This prevents unwanted jumping of the content below when tabs are changed. Also the appearance of the tabs was improved.
  Be aware that this feature is still considered experimental! (fa53db2, 20a0c45)

Fixed

• The Makefile does now install the Tabs extension as well. (00a52f6)
• Code Fragments are now working as expected in Doxygen 1.9.8. Fixes #128. (c064ec1)

Full Changelog: v2.2.1...v2.3.0

v2.2.1

Installation with npm 🐥

Doxygen 1.9.7 is out and is compatible with this version.

Thanks to @ilg-ul and @manzerbredes for reporting bugs, opening pull requests and providing feedback that influenced this release!

Added

• A package.json was added to the repository, which allows to install this theme with npm or xpm: npm install https://github.com/jothepro/doxygen-awesome-css#v2.2.1 --save-dev (7ea6939)

Changed

• The style of the tabs extension was slightly improved. (f54bc54)

Fixed

• The side-nav container now has a min and max width to avoid that it gets stuck in an unrecoverable state when resized. Fixes #115. (2959339)
• The side-nav resize handle area was increased to 4px to allow easier resizing. Unfortunately this fix only works on macOS for now. (2959339)

Full Changelog: v2.2.0...v2.2.1

v2.2.0

Graphviz support, Tabs and Bugfixes 🥁

Doxygen 1.9.6 is out and supported by this version!

Thanks to @Tachi107, @asmaloney, @StefanBattmer, @tim-gromeyer and @MuellerSeb for reporting bugs, opening pull requests and providing feedback that influenced this release!

Added

• The new experimental "tabs" extension allows to format list content as tabs. Detailed documentation can be found here. Be warned that it might be buggy, I haven't tested it extensively yet! (dd9216c)
  
• User-defined Graphviz graphs are now supported. They are inverted in dark-mode and can be scrolled if they are too wide to fit. (a6b9f1e, bbaaea4)
  
• A Makefile was added to support easy installation with the command make install. (8a34f70)
• Added support for postcondition blocks @post. (73c3019)
• Added documentation and a support class that helps with table formatting: Tables can now be centered or can fill the whole page width. Detailed documentation can be found here. (7b9598a)

Fixed

• Tables are not cut off on the sides anymore when centered. Fixes #91. (05fa388)
• The nav-tree sidebar can now be resized in Chrome on Windows. It is still just 1px wide though and thereby hard to grab. I may address this in a future release 🤔 . Fixes #106. (74a129b)

Full Changelog: v2.1.0...v2.2.0

v2.1.0

Going down the rabbit hole 🐰

This release attempts to polish small things that have been overlooked up to this point. The closer I started looking, the more details needed refinement, which is why there is plenty of changes in this new version that you probably won't even notice. 😨

Also, a big new feature is introduced: A totally redesigned Table of Contents!

Many thanks to @leissa, @artem-ogre, @oblivioncth, @cadop and @McSnipe97 for reporting bugs and providing feedback that influenced this release!

Added

• Compatibility for Doxygen 1.9.5 has been improved. (5bf1d5f)
  Nervertheless it recommended to skip 1.9.5 and update directly to 1.9.6 once it is released! 1.9.5 comes with styled scrollbars that don't play well with this theme: doxygen/doxygen#9549
• Doxygen tables are now supported. (9e46639)
• Custom styling for some expand/collapse arrows was added. (74b4250, fe37c76)
• Anchors to a line in a code listing are now supported. (a27f39e)
• The Table of Contents (TOC) on documentation pages has been redesigned! 👏 (9e3712c, 4621dc4, 7221204)
  On large screens, the TOC is now anchored to the top right of the page. This means that it is always accessible, even when scrolling through a long document.
  An optional Javascript extension that interactively highlights the current read progress is provided in doxygen-awesome-interactive-toc.js. When the extension is enabled, on small screens the TOC is also hidden by default to save some screen space:
  

Changed

• Some small layout adjustments where made. (06ffe6d, 0d3ef53, 51a8ce0)

Fixed

• Fixed the searchbar for older versions of Doxygen (v1.8.x): (bf51192)
  • the searchbar image is not squashed anymore.
  • background image artifacts in the searchbar are removed.
• Images in tables are not inverted anymore. (afc4868)
• The layout for long templated functions was improved. (c6568eb)

Full Changelog: v2.0.3...v2.1.0

v2.0.3

Some more fine tuning ✨

Changed

• The treeview selection indicator is now rounded. (10cf1bf)
  

Fixed

• Some small issues with the new scrollbar styling have been resolved: (2b51cd4, ccedae8)
• The styling for C++ template types in the member function documentation has been fixed. (a933556)

v2.0.2

Patching some small details

This is the second wave of fixes for the 2.0 release. I hope that now everything is finally up to my expectations.

Fixed

• Graphs do now also have a fancy styled scrollbar if they get too wide. (78803c1)
• The box-shadow hack to extend <hr> separators came with some graphical artifacts on hdpi screens. This is now fixed. (3510ade, af067fc)
• Tables are now scrollable. This fixes many problems with content getting too wide on small screens. (b07c1cb)
• The breadcrumb navigation has been optimized slightly, especially on small screens. (8109209, 527743a, 8e97a90)
• The color of the "generated by doxygen" hint has been fixed if GENERATE_TREEVIEW=NO (f1e4263)

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)