creates documentation and search a corpus of HTML pages

[Roh-codeur]

hi there, this is an excellent project. I have a corpus of HTML pages. I would like to:

1. Create documentation from those. the pages are already linked to each other using HTML links.
2. Search within those HTML pages

ta!

[alexvoss]

I can only speak to (1). It is possible to use HTML in Markdown and certainly also possible to pull extra HTML into pages once they are rendered via an MkDocs hook and, say, Beautifulsoup. The latter is perhaps not ideal because it involves parsing the output of Python Markdown back into a data structure in order to modify it. Won't make for the fastest build.

What approach is workable will depend more on whether you want to be able to change the HTML you are importing and how many pages we are talking about. You'd also need to take care to make them appear at the locations that are expected by the links. There is a template redirect.html that you can perhaps use where that is not feasible.

As to the search (2), be aware that there is a major re-write underway at the moment that may well give you what you need, see here: #6490

[squidfunk]

We're actively working in improving search in #6307, and indexing HTML content alongside Markdown is on our todo list.

[Roh-codeur]

thanks for the response guys! I already have a list of set of HTML pages from my earlier website. they are all linked etc. I want to be able to upload them, run them as a website. searching these would be a key part.

so, I understand, there is work underway to support this functionality. I will hang tight

ta!

[squidfunk]

Yes, we're working on it. Note that this sounds more like that you only want the search capabilities without Material for MkDocs, because you already have HTML pages. The new search will eventually also be Open Sourced, but this might still take some time.

[Roh-codeur]

correct! I am mostly looking for the search capability. I really like how the search works. eventually, I might even expand the website to include additional pages. happy to wait, good things come to those who do :)

ta!