【问题标题】:How do I specify a Markdown file as another tab in Doxygen?如何将 Markdown 文件指定为 Doxygen 中的另一个选项卡?
【发布时间】:2017-05-01 17:22:21
【问题描述】:

考虑一个包含以下两个文件的项目。请注意,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 questionthis documentation,但都没有解决如何在 Doxygen 中实际创建一个新选项卡并将其指向通过处理特定 Markdown 文件生成的 html 的问题。

此外,我曾尝试在上一个问题中使用this answer,但不确定在tab 标记的url 属性中添加什么。

【问题讨论】:

    标签: documentation markdown doxygen documentation-generation


    【解决方案1】:

    进行了一些实验,似乎有一个标准转换应用于 Markdown 文件的名称。

    因此,以下步骤将创建一个指向 Markdown 文件的新选项卡。

    1. 使用doxygen -l 生成布局文件。
    2. 在 Doxyfile 集中 LAYOUT_FILE = DoxygenLayout.xml
    3. DoxygenLayout.xml 文件中,添加以下选项卡。

      <tab type="user" visible="yes" url="md_wiki_OtherTab.html"  title="Wiki"/>
      

    标准文件名转换为md_{path_to_markdown_without_extension}.html

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 2011-02-11
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 2011-10-24
      • 1970-01-01
      • 2021-05-20
      • 2020-11-06
      相关资源
      最近更新 更多