{"id":13460650,"url":"https://jothepro.github.io/doxygen-awesome-css/","last_synced_at":"2025-03-24T19:32:26.272Z","repository":{"id":38176915,"uuid":"348492097","full_name":"jothepro/doxygen-awesome-css","owner":"jothepro","description":"Custom CSS theme for doxygen html-documentation with lots of customization parameters.","archived":false,"fork":false,"pushed_at":"2024-03-11T19:30:06.000Z","size":8262,"stargazers_count":892,"open_issues_count":24,"forks_count":100,"subscribers_count":11,"default_branch":"main","last_synced_at":"2024-04-10T18:22:22.174Z","etag":null,"topics":["css","doxygen","doxygen-theme"],"latest_commit_sha":null,"homepage":"https://jothepro.github.io/doxygen-awesome-css/","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jothepro.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2021-03-16T21:08:00.000Z","updated_at":"2024-04-10T04:18:02.000Z","dependencies_parsed_at":"2023-02-01T17:16:15.168Z","dependency_job_id":"a55d597e-6813-4b66-8a5a-68ffba6b60a7","html_url":"https://github.com/jothepro/doxygen-awesome-css","commit_stats":null,"previous_names":[],"tags_count":22,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jothepro%2Fdoxygen-awesome-css","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jothepro%2Fdoxygen-awesome-css/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jothepro%2Fdoxygen-awesome-css/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jothepro%2Fdoxygen-awesome-css/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jothepro","download_url":"https://codeload.github.com/jothepro/doxygen-awesome-css/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":222004224,"owners_count":16914874,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["css","doxygen","doxygen-theme"],"created_at":"2024-07-31T10:00:46.412Z","updated_at":"2024-10-29T06:30:43.647Z","avatar_url":"https://github.com/jothepro.png","language":"CSS","funding_links":[],"categories":["Examples"],"sub_categories":[],"readme":"#  Doxygen Awesome\n\n[![GitHub release (latest by date)](https://img.shields.io/github/v/release/jothepro/doxygen-awesome-css)](https://github.com/jothepro/doxygen-awesome-css/releases/latest)\n[![GitHub](https://img.shields.io/github/license/jothepro/doxygen-awesome-css)](https://github.com/jothepro/doxygen-awesome-css/blob/main/LICENSE)\n![GitHub Repo stars](https://img.shields.io/github/stars/jothepro/doxygen-awesome-css)\n\n\u003cdiv class=\"title_screenshot\"\u003e\n\n![Screenshot of Doxygen Awesome CSS](img/screenshot.png)\n\n\u003c/div\u003e\n\n**Doxygen Awesome** is a custom CSS theme for Doxygen HTML documentation with lots of customization parameters.\n\n## Motivation\n\nI really like how the Doxygen HTML documentation is structured! But IMHO it looks a bit outdated.\n\nThis theme is an attempt to update the visuals of Doxygen without changing its overall layout too much.\n\n## Features\n\n- 🌈 Clean, modern design\n- 🚀 Heavily customizable by adjusting CSS variables\n- 🧩 No changes to the HTML structure of Doxygen are required\n- 📱 Improved mobile usability\n- 🌘 Dark mode support!\n- 🥇 Works best with **doxygen 1.9.1** - **1.9.4** and **1.9.6** - **1.12.0**\n\n## Examples\n\nSome websites using this theme:\n\n- [Documentation of this repository](https://jothepro.github.io/doxygen-awesome-css/)\n- [wxWidgets](https://docs.wxwidgets.org/3.2/)\n- [OpenCV 5.x](https://docs.opencv.org/5.x/)\n- [Zephyr](https://docs.zephyrproject.org/latest/doxygen/html/index.html)\n- [FELTOR](https://mwiesenberger.github.io/feltor/dg/html/modules.html)\n- [Spatial Audio Framework (SAF)](https://leomccormack.github.io/Spatial_Audio_Framework/index.html)\n- [Randolf Richardson's C++ classes](https://www.randolf.ca/c++/docs/)\n- [libCloudSync](https://jothepro.github.io/libCloudSync/)\n- [libsl3](https://a4z.github.io/libsl3/)\n\n## Installation\n\nTo use the theme when generating your documentation, bring the required CSS and JS files from this repository into your project.\n\nThis can be done in several ways:\n\n- manually copying the files\n- adding the project as a Git submodule\n- downloading the project with CMake FetchContent\n- adding the project as a npm/xpm dependency\n- installing the theme system-wide\n\nAll 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.\n\n### Git submodule\nFor projects that use git, add the repository as a submodule and check out the desired release:\n\n```sh\ngit submodule add https://github.com/jothepro/doxygen-awesome-css.git\ncd doxygen-awesome-css\ngit checkout v2.3.4\n```\n\n### CMake with FetchContent\n\nFor project that build with CMake, the `FetchContent` module can be used to download the repository at configure-time.\n\nAdd the following snippet to your `CMakeLists.txt`\n\n```cmake\ninclude(FetchContent)\nFetchContent_Declare(\n    doxygen-awesome-css\n    URL https://github.com/jothepro/doxygen-awesome-css/archive/refs/heads/main.zip\n)\nFetchContent_MakeAvailable(doxygen-awesome-css)\n\n# Save the location the files were cloned into\n# This allows us to get the path to doxygen-awesome.css\nFetchContent_GetProperties(doxygen-awesome-css SOURCE_DIR AWESOME_CSS_DIR)\n\n# Generate the Doxyfile\nset(DOXYFILE_IN ${CMAKE_CURRENT_SOURCE_DIR}/doc/Doxyfile.in)\nset(DOXYFILE_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)\nconfigure_file(${DOXYFILE_IN} ${DOXYFILE_OUT} @ONLY)\n```\n\nThis downloads the latest main (but any other revision could be used) and unpacks in the build folder. The `Doxyfile.in` can reference this location in the `HTML_EXTRA_STYLESHEET` field\n\n```text\nHTML_EXTRA_STYLESHEET  = @AWESOME_CSS_DIR@/doxygen-awesome.css\n```\n\nWhen the configure stage of CMake is run, the `Doxyfile.in` is rendered to Doxyfile and Doxygen can be run as usual.\n\n### npm/xpm dependency\n\nIn the npm ecosystem, this project can be added as a development dependency\nto your project:\n\n```sh\ncd your-project\nnpm install https://github.com/jothepro/doxygen-awesome-css#v2.3.4 --save-dev\n\nls -l node_module/@jothepro/doxygen-awesome-css\n```\n\nSimilarly, in the [xPack](https://xpack.github.io) ecosystem, this project can be added\nas a development dependency to an [`xpm`](https://xpack.github.io/xpm/)\nmanaged project.\n\n### System-wide\n\nYou can even install the theme system-wide by running `make install`.\nThe files will be installed to `/usr/local/share/` by default,\nbut you can customize the install location with `make PREFIX=/my/custom/path install`.\n\n### Choosing a layout\n\nThere are two layout options. Choose one of them and configure Doxygen accordingly:\n\n\u003cdiv class=\"tabbed\"\u003e\n\n- \u003cb class=\"tab-title\"\u003eBase Theme\u003c/b\u003e\u003cdiv class=\"darkmode_inverted_image\"\u003e\n    ![](img/theme-variants-base.drawio.svg)\n    \u003c/div\u003e\n    Comes with the typical Doxygen titlebar. Optionally the treeview in the sidebar can be enabled.\n\n    Required files: `doxygen-awesome.css`\n\n    Required `Doxyfile` configuration:\n    ```\n    GENERATE_TREEVIEW      = YES # optional. Also works without treeview\n    DISABLE_INDEX = NO\n    FULL_SIDEBAR = NO\n    HTML_EXTRA_STYLESHEET  = doxygen-awesome-css/doxygen-awesome.css\n    HTML_COLORSTYLE        = LIGHT # required with Doxygen \u003e= 1.9.5\n    ```\n\n- \u003cb class=\"tab-title\"\u003eSidebar-Only Theme\u003c/b\u003e\u003cdiv class=\"darkmode_inverted_image\"\u003e\n    ![](img/theme-variants-sidebar-only.drawio.svg)\n    \u003c/div\u003e\n    Hides the top titlebar to give more space to the content. The treeview must be enabled in order for this theme to work.\n\n    Required files: `doxygen-awesome.css`, `doxygen-awesome-sidebar-only.css`\n\n    Required `Doxyfile` configuration:\n    ```\n\n    GENERATE_TREEVIEW      = YES # required!\n    DISABLE_INDEX          = NO\n    FULL_SIDEBAR           = NO\n    HTML_EXTRA_STYLESHEET  = doxygen-awesome-css/doxygen-awesome.css \\\n                            doxygen-awesome-css/doxygen-awesome-sidebar-only.css\n    HTML_COLORSTYLE        = LIGHT # required with Doxygen \u003e= 1.9.5\n    ```\n\n\u003c/div\u003e\n\n\u003cbr\u003e\n\n@warning\n- This theme is not compatible with the `FULL_SIDEBAR = YES` option provided by Doxygen!\n- `HTML_COLORSTYLE` must be set to `LIGHT` since Doxygen 1.9.5!\n\n### Further installation instructions\n\n- [Installing extensions](docs/extensions.md)\n- [Customizing the theme (colors, spacing, border-radius, ...)](docs/customization.md)\n- [Tips and Tricks for further configuration](docs/tricks.md)\n\n## Browser support\n\nTested with\n\n- Chrome 119, Chrome 119 for Android, Chrome 119 for iOS\n- Safari 17, Safari for iOS 16\n- Firefox 118, Firefox 120 for Android, Firefox 119 for iOS\n- Edge 119\n- Opera 108\n\n\nThe theme does not strive to be backward compatible with (significantly) older browser versions.\n\n\n## Credits\n\nThanks for all the bug reports and inspiring feedback on GitHub!\n\nSpecial thanks to all the contributors:\n\u003cbr\u003e\u003cbr\u003e\n\u003ca href=\"https://github.com/jothepro/doxygen-awesome-css/graphs/contributors\"\u003e\n    \u003cimg src=\"https://contrib.rocks/image?repo=jothepro/doxygen-awesome-css\" /\u003e\n\u003c/a\u003e\n\n\n\u003cdiv class=\"section_buttons\"\u003e\n\n|                        Read Next |\n|---------------------------------:|\n| [Extensions](docs/extensions.md) |\n\n\u003c/div\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/jothepro.github.io%2Fdoxygen-awesome-css%2F","html_url":"https://awesome.ecosyste.ms/projects/jothepro.github.io%2Fdoxygen-awesome-css%2F","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/jothepro.github.io%2Fdoxygen-awesome-css%2F/lists"}