使用 README.md 文件作为 Doxygen 的主页答案

【问题标题】：Use the README.md file as main page in Doxygen使用 README.md 文件作为 Doxygen 的主页
【发布时间】：2012-11-02 07:56:33
【问题描述】：

Doxygen 的文档指出，我可以在 markdown 文件中使用 PHP Markdown Extra 标题标签，但两者都不能

# Main Page # {#mainpage}

也没有

# Main Page # {#index}

有效，但标签也不以纯文本形式出现在输出中。顺便说一句，这是第一行。

我也不能用上面的标签引用那个页面，也不能用文件名。

我还有一个 main.dox 文件，其中包含一个 \mainpage 特殊命令，但我也尝试了上述所有方法，删除了它们前面的一个斜杠（使其只有两个）。

我正在使用 Doxygen 1.8.2（下载）和 1.8.1.1（来自 MacPorts）来完成任务。

那我该如何实现呢？

另外，如何将 Markdown 文件标记为特定语言的一部分？

编辑：我已启用降价支持，文件出现在引用的页面中。

【问题讨论】：

我遇到了一些类似的问题...我希望将我的README.md包含放在我的主页上，但我还没想清楚是否可行。
我也很难将 README.md 包含到我的 doxygen 配置中。只是根本不工作，当然还有 doxygen 1.8 和 use_markdown。
据我所知，doxygen（我使用的是 1.8.5）只会忽略你放在第一行的任何内容。所以我的“mainpage.md”以（注意这是两行；你不能有多行 cmets？）# Eat my shorts, Doxygen! This header line is ignored!\n # TripWarp: Detergent Motives Incomplete With Indians 开头，然后我得到了我想要的顶级标题。
如果您删除 # Eat my shorts… 但在其中留下一个换行符，例如 \n # TripWrap:…，会发生这种情况吗？（只是虚张声势。）

【解决方案1】：

在 doxygen (1.8.3) 的下一个版本中，我计划引入一个新的配置选项USE_MDFILE_AS_MAINPAGE，可用于指定要用作主页的降价页面。然后可以如下配置doxygen：

INPUT                  = README.md other_sources
USE_MDFILE_AS_MAINPAGE = README.md

无论页面的标题如何，它都会起作用。

【讨论】：

这将是一份美妙的圣诞礼物。 ;) 我不喜欢编译预发布版本，因为它们更有可能被破坏，但是如果你这么快就发布它（与我开发的速度相比），我甚至可能值得等待发布。但如果我更早需要它，那么我会编译它。 -- 我希望我能接受两个答案。
这个功能现在运行良好 (1.8.3)，除了 .md 文件的名称显示在树视图中。知道为什么会这样吗？
这个方法在 1.8.5 上对我不起作用。有什么想法吗？
这对我有用（doxygen 1.8.13）但是我必须将README.md 文件作为我输入列表中的第一个条目。即使它是第一个（也是唯一的）.md 文件，如果它不是第一个条目，它也会生成一个“相关页面”部分，而不是替换主页。
确保您没有排除您希望使用的README.md，并使用./README.md（或其他相对路径）而不仅仅是README.md。

【解决方案2】：

尝试以下方法将标题标记为 1 级标题：

Main Page {#mainpage}
=========

使用 doxygen 1.8.2，这使页面成为我的 index.html 页面。

doxygen 文档确实声明以单个 # 开头的行声明了 1 级标题，但它似乎也不适用于我。

【讨论】：

这个对我不起作用。这是我的第一次尝试。你的 doxyfile 是如何配置的？
@AdamL.S.让我们从：MARKDOWN_SUPPORT = YES 开始。你有这个启用吗？我没有看到任何其他设置相关，但我可能错了。抱歉，我没有收到有关此评论的任何通知，因此延迟回复。
@AdamL.S.好吧，那么我想您的设置和头脑之间的唯一其他区别可能是我明确设置了以下内容：FILE_PATTERNS = *.markdown 我认为它不应该有任何区别，但请尝试一下。
如果我没记错的话，*.md 和 *.markdown 在最新版本中默认设置为 FILE_PATTERNS，（至少使用 doxywizard）当然，你需要设置它们以使其正常工作。
没错，但对我来说，doxygen 1.8.2 忽略了*.md 和*.markdown，所以我尝试明确输入FILE_PATTERNS，并且它起作用了。