Markdown Output

[BroDudeGuyMan]

I love this tool, its super nice to use. The only problem is that I can't figure out a way to make Doxide output plain md without the themes or HTML. Is it possible to configure Doxide to only output md and not have the themes or web-oriented parts?

edit: I'm using this for a personal project on GitHub and the docs have really strange text in them from the generator when viewed on the web.

[lawmurray]

I'm using this for a personal project on GitHub and the docs have really strange text in them from the generator when viewed on the web.

Is it possible to share a link to show what you mean? My guess is the strange text is either icons (e.g. :material-code-tags:) or admonitions (!!! function), both of which are Markdown extensions from Material for MkDocs (the static site generator to which Doxide has gravitated mostly), and won't be shown as intended on GitHub. But if you could post an example of what you mean, that would help.

Generally, there are no features to control the Markdown output at the moment, although I'd be happy to accept contributions along these lines. That might include, for example, command-line options that disable those particular features of Markdown (--disable-icons to not output the icons, --disable-admonitions to use ## Headings instead of !!! admonitions). Perhaps even "higher level" options that enable/disable an appropriate set of these for different Markdown flavours (e.g. --markdown-flavor=github).

Check out the MarkdownGenerator.hpp and MarkdownGenerator.cpp files to get a sense of how the Markdown is generated. It would really just involve updating the generate function. Other relevant files are doxide.cpp to add the command-line options, and Driver.cpp to pass the relevant options to the Markdown generator.

Alternatively, maybe you're referring to some of the CSS and Javascript files that are created when you do doxide init? They can just be deleted if you want. Or, if it's useful, an option added to doxide init to not create them in the first place.

[BroDudeGuyMan]

Yeah, the icons and admonitions. Right now my workflow is Doxygen and then Moxygen from there, but Doxide makes it way simpler. The only problem is those specialized tags that I can't seem to omit from the build.

[BroDudeGuyMan]

I forked the repo, is PlainMarkdownGenerator a good name for the modified generator files?

[BroDudeGuyMan]

I have added the new function and sub-command here https://github.com/BroDudeGuyMan/doxide/tree/feature-plain-md-generator. It uses Unicode characters instead of icons, and sticks to standard Markdown syntax. The docs have no dependencies outside of themselves. Does this look like it's going in the right direction?