Markdown 将README.md文件用作Doxygen中的主页

Doxygen的文档声明，我可以在标记文件中使用PHP标记额外的标题标签，但两者都不能

# Main Page # {#mainpage}

也不是

工作正常，但标签也不会以纯文本形式出现在输出中。顺便说一句，这是第一条线

此外，我不能引用该页，也不能使用上述标签，也不能使用文件名

我还有一个

main.dox

文件，其中包含一个

\mainpage

特殊命令，但我也尝试了上述所有方法，删除了前面的一个斜杠（使其仅为两个）

我正在使用Doxygen 1.8.2（已下载）和1.8.1.1（来自MacPorts）执行此任务

我怎样才能做到这一点呢

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

---

编辑：我已启用标记支持，文件将显示在引用页面中。

请尝试以下操作，将标题标记为级别1标题：

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

对于doxygen 1.8.2，这使页面成为我的

index.html

页面

---

doxygen文档确实指出，以单个

#

开头的行声明了一个级别1头，但它似乎也不适用于我

在doxygen的下一个版本（1.8.3）中，我计划引入一个新的配置选项

USE_MDFILE_AS_MAINPAGE

，该选项可用于指定要用作主页的标记页。 然后您可以按如下方式配置doxygen：

INPUT                  = README.md other_sources
USE_MDFILE_AS_MAINPAGE = README.md

---

无论页面的标题如何，它都能正常工作。

我遇到了一些类似的问题。。。我想在主页上包含我的

README.md

，但我还没有弄清楚这是否可行。我也很难在我的doxygen配置中包含README.md。只是根本不工作，当然，使用doxygen 1.8和使用_markdown。据我所知，doxygen（我使用的是1.8.5）只是忽略了第一行上的内容。因此，我的“mainpage.md”以（注意，这是两行；不能有多行注释？

#吃我的短裤，Doxygen！此标题行被忽略\n#TripWarp:Indians

不完整，然后我得到了我想要的顶级标题。如果你去掉你的

#吃我的短裤…

，但在那里留下新行，比如

\n#TripWarp:…

？（只是虚张声势）这个对我不起作用。这是我第一次尝试。您的doxyfile是如何配置的？@AdamL.S。让我们从以下内容开始：

MARKDOWN\u SUPPORT=YES

。您是否启用了此功能？我看不出有任何其他相关设置，但我可能错了。很抱歉，我没有收到有关此评论的任何通知，因此延迟响应。@AdamL.S。好吧，那么我想你的设置和思维之间唯一的区别可能是我明确地设置了以下内容：

FILE\u PATTERNS=*。markdown

我认为这不会有任何区别，但是试试看。如果我没记错的话，默认情况下，

*.md

和

*.markdown

都是在最新版本的

文件模式中设置的（至少使用doxywizard），当然，您也需要设置它们才能使其工作。这是正确的，但对我来说，doxygen 1.8.2忽略了
*.md
和
*.markdown
，所以我试着显式地把它放入
文件模式中，效果很好。这将是一份非常棒的圣诞礼物我不喜欢编译预发布版，因为它们更容易被破坏，但是如果你这么快发布它（与我的开发速度相比），我甚至不值得等待发布。但是，如果我需要它更快，那么我将编译它我希望我能接受两个答案。这个功能现在运行良好（1.8.3），只是.md文件的名称显示在树视图中。知道为什么会这样吗？这种方法在1.8.5上对我不起作用。有什么想法吗？这对我来说很有效（doxygen 1.8.13），但是我不得不将
README.md
文件作为输入列表中的第一个条目。即使它是第一个（也是唯一的）
.md
文件，如果它不是第一个条目，它将生成一个“相关页面”部分，而不是替换主页。确保您没有排除您希望使用的
README.md
，并使用
/README.md
（或其他相对路径），而不仅仅是
README.md
。
INPUT                  = README.md other_sources
USE_MDFILE_AS_MAINPAGE = README.md