Generating Navigation around existing HTML?

[eXpl0it3r]

For SFML, we are currently integrating the generated doxygen documentation as plain HTML. To achieve this, I've manually extracted the header and footer from MkDocs and pass that HTML to doxygen, so doxygen can put the header and footer in the same style as the rest of the MkDocs page.

This is of course absolutely a terrible idea, because any changes to MkDocs requires updating the header a footer, that's 500-1000 files that need to be touched/regenerated every time.

So far I've tried all the doxygen plugins out there and none of them allowed me to just reuse the doxygen navigation, while also wrapping around it the MkDocs navigation. They either do a full on navigation integration or have some requirements on where the source code is located to generate the doxygen.

I'm aware that what I want goes a bit against the idea of static site generators, but since we host all the old doc versions, I can't/don't want to check out 17 different versions of the source code to generate the docs while generating the website.

So here's my question, is there a way to either:

• Integrate/wrap HTML content, i.e. the navigation is generated around existing HTML content (without iframe)?
• Or some way to templatify the doxygen output, so it can be easily integrated/filled by MkDocs?

To repeat, the goal is to generate the doxygen output once, check that into source control, and when updating the navigation or CSS/JS of MkDocs the documentation page is successfully updated.

Does anyone have any ideas how to achieve that?

Example site: https://www.sfml-dev.org/documentation/3.0.1/
Manually extracted HTML header & footer: https://github.com/SFML/SFML-Website/blob/master/documentation/priv/doxyheader-3.0.1.html
Generated doxygen HTML page: https://github.com/SFML/SFML-Website/blob/master/pages/documentation/3.0.1/index.html
Example commit that needs to manually update all files for the new style: SFML/SFML-Website@6710169

[kamilkrzyskow]

Hi @eXpl0it3r,
have you maybe tried to generate doxygen as HTML files with only body HTML tag, and include them as Markdown files? So other way around than what you're doing now. Generate the doxygen and somehow input into the MkDocs page, instead of generating the MkDocs page and modifying doxygen to make it look like MkDocs 😵

This way MkDocs can use them as internal Pages? MkDocs will handle the navigation header part. I'm assuming that doxygen docs can be set to have internal link relative to other files that are compatible with MkDocs 🤔

Related discussion:

• Integrating already made html files into a mkdocs site mkdocs/mkdocs#3944

I'm unsure about the best course of action to limit the amount of work, as I see it being an issue that there is already 17 versioned branches that each needs a single fix to not redo the whole process again 🤔

[eXpl0it3r]

This sounds quite interesting! I hadn‘t thought about the inline HTML support via Markdown. I‘ll give this a try and report back. Thank you!