Elektra
0.8.14
|
The Markdown link Converter, which filters markdown pages before the processing of doxygen, converts the links in markdown pages. It is set up as input filter in doxygen, if a markdown file is desired to be in the API documentation it only must have the extension .md
and be in the INPUT
path.
The Markdown link Converter gives each markdown file a header { #header }
which is attached to a title and converts the links to refer to this headers. This conversion happens in 2 passes, which is needed because there can be files with no title.
markdownlinkconverter [<cmake-cache-file>] <input-file>
The <input-file> parameter must be an absolute path!
@ref
, #
for anchors and http
for extern links wont be touched./
at the end of a link. This feature was introduced to be compatible with github, where you can show the content of a folder in combination with the README.md of the containing folder. Links ending with /
will be changed to /README.md
.