如何从c ++项目生成markdown文档？

Question

我正在尝试为复杂的c ++项目创建文档。

为此，我开始使用Doxygen，这适合我的使用，因为我只需要评论我的项目的标题，以获得HTML的完整文档。这个文档完美地工作，并具有良好的风格。

但这是我的问题我想在Markdown文件中获取此文档，以便能够在Gitlab上推送它。

我尝试使用moxygen将xml文件转换为md文件。它工作但不如我想要的那样正确：由moxygen自动生成的锚点不起作用。该演示文稿也是一个问题，例如它将定义列表放在文件的顶部，该列表非常长并且在文档中不是最有用的。

我想知道是否有办法将我的代码记录为使用Doxygen，但获得正确的降价文件（锚点工作和更好的模板）。

我知道markdown语法很简单，但我不能自己编写整个markdown，因为项目很大并且会经常更新所以我需要一个通用方法来从C ++项目中获取markdown文档。

Answer 1

前段时间我遇到了类似的问题，并不容易解决。基本上我所做的是将文档转换为LaTeX，并从那里转换为markdown。检查this到LaTeX-＆gt; Markdown段落（其他工具也存在）。

你可以在某些时候使用make / latexmke自动化这个过程，但我个人无法简化这个过程，我仍然需要介入。另请注意，您可能需要使用其他工具（如flex）将LaTeX文档制作成一个大的tex文件。某些转换程序不接受拆分tex文件。

这并不完美，但它可能会给你另一个角度。希望它有所帮助。