Doxygen Tips
Including Markdown Files
To include a Markdown file within the \mainpage section of the output, add
the path to the file in the EXAMPLE_PATH configuration attribute,
e.g. EXAMPLE_PATH = ../../README.md. If necessary, addd *.md to
EXAMPLE_PATTERNS.
To split the included file text onto a separate page and reference it:
/**
* See the project \ref page2 "README" ...
*
* \page page2 README
*
* \include{doc} README.md
*/
You may see a warning warning: expected whitespace after \include command,
but that seems to be a Doxygen bug.
Summary of Configuration Changes from the Defaults
$ doxygen -x
Emacs Doxygen Mode
There's a simple doxymin package on MELPA.
-- Frank Dean - 24 Dec 2025
Related Topics: CreatingDocuments, DocumentFormats, EmacsTips, LaTeX, Markdown, PanDoc