How to embedd HTML page under one menu item

[mpusz]

Hi,

I would like to "paste" a HTML page under one position in the MkDocs menu (e.g. Doxygen generated docs). Still, it should have my theme header and footer. I tried with the template approach like the main page in your documentation, but I was not able to provide the entire HTML file this way (including all the stylesheets). What is the easiest way to embed such externally provided HTML in the generated docs?

[alexvoss]

Hi, can you describe a bit more what you tried and what did not work? It should be possible to include any HTML and any CSS. Whether the styling or interactivity provided by another tool can be made to work with that of Material for MkDocs is another question.

[mpusz]

@alexvoss, thanks for your answer.

To be precise, I would like this page https://mpusz.github.io/mp-units/latest/library_reference/core_library of my documentation to embed an HTML document similar to this one https://github.com/JohelEGP/jegp/blob/gh-pages/full.html (here is the rendering https://johelegp.github.io/jegp/full). I would like this page to be rendered only in the page contents part of the window, leaving the top, bottom, and sidebars with the default theme.

[alexvoss]

Right, I misunderstood about Doxygen. Does what I suggested solve your problem? If it is 'standardeese' then does the HTML change slowly and you can get away with hand-editing it or a with a bit of sed?

Either way, I am going to shamelessly make use of the fact that I have your attention and ask you if you think that there should be something like Breathe for (Material for) MkDocs? (I have not come across something like it, but have not exhaustively researched)

Breathe provides a bridge between the Sphinx and Doxygen documentation systems. It is an easy way to include Doxygen information in a set of documentation generated by Sphinx. The aim is to produce an autodoc like support for people who enjoy using Sphinx but work with languages other than Python. The system relies on the Doxygen’s xml output.

Doxygen makes it easy to write this because of the XML output. I am over 50, so comfortable with the idea of using this ;o)

[mpusz]

I was using Sphinx + Breathe + Doxygen for a few years for my project, but it never worked for me as those still did not understand C++20 syntax and were reporting a huge number of parsing issues. This is why I prefer to write the docs by hand. At least for a modern C++ project.

[mpusz]

In our solution, we will write the API reference part by hand and will not depend on the tool to parse it. The output is an HTML with a specific style, and I am still looking for the best way to present it as a subpage of mkdocs. Your solution is enough to obtain the contents, but it does not present proper styles for it.

[mpusz]

I am over 50, so comfortable with the idea of using this

Yeah, I am 45 so I somehow know what you mean 😉

[squidfunk]

There's also MkDoxy

[JohelEGP]

Try HTML5's <embed>.
At https://www.w3schools.com/tags/tag_embed.asp, there's an

Example
An embedded HTML page:

I also remember HTML4 having something similar.

[kamilkrzyskow]

You probably mean the iframe tag which seems to be targeted for embedding websites. However, this doesn't seem to be the solution here as the OP asked for the style to be synced 🤔

Edit: Actually wait, OP only wants the header and footer to stay the same, not convert the style, so perhaps you're onto something.