137 lines
4.8 KiB
Markdown
137 lines
4.8 KiB
Markdown
|
# Doxygen Awesome
|
|||
|
|
|
|||
|
|
[](https://github.com/jothepro/doxygen-awesome-css/releases/latest)
|
|||
|
|
[](https://github.com/jothepro/doxygen-awesome-css/blob/main/LICENSE)
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="title_screenshot">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
**Doxygen Awesome** is a custom **CSS theme for Doxygen HTML-documentation** with lots of customization parameters.
|
|||
|
|
|
|||
|
|
## Motivation
|
|||
|
|
|
|||
|
|
I really like how the Doxygen HTML-documentation is structured! But IMHO it looks a bit outdated.
|
|||
|
|
|
|||
|
|
This theme is an attempt to update the visuals of Doxygen without changing its overall layout too much.
|
|||
|
|
|
|||
|
|
## Features
|
|||
|
|
|
|||
|
|
- 🌈 Clean, modern design
|
|||
|
|
- 🚀 Heavily customizable by adjusting CSS-variables
|
|||
|
|
- 🧩 No changes to the HTML structure of Doxygen required
|
|||
|
|
- 📱 Improved mobile usability
|
|||
|
|
- 🌘 Dark mode support!
|
|||
|
|
- 🥇 Works best with **doxygen 1.9.1** - **1.9.4** and **1.9.6**
|
|||
|
|
|
|||
|
|
## Examples
|
|||
|
|
|
|||
|
|
Some websites using this theme:
|
|||
|
|
|
|||
|
|
- [Documentation of this repository](https://jothepro.github.io/doxygen-awesome-css/)
|
|||
|
|
- [wxWidgets](https://docs.wxwidgets.org/3.2/)
|
|||
|
|
- [OpenCV 5.x](https://docs.opencv.org/5.x/)
|
|||
|
|
- [Zephyr](https://docs.zephyrproject.org/latest/doxygen/html/index.html)
|
|||
|
|
- [FELTOR](https://mwiesenberger.github.io/feltor/dg/html/modules.html)
|
|||
|
|
- [Spatial Audio Framework (SAF)](https://leomccormack.github.io/Spatial_Audio_Framework/index.html)
|
|||
|
|
- [libCloudSync](https://jothepro.github.io/libCloudSync/)
|
|||
|
|
- [libsl3](https://a4z.github.io/libsl3/)
|
|||
|
|
|
|||
|
|
## Installation
|
|||
|
|
|
|||
|
|
To use the theme in your documentation, copy the required CSS and JS files from this repository into your project or add the repository as submodule and check out the latest release:
|
|||
|
|
|
|||
|
|
```bash
|
|||
|
|
git submodule add https://github.com/jothepro/doxygen-awesome-css.git
|
|||
|
|
cd doxygen-awesome-css
|
|||
|
|
git checkout v2.2.0
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
You can even install the theme system-wide by running `make install`. The files will be installed to `/usr/local/share/` by default, but you can customize the install location with `make PREFIX=/my/custom/path install`.
|
|||
|
|
|
|||
|
|
All theme files are located in the root of this repository and start with the prefix `doxygen-awesome-`. You may not need all of them. Follow the install instructions to figure out what files are required for your setup.
|
|||
|
|
|
|||
|
|
### Choosing a layout
|
|||
|
|
|
|||
|
|
There is two layout options. Choose one of them and configure Doxygen accordingly:
|
|||
|
|
|
|||
|
|
<div class="darkmode_inverted_image">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<div class="tabbed">
|
|||
|
|
|
|||
|
|
- <b class="tab-title">1️⃣ Base Theme </b>
|
|||
|
|
Comes with the typical Doxygen titlebar. Optionally the treeview in the sidebar can be enabled.
|
|||
|
|
|
|||
|
|
Required files: `doxygen-awesome.css`
|
|||
|
|
|
|||
|
|
Required `Doxyfile` configuration:
|
|||
|
|
```
|
|||
|
|
GENERATE_TREEVIEW = YES # optional. Also works without treeview
|
|||
|
|
DISABLE_INDEX = NO
|
|||
|
|
FULL_SIDEBAR = NO
|
|||
|
|
HTML_EXTRA_STYLESHEET = doxygen-awesome-css/doxygen-awesome.css
|
|||
|
|
HTML_COLORSTYLE = LIGHT # required with Doxygen >= 1.9.5
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
- <b class="tab-title">2️⃣ Sidebar-Only Theme </b>
|
|||
|
|
Hides the top titlebar to give more space to the content. The treeview must be enabled in order for this theme to work.
|
|||
|
|
|
|||
|
|
Required files: `doxygen-awesome.css`, `doxygen-awesome-sidebar-only.css`
|
|||
|
|
|
|||
|
|
Required `Doxyfile` configuration:
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
GENERATE_TREEVIEW = YES # required!
|
|||
|
|
DISABLE_INDEX = NO
|
|||
|
|
FULL_SIDEBAR = NO
|
|||
|
|
HTML_EXTRA_STYLESHEET = doxygen-awesome-css/doxygen-awesome.css \
|
|||
|
|
doxygen-awesome-css/doxygen-awesome-sidebar-only.css
|
|||
|
|
HTML_COLORSTYLE = LIGHT # required with Doxygen >= 1.9.5
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
**Caution**:
|
|||
|
|
- This theme is not compatible with the `FULL_SIDEBAR = YES` option provided by Doxygen!
|
|||
|
|
- `HTML_COLORSTYLE` must be set to `LIGHT` since Doxygen 1.9.5!
|
|||
|
|
|
|||
|
|
### Further installation instructions:
|
|||
|
|
|
|||
|
|
- [Installing extensions](docs/extensions.md)
|
|||
|
|
- [Customizing the theme (colors, spacing, border-radius, ...)](docs/customization.md)
|
|||
|
|
- [Tips and Tricks for further configuration](docs/tricks.md)
|
|||
|
|
|
|||
|
|
## Browser support
|
|||
|
|
|
|||
|
|
Tested with
|
|||
|
|
|
|||
|
|
- Chrome 110, Chrome 109 for Android, Chrome 110 for iOS
|
|||
|
|
- Safari 16, Safari for iOS 16
|
|||
|
|
- Firefox 110, Firefox 110 for Android, Firefox 109 for iOS
|
|||
|
|
- Edge 110
|
|||
|
|
|
|||
|
|
|
|||
|
|
The theme does not strive to be backwards compatible to (significantly) older browser versions.
|
|||
|
|
|
|||
|
|
|
|||
|
|
## Credits
|
|||
|
|
|
|||
|
|
Thanks for all the bug reports and inspiring feedback on github!
|
|||
|
|
|
|||
|
|
Special thanks to all the contributors:
|
|||
|
|
<br><br>
|
|||
|
|
<a href="https://github.com/jothepro/doxygen-awesome-css/graphs/contributors">
|
|||
|
|
<img src="https://contrib.rocks/image?repo=jothepro/doxygen-awesome-css" />
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
<span class="next_section_button">
|
|||
|
|
|
|||
|
|
Read Next: [Extensions](docs/extensions.md)
|
|||
|
|
</span>
|