使用readme.md作为Doxygen主页生成后页面空白的问题求助
Doxygen 1.9.6 用MD文件做主页面空白的排查方案
- 核对路径准确性:
USE_MDFILE_AS_MAINPAGE里必须填readme.md的完整路径,或者相对于Doxygen配置文件的相对路径。如果配置文件和readme不在同一目录,只写文件名会导致Doxygen找不到文件作为主页,但文件还是会被当作普通文档收录(所以能通过_README入口访问)。 - 验证Markdown语法兼容性:Doxygen对Markdown的支持不是完全兼容所有扩展语法,比如复杂嵌套表格、特殊HTML块可能解析异常。先把readme简化成一段纯文本,重新生成看看主页是否正常显示,排查语法问题。
- 检查输入排除规则:在输入选项卡里,确认
EXCLUDE或EXCLUDE_PATTERNS没有把readme.md排除在外。另外,INPUT配置里要包含readme所在的目录,或者直接把readme.md加到INPUT列表里(比如INPUT = ./src ./readme.md)。 - 排查主页设置冲突:如果代码里用了
\mainpage命令,会直接覆盖USE_MDFILE_AS_MAINPAGE的设置,导致MD文件无法成为主页。另外,MAINPAGE_TITLE如果设置了无效值,也可能引发显示异常。 - 清理缓存重生成:Doxygen生成的临时缓存(比如html、xml目录里的旧文件)可能导致异常,删除这些目录后重新运行Doxygen生成文档。
- 查看运行日志:运行Doxygen时留意控制台输出的日志,有没有关于readme.md的警告信息,比如“文件未找到”“语法错误”,这些提示能直接定位问题根源。
内容的提问来源于stack exchange,提问作者Dominykas
相关产品推荐
相关产品推荐

