fix: Add header to HTMLs req'd by pkgdown (#29)

cicdguy · web-flow · commit 9b627ba9e360 · 2025-01-09T09:14:57.000-06:00
`pkgdown` generated files rely on `&lt;!-- Generated by pkgdown` being
available in the second line of each HTML doc, otherwise they get
skipped with this message: `Skipping '&lt;whatever&gt;': not generated by
pkgdown`

This adds the required 2 lines on top to ensure that the files are
regerenated.

---------

Co-authored-by: cicdguy &lt;cicdguy@users.noreply.github.com&gt;
diff --git a/core.py b/core.py
@@ -296,9 +296,13 @@ def process_single_html_file(file_path, dropdown_list):
         print(f"❌ {file_path}", file=sys.stderr)
         return False
 
-    modified_html = etree.tostring(
+    doctype = "<!DOCTYPE html>\n"
+    comment = "<!-- Generated by pkgdown + https://github.com/insightsengineering/r-pkgdown-multiversion -->\n"
+    html_content = etree.tostring(
         tree, encoding="unicode", pretty_print=True, method="html"
     )
+    modified_html = doctype + comment + html_content
+
     if not write_file(file_path, modified_html):
         return False
 
