如何将 Markdown 文件指定为 Doxygen 中的另一个选项卡?
How do I specify a Markdown file as another tab in Doxygen?
考虑一个包含以下两个文件的项目。请注意 OtherTab.md
位于子目录中。
README.md
# This is the main page.
Main Page contents.
wiki/OtherTab.md
# This is another tab
Contents for another tab.
现在,我运行Doxygen -g
生成一个Doxyfile
。我将以下行添加到 Doxyfile
.
USE_MDFILE_AS_MAINPAGE = README.md
INPUT = . wiki
我想在 Main Page
选项卡旁边添加一个名为 Wiki
的选项卡,它指向文件 wiki/OtherTab.md
.
我该如何完成?
我看过 this question, and this documentation,但都没有解决如何在 Doxygen 中实际创建新选项卡并将其指向通过处理特定 Markdown 文件生成的 html 的问题。
此外,我曾尝试在我之前的问题中使用 ,但不确定要在 tab
标签的 url
属性中放入什么。
进行了一些实验,似乎有一个标准转换应用于 Markdown 文件的名称。
因此,以下步骤将创建一个指向 Markdown 文件的新选项卡。
- 使用
doxygen -l
生成布局文件。
- 在 Doxyfile 中设置
LAYOUT_FILE = DoxygenLayout.xml
。
在 DoxygenLayout.xml
文件中,添加以下选项卡。
<tab type="user" visible="yes" url="md_wiki_OtherTab.html" title="Wiki"/>
标准文件名转换是md_{path_to_markdown_without_extension}.html
。
考虑一个包含以下两个文件的项目。请注意 OtherTab.md
位于子目录中。
README.md
# This is the main page.
Main Page contents.
wiki/OtherTab.md
# This is another tab
Contents for another tab.
现在,我运行Doxygen -g
生成一个Doxyfile
。我将以下行添加到 Doxyfile
.
USE_MDFILE_AS_MAINPAGE = README.md
INPUT = . wiki
我想在 Main Page
选项卡旁边添加一个名为 Wiki
的选项卡,它指向文件 wiki/OtherTab.md
.
我该如何完成?
我看过 this question, and this documentation,但都没有解决如何在 Doxygen 中实际创建新选项卡并将其指向通过处理特定 Markdown 文件生成的 html 的问题。
此外,我曾尝试在我之前的问题中使用 tab
标签的 url
属性中放入什么。
进行了一些实验,似乎有一个标准转换应用于 Markdown 文件的名称。
因此,以下步骤将创建一个指向 Markdown 文件的新选项卡。
- 使用
doxygen -l
生成布局文件。 - 在 Doxyfile 中设置
LAYOUT_FILE = DoxygenLayout.xml
。 在
DoxygenLayout.xml
文件中,添加以下选项卡。<tab type="user" visible="yes" url="md_wiki_OtherTab.html" title="Wiki"/>
标准文件名转换是md_{path_to_markdown_without_extension}.html
。