使用README.md文件作为Doxygen的主页 [英] Use the README.md file as main page in Doxygen

问题描述

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

The documentation of Doxygen states, that I can use PHP Markdown Extra title labelling in a markdown file, but neither

# Main Page # {#mainpage}

也

# Main Page # {#index}

有效，但是标签也不以纯文本形式出现在输出中.这是BTW的第一行.

works, but the label is not present in the output as plain text either. This is the very first line BTW.

我也无法使用以上标签或文件名来引用该页面.

Also I cannot reference to that page neither with the above labels, neither with the name of the file.

我也有一个main.dox文件，其中包含一个\mainpage特殊命令，但是我也尝试了上述所有方法，在它们之前都删除了一个斜杠(使其仅变两个).

I also have a main.dox file that contains a \mainpage special command, but I also tried all the above with removing one slash before them (to make it only two).

我正在使用Doxygen 1.8.2(已下载)和1.8.1.1(从MacPorts)来完成任务.

I'm using Doxygen 1.8.2 (downloaded) and 1.8.1.1 (from MacPorts) for the task.

那我该如何实现呢?

此外，我如何将markdown文件标记为特定语言的一部分?

Also, how can I mark a markdown file as part of a specific language?

编辑:我已启用降价支持，并且该文件显示在引用的页面中.

i have enabled markdown support, and the file appears in the referenced pages.

推荐答案

在下一版本的doxygen(1.8.3)中，我计划引入一个新的配置选项USE_MDFILE_AS_MAINPAGE，该选项可用于指定降价页面，即用作主页. 然后，您可以按以下方式配置doxygen:

In the next release of doxygen (1.8.3) I plan to introduce a new configuration option USE_MDFILE_AS_MAINPAGE which can be used to specify a markdown page that is to be used as the main page. Then you can configure doxygen as follows:

INPUT                  = README.md other_sources
USE_MDFILE_AS_MAINPAGE = README.md

，无论页面标题如何，它都可以工作.

and it will work regardless of page's headings.

这篇关于使用README.md文件作为Doxygen的主页的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！