Doxygen Awesome CSS 项目常见问题解决方案

Doxygen Awesome CSS 项目常见问题解决方案

doxygen-awesome-css Custom CSS theme for doxygen html-documentation with lots of customization parameters. 项目地址: https://gitcode.com/gh_mirrors/do/doxygen-awesome-css

1. 项目基础介绍

Doxygen Awesome CSS 是一个自定义的 CSS 主题，用于美化 Doxygen 生成的 HTML 文档。该主题提供了现代化的设计，并且可以通过调整 CSS 变量进行高度自定义，无需改变 Doxygen 的 HTML 结构。它还支持暗模式，并改善了移动设备的用户体验。该项目主要使用 HTML、CSS 和 JavaScript 编程语言。

2. 新手使用时需要注意的问题及解决步骤

问题一：如何将主题集成到项目中？

解决步骤：

1. 手动复制文件：从该仓库中复制所需的 CSS 和 JS 文件到你的项目中。
2. Git 子模块：如果你的项目使用 Git，可以将该仓库作为子模块添加到你的项目中。
3. CMake FetchContent：使用 CMake 的 FetchContent 模块添加该项目。
4. npm/xpm 依赖：将项目作为 npm 或 xpm 依赖添加。
5. 系统级安装：将主题安装到系统级别。

确保根据你的项目设置，选择合适的方法将主题文件集成到你的项目中。

问题二：如何自定义主题样式？

解决步骤：

1. 调整 CSS 变量：主题中包含多个 CSS 变量，你可以通过修改这些变量来自定义主题样式。
2. 查找变量定义：在主题的 CSS 文件中查找以 -- 开头的变量定义。
3. 修改变量值：根据需要修改变量的值，例如颜色、字体大小等。

问题三：如何在文档中启用暗模式？

解决步骤：

1. 引入暗模式 CSS 文件：在 HTML 文档中引入 doxygen-awesome-darkmode-toggle.js 文件。
2. 添加切换按钮：在 HTML 文档中添加一个按钮，用于触发暗模式切换功能。
3. 调用切换函数：为按钮添加点击事件，调用 toggleDarkmode() 函数来切换暗模式。

以下是一个示例代码，展示了如何添加一个切换按钮：

<button id="darkmode-toggle">切换暗模式</button>
<script src="doxygen-awesome-darkmode-toggle.js"></script>
<script>
  document.getElementById('darkmode-toggle').addEventListener('click', toggleDarkmode);
</script>

确保按照上述步骤操作，即可在 Doxygen 文档中启用暗模式。

doxygen-awesome-css Custom CSS theme for doxygen html-documentation with lots of customization parameters. 项目地址: https://gitcode.com/gh_mirrors/do/doxygen-awesome-css