hdoc-tools 0.19.8 → 0.20.0

package/hdoc-build.js

@@ -1,1505 +1,1480 @@
-(function () {
-  "use strict";
-
-  const crypto = require("crypto"),
-    dree = require("dree"),
-    fs = require("fs-extra"),
-    mdfm = require("markdown-it-front-matter"),
-    path = require("path"),
-    puppeteer = require("puppeteer"),
-    URL = require("url").URL,
-    hdoc_validate = require(path.join(__dirname, "hdoc-validate.js")),
-    hdoc = require(path.join(__dirname, "hdoc-module.js")),
-    hdoc_build_db = require(path.join(__dirname, "hdoc-build-db.js")),
-    hdoc_build_pdf = require(path.join(__dirname, "hdoc-build-pdf.js")),
-    hdoc_index = require(path.join(__dirname, "hdoc-db.js")),
-    archiver = require("archiver"),
-    xmlFormat = require("xml-formatter");
-
-  const h_tags_to_search = ["h1", "h2", "h3"],
-    image_extensions = [ 'png', 'svg', 'jpg' ],
-    doc_header_template_path = path.join(
-      __dirname,
-      "templates",
-      "doc-header.html"
-    ),
-    non_git_doc_header_template_path = path.join(
-      __dirname,
-      "templates",
-      "doc-header-non-git.html"
-    ),
-    pdf_header_template_path = path.join(
-      __dirname,
-      "templates",
-      "pdf-header.html"
-    ),
-    non_git_pdf_header_template_path = path.join(
-      __dirname,
-      "templates",
-      "pdf-header-non-git.html"
-    ),
-    pdf_template_path = path.join(__dirname, "templates", "pdf"),
-    ui_css_path = path.join(__dirname, "ui", "css"),
-    pdf_template_file_path = path.join(pdf_template_path, "template.html"),
-    regex_version = /^[0-9]{1,3}[.][0-9]{1,3}[.][0-9]{1,6}$/,
-    h1_pattern = /(<h1.*?>)\s*.*\s*(.*<\/h1>)/,
-    regex_filename = /^[a-z]+-{0,1}([-a-z0-9]+)*$/;
-
-  let bc = {}, // Breadcrumbs map
-    built_file_hashes = [],
-    book_read_time = 0,
-    browser = {},
-    conversion_attempted = 0,
-    conversion_success = 0,
-    conversion_failed = 0,
-    css_templates = [],
-    doc_header_template = "",
-    doc_header_template_non_git = "",
-    errors_filename = [],
-    global_source_path = "",
-    pdf_created = 0,
-    pdf_enable = false,
-    pdf_header_template = "",
-    pdf_header_template_non_git = "",
-    pdf_template = "",
-    prod_families = {},
-    prods_supported = [],
-    doc_id = "",
-    git_token =
-      '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', // Github fine-grained personal access token that has minimum read-only access to Hornbill Docs metadata
-    hdocbook_config = {},
-    hdocbook_project,
-    includes_found = 0,
-    includes_success = 0,
-    includes_failed = 0,
-    index_records = [],
-    md_files = [],
-    md_files_delete = [],
-    redirects = {},
-    static_html_files = [],
-    work_path_content = "",
-    verbose = false;
-
-  const pdf_path_excluded = function (relative_path) {
-    if (
-      !hdocbook_project.pdfGeneration ||
-      hdocbook_project.pdfGeneration.exclude_paths === undefined
-    ) {
-      return false;
-    }
-    if (relative_path.startsWith("/")) {
-      relative_path = relative_path.slice(1, relative_path.length);
-    }
-    for (
-      let i = 0;
-      i < hdocbook_project.pdfGeneration.exclude_paths.length;
-      i++
-    ) {
-      const exclude_path = hdocbook_project.pdfGeneration.exclude_paths[i];
-      if (relative_path === exclude_path) return true;
-      if (exclude_path.at(-1) === "*") {
-        if (relative_path.startsWith(exclude_path.slice(0, -1))) {
-          return true;
-        }
-      }
-    }
-    return false;
-  };
-
-  const transform_static_html = async function (file_path) {
-    if (fs.existsSync(file_path.path)) {
-      // Load HTML file
-      let html_txt = fs.readFileSync(file_path.path, "utf8");
-      html_txt = html_txt.replace(/\r/gm, ""); // Remove CR's so we're just dealing with newlines
-
-      let fm_headers = [];
-      let existing_fm_headers = false;
-      let doc_type = "Article";
-      let doc_title = "";
-
-      // Check if we have a frontmatter comment
-      const fm_header = hdoc.getHTMLFrontmatterHeader(html_txt);
-      if (Object.keys(fm_header.fm_properties).length > 0) {
-        existing_fm_headers = true;
-
-        // We have some frontmatter headers, check if title is one of them
-        let fm_title_found = false;
-        if (
-          fm_header.fm_properties &&
-          fm_header.fm_properties.title !== undefined
-        ) {
-          // We have a title - but does the title have a value
-          if (fm_header.fm_properties.title === "") {
-            // No value - remove title from the properties map  so we don't end up with 2 title properties, one empty and one with a value
-            delete fm_header.fm_properties.title;
-          } else {
-            // We have a value for the title property
-            fm_title_found = true;
-            doc_title = fm_header.fm_properties.title.trim();
-          }
-        }
-
-        // Is reading-time in the fm headers?
-        if (fm_header.fm_properties["reading-time"] === undefined) {
-          const read_time_mins = hdoc.get_html_read_time(html_txt);
-          book_read_time += read_time_mins;
-          fm_header.fm_properties["reading-time"] = read_time_mins;
-        }
-
-        for (const key in fm_header.fm_properties) {
-          if (fm_header.fm_properties.hasOwnProperty(key)) {
-            if (key === "type") doc_type = fm_header.fm_properties[key];
-            else {
-              fm_headers.push({
-                id: key,
-                value: fm_header.fm_properties[key],
-              });
-            }
-          }
-        }
-
-        if (
-          !fm_title_found &&
-          file_path.name !== "description_ext.md" &&
-          file_path.name !== "article_ext.md"
-        ) {
-          // No frontmatter title found in properties
-          // Go get title from h tags in html
-          const html_heading = hdoc.getFirstHTMLHeading(
-            html_txt,
-            h_tags_to_search
-          );
-
-          if (
-            html_heading &&
-            html_heading[0] &&
-            html_heading[0].children &&
-            html_heading[0].children[0] &&
-            html_heading[0].children[0].data
-          ) {
-            // We've found a heading tag, add that as a title to the existing frontmatter properties
-            fm_headers.push({
-              id: "title",
-              value: html_heading[0].children[0].data,
-            });
-            doc_title = html_heading[0].children[0].data;
-          } else {
-            // No header tag, no frontmatter title, output a warning
-            console.info(
-              `[WARNING] No frontmatter title property, or ${h_tags_to_search.join(
-                ", "
-              )} tags detected in ${file_path.path}`
-            );
-          }
-        }
-
-        // Do we have a description header?
-        if (
-          fm_header.fm_properties &&
-          fm_header.fm_properties.description !== undefined
-        ) {
-          if (fm_header.fm_properties.description === "") {
-            const html_p_tag = hdoc.getFirstHTMLHeading(html_txt, ["p"]);
-            if (
-              html_p_tag &&
-              html_p_tag[0] &&
-              html_p_tag[0].children &&
-              html_p_tag[0].children[0] &&
-              html_p_tag[0].children[0].data
-            ) {
-              fm_headers.push({
-                id: "description",
-                value: `${doc_title}: ${
-                  html_p_tag[0].children[0].data.split(".")[0] + "."
-                }`.trim(),
-              });
-            }
-          } else {
-            fm_headers.push({
-              id: "description",
-              value: fm_header.fm_properties.description.trim(),
-            });
-          }
-        } else {
-          const html_p_tag = hdoc.getFirstHTMLHeading(html_txt, ["p"]);
-          if (
-            html_p_tag &&
-            html_p_tag[0] &&
-            html_p_tag[0].children &&
-            html_p_tag[0].children[0] &&
-            html_p_tag[0].children[0].data
-          ) {
-            fm_headers.push({
-              id: "description",
-              value: `${doc_title}: ${
-                html_p_tag[0].children[0].data.split(".")[0] + "."
-              }`.trim(),
-            });
-          }
-        }
-      } else {
-        // We have no frontmatter headers, get and build one from the html headings
-        const html_heading = hdoc.getFirstHTMLHeading(
-          html_txt,
-          h_tags_to_search
-        );
-        let doc_title = "";
-        // Add the title
-        if (
-          html_heading &&
-          html_heading[0] &&
-          html_heading[0].children &&
-          html_heading[0].children[0] &&
-          html_heading[0].children[0].data
-        ) {
-          // We've found a heading tag, add that as a title to the frontmatter content
-          fm_headers.push({
-            id: "title",
-            value: html_heading[0].children[0].data,
-          });
-          doc_title = html_heading[0].children[0].data;
-        } else if (
-          file_path.name !== "description_ext.md" &&
-          file_path.name !== "article_ext.md"
-        ) {
-          // No header tag, no frontmatter title, output a warning
-          console.info(
-            `[WARNING] No frontmatter title property, or ${h_tags_to_search.join(
-              ", "
-            )} tags detected in ${file_path.path}`
-          );
-        }
-
-        // Add the reading time
-        const read_time_mins = hdoc.get_html_read_time(html_txt);
-        book_read_time += read_time_mins;
-        fm_headers.push({
-          id: "reading-time",
-          value: read_time_mins,
-        });
-
-        const html_p_tag = hdoc.getFirstHTMLHeading(html_txt, ["p"]);
-        if (
-          html_p_tag &&
-          html_p_tag[0] &&
-          html_p_tag[0].children &&
-          html_p_tag[0].children[0] &&
-          html_p_tag[0].children[0].data
-        ) {
-          fm_headers.push({
-            id: "description",
-            value: `${doc_title}: ${
-              html_p_tag[0].children[0].data.split(".")[0] + "."
-            }`.trim(),
-          });
-        }
-      }
-
-      // Add doc type
-      fm_headers.push({
-        id: "type",
-        value: doc_type,
-      });
-
-      let metadata = {};
-
-      // Remove the first <h1>title</h1> from the HTML as we'll add that in the document header
-      let html_h1 = h1_pattern.exec(html_txt);
-      if (html_h1 && html_h1[0])
-        html_h1 = html_h1[0].replace(/(<h1.*?>)/, "").replace(/(<\/h1>)/, "");
-
-      html_txt = html_txt.replace(h1_pattern, "");
-
-      // Get contributor data from Github, if exists
-      let contribs = [];
-      let last_commit = null;
-      if (
-        hdocbook_config.publicSource &&
-        hdocbook_config.publicSource !== "" &&
-        hdocbook_config.publicSource.includes("github.com/Hornbill-Docs")
-      ) {
-        const github_paths = hdoc.get_github_api_path(
-          hdocbook_config.publicSource,
-          file_path.relativePath
-        );
-        const contributors = hdoc.get_github_contributors(
-          github_paths.api_path,
-          git_token
-        );
-
-        if (!contributors.success) {
-          console.error(
-            `Error retrieving contributors from Github: ${contributors.error}`
-          );
-        } else {
-          last_commit = contributors.last_commit_date;
-          metadata.last_commit = contributors.last_commit_date;
-          metadata.contributor_count = contributors.contributor_count;
-          metadata.edit_url = github_paths.edit_path;
-          contribs = contributors.contributors;
-          contributors.editPath = github_paths.edit_path;
-          fm_headers.push({
-            id: "contributor-count",
-            value: contributors.contributor_count,
-          });
-          fm_headers.push({
-            id: "last-commit",
-            value: contributors.last_commit_date,
-          });
-          const target_file = file_path.path.replace(
-            path.extname(file_path.path),
-            "._info.json"
-          );
-          delete contributors.success;
-          delete contributors.error;
-          contributors.editPath = github_paths.edit_path;
-        }
-        fm_headers.push({
-          id: "edit-path",
-          value: github_paths.edit_path,
-        });
-      }
-
-      if (pdf_enable && !pdf_path_excluded(file_path.relativePath)) {
-        fm_headers.push({
-          id: "pdf-path",
-          value: file_path.relativePath.replace(
-            path.extname(file_path.relativePath),
-            ".pdf"
-          ),
-        });
-      }
-
-      let fm_header_content = "<!--[[FRONTMATTER\n";
-      if (fm_headers.length > 0) {
-        for (let i = 0; i < fm_headers.length; i++) {
-          fm_header_content += `${fm_headers[i].id}: ${fm_headers[i].value}\n`;
-        }
-        fm_header_content += "]]-->";
-
-        if (existing_fm_headers) {
-          html_txt = html_txt.replace("<!--" + fm_header.fm_header + "-->", "");
-        }
-      }
-
-      let doc_header = "";
-      let pdf_header = "";
-      const inline_content = file_path.relativePath.startsWith(
-        `${hdocbook_config.docId}/_inline/`
-      );
-      if (
-        hdocbook_config.publicSource &&
-        hdocbook_config.publicSource.includes("github.com/Hornbill-Docs")
-      ) {
-        // Build doc header from template and frontmatter tags
-        if (!inline_content)
-          doc_header = process_doc_header(
-            fm_headers,
-            file_path.relativePath,
-            doc_header_template,
-            html_h1
-          );
-
-        if (pdf_enable && !pdf_path_excluded(file_path.relativePath))
-          pdf_header = process_doc_header(
-            fm_headers,
-            file_path.relativePath,
-            pdf_header_template,
-            html_h1
-          );
-      } else {
-        if (!inline_content)
-          doc_header = process_doc_header(
-            fm_headers,
-            file_path.relativePath,
-            doc_header_template_non_git,
-            html_h1
-          );
-
-        if (pdf_enable && !pdf_path_excluded(file_path.relativePath))
-          pdf_header = process_doc_header(
-            fm_headers,
-            file_path.relativePath,
-            pdf_header_template_non_git,
-            html_h1
-          );
-      }
-
-      let pdf_size = 0;
-      if (pdf_enable && !pdf_path_excluded(file_path.relativePath)) {
-        let pdf_txt = await hdoc_build_pdf.process_images(file_path, html_txt);
-        pdf_txt = `${pdf_header}\n${pdf_txt}`;
-
-        // Generate PDF file from HTML
-        const pdf_file_path = file_path.path.replace(
-          path.extname(file_path.path),
-          ".pdf"
-        );
-        pdf_size = await hdoc_build_pdf.generate_pdf(
-          browser,
-          pdf_template_path,
-          pdf_template,
-          hdocbook_config,
-          pdf_txt,
-          pdf_file_path,
-          css_templates,
-          verbose
-        );
-      }
-      if (pdf_size > 0) pdf_created++;
-
-      // Wrap h2 and h3 tags, plus content, in id'd divs
-      html_txt = hdoc.wrapHContent(html_txt);
-
-      if (inline_content) html_txt = `${fm_header_content}\n${html_txt}`;
-      else html_txt = `${fm_header_content}\n${doc_header}\n${html_txt}`;
-
-      let relative_path = file_path.relativePath;
-      if (
-        !bc[relative_path.replace(".html", "")] &&
-        bc[relative_path.replace("/index.html", "")]
-      ) {
-        relative_path = relative_path.replace("/index.html", "");
-      }
-
-      const index_data = hdoc_index.transform_html_for_index(html_txt);
-
-      index_data.sections.forEach(section => {
-        index_records.push({
-          relative_path: relative_path,
-          index_html: { fm_props: index_data.fm_props, text: section.text, preview: section.preview, id: section.id ? section.id : null},
-          metadata: metadata,
-          contributors: contribs,
-          pdf_size: pdf_size,
-          md5: file_path.hash,
-          lastmod: last_commit !== null ? last_commit : file_path.hb_lastmod,
-          inline: inline_content,
-        });
-      });
-
-      // Save HTML into HTML file
-      try {
-        fs.writeFileSync(file_path.path, html_txt);
-      } catch (err) {
-        console.error("Error writing:", target_file, "\n", err);
-      }
-    }
-  };
-
-  const transform_markdown_and_save_html = async function (file_path) {
-    conversion_attempted++;
-
-    if (fs.existsSync(file_path.path)) {
-      // Load markdown file
-      let md_txt = hdoc.expand_variables(
-        fs.readFileSync(file_path.path, "utf8")
-      );
-
-      // Pull in external includes
-      const includes_processed = await hdoc.process_includes(
-        file_path.path,
-        md_txt,
-        global_source_path
-      );
-      md_txt = includes_processed.body.toString();
-      includes_found += includes_processed.found;
-      includes_success += includes_processed.success;
-      includes_failed += includes_processed.failed;
-      if (includes_processed.errors.length > 0) {
-        for (let i = 0; i < includes_processed.errors.length; i++) {
-          console.error(includes_processed.errors[i]);
-        }
-      }
-
-      // One markdown parser per file. Seems wrong, but doesn't work with a global one once past the first md file
-      // Steve - revisit this
-      const md = require("markdown-it")({
-        html: true,
-        linkify: true,
-        typographer: true,
-      });
-      md.linkify.set({
-        fuzzyEmail: false,
-        fuzzyLink: false,
-        fuzzyIP: false,
-      });
-
-      // Process Frontmatter tags
-      let frontmatter_content = "";
-      md.use(mdfm, function (fm) {
-        frontmatter_content = fm;
-      });
-
-      // Process tips
-      const tips = require(__dirname + "/custom_modules/tips.js");
-      md.use(tips, {
-        links: true,
-      });
-
-      // Tidy up ```json and ```xml code tags
-
-      if (md_txt.includes("```json") || md_txt.includes("```xml"))
-        md_txt = tidy_code_tags(md_txt, file_path.relativePath);
-
-      // Render markdown into HTML
-      let html_txt = md.render(md_txt);
-
-      // Prepare frontmatter headers
-      let fm_headers = [];
-      let fm_content = frontmatter_content.split(/\r?\n/);
-
-      let fm_contains_title = false,
-        fm_contains_reading_time = false,
-        fm_contains_description = false,
-        doc_title = "",
-        doc_type = "Article";
-
-      if (fm_content.length >= 0) {
-        fm_content.forEach(function (fm_prop) {
-          const fm_id = fm_prop.slice(0, fm_prop.indexOf(":"));
-          const fm_val = fm_prop.slice(fm_prop.indexOf(":") + 1);
-
-          if (
-            fm_id &&
-            fm_id.trim().length > 0 &&
-            fm_val &&
-            fm_val.trim().length > 0
-          ) {
-            fm_headers.push({
-              id: fm_id.trim(),
-              value: fm_val.trim(),
-            });
-
-            if (fm_id.trim() === "title") {
-              fm_contains_title = true;
-              doc_title = fm_val.trim();
-            }
-            if (fm_id.trim() === "type") {
-              doc_type = fm_val.trim();
-            }
-            if (fm_id.trim() === "reading-time") {
-              book_read_time += parseInt(fm_val.trim(), 10);
-              fm_contains_reading_time = true;
-            }
-            if (fm_id.trim() === "description") {
-              fm_contains_description = true;
-            }
-          }
-        });
-      }
-
-      // Add doc type
-      fm_headers.push({
-        id: "type",
-        value: doc_type,
-      });
-
-      // Does frontmatter tag contain a title property
-      if (!fm_contains_title) {
-        // Frontmatter tags don't contain a title property - go pull the first one from the html heading tags
-        const html_heading = hdoc.getFirstHTMLHeading(
-          html_txt,
-          h_tags_to_search
-        );
-
-        if (
-          html_heading &&
-          html_heading[0] &&
-          html_heading[0].children &&
-          html_heading[0].children[0] &&
-          html_heading[0].children[0].data
-        ) {
-          // We've found a heading tag, add that as a title to the frontmatter content
-          fm_headers.push({
-            id: "title",
-            value: html_heading[0].children[0].data.trim(),
-          });
-          doc_title = html_heading[0].children[0].data.trim();
-        } else if (
-          file_path.name !== "description_ext.md" &&
-          file_path.name !== "article_ext.md"
-        ) {
-          // No header tag, no frontmatter title, output a warning
-          console.info(
-            `[WARNING] No frontmatter title property, or h1, h2 or h3 header tags detected in ${file_path.path}`
-          );
-        }
-      }
-
-      // Does frontmatter contain a description header, generate one if not
-      if (!fm_contains_description) {
-        const html_p_tag = hdoc.getFirstHTMLHeading(html_txt, ["p"]);
-        if (
-          html_p_tag &&
-          html_p_tag[0] &&
-          html_p_tag[0].children &&
-          html_p_tag[0].children[0] &&
-          html_p_tag[0].children[0].data
-        ) {
-          fm_headers.push({
-            id: "description",
-            value: `${doc_title}: ${
-              html_p_tag[0].children[0].data.split(".")[0] + "."
-            }`,
-          });
-        }
-      }
-
-      // Does frontmatter tag contain a reading-time property
-      if (!fm_contains_reading_time) {
-        const read_time_mins = hdoc.get_html_read_time(html_txt);
-        book_read_time += read_time_mins;
-        fm_headers.push({
-          id: "reading-time",
-          value: read_time_mins,
-        });
-      }
-      let metadata = {};
-
-      // Remove the first <h1>title</h1> from the HTML as we'll add that in the document header
-      let html_h1 = h1_pattern.exec(html_txt);
-      if (html_h1 && html_h1[0])
-        html_h1 = html_h1[0].replace(/(<h1.*?>)/, "").replace(/(<\/h1>)/, "");
-
-      html_txt = html_txt.replace(h1_pattern, "");
-
-      // Get contributor data from Github, if exists
-      let contribs = [];
-      let last_commit = null;
-      if (
-        hdocbook_config.publicSource &&
-        hdocbook_config.publicSource !== "" &&
-        hdocbook_config.publicSource.includes("github.com/Hornbill-Docs")
-      ) {
-        const github_paths = hdoc.get_github_api_path(
-          hdocbook_config.publicSource,
-          file_path.relativePath
-        );
-        const contributors = await hdoc.get_github_contributors(
-          github_paths.api_path,
-          git_token,
-          hdocbook_config.publicSource
-        );
-
-        if (!contributors.success) {
-          console.error(
-            `Error retrieving contributors from Github: ${contributors.error}`
-          );
-        } else {
-          last_commit = contributors.last_commit_date;
-          metadata.last_commit = contributors.last_commit_date;
-          metadata.contributor_count = contributors.contributor_count;
-          metadata.edit_url = github_paths.edit_path;
-          contribs = contributors.contributors;
-          contributors.editPath = github_paths.edit_path;
-
-          fm_headers.push({
-            id: "contributor-count",
-            value: contributors.contributor_count,
-          });
-          fm_headers.push({
-            id: "last-commit",
-            value: contributors.last_commit_date,
-          });
-          const target_file = file_path.path.replace(
-            path.extname(file_path.path),
-            "._info.json"
-          );
-          delete contributors.success;
-          delete contributors.error;
-          contributors.editPath = github_paths.edit_path;
-          try {
-            fs.writeFileSync(
-              target_file,
-              JSON.stringify(contributors, null, 2)
-            );
-          } catch (err) {
-            console.error("Error writing:", target_file, "\n", err);
-          }
-        }
-        fm_headers.push({
-          id: "edit-path",
-          value: github_paths.edit_path,
-        });
-      }
-
-      if (pdf_enable && !pdf_path_excluded(file_path.relativePath)) {
-        fm_headers.push({
-          id: "pdf-path",
-          value: file_path.relativePath.replace(
-            path.extname(file_path.relativePath),
-            ".pdf"
-          ),
-        });
-      }
-
-      // Add frontmatter tags as comment
-      let fm_header = "<!--[[FRONTMATTER\n";
-      if (fm_headers.length > 0) {
-        for (let i = 0; i < fm_headers.length; i++) {
-          fm_header += `${fm_headers[i].id}: ${fm_headers[i].value}\n`;
-        }
-      }
-      fm_header += "]]-->";
-
-      let doc_header = "";
-      let pdf_header = "";
-      const inline_content = file_path.relativePath.startsWith(
-        `${hdocbook_config.docId}/_inline/`
-      );
-      if (
-        hdocbook_config.publicSource &&
-        hdocbook_config.publicSource.includes("github.com/Hornbill-Docs")
-      ) {
-        // Build doc header from template and frontmatter tags
-        if (!inline_content)
-          doc_header = process_doc_header(
-            fm_headers,
-            file_path.relativePath,
-            doc_header_template,
-            html_h1
-          );
-
-        if (pdf_enable && !pdf_path_excluded(file_path.relativePath))
-          pdf_header = process_doc_header(
-            fm_headers,
-            file_path.relativePath,
-            pdf_header_template,
-            html_h1
-          );
-      } else {
-        // Build doc header from template and frontmatter tags
-        if (!inline_content)
-          doc_header = process_doc_header(
-            fm_headers,
-            file_path.relativePath,
-            doc_header_template_non_git,
-            html_h1
-          );
-
-        if (pdf_enable && !pdf_path_excluded(file_path.relativePath))
-          pdf_header = process_doc_header(
-            fm_headers,
-            file_path.relativePath,
-            pdf_header_template_non_git,
-            html_h1
-          );
-      }
-
-      let pdf_size = 0;
-      if (pdf_enable && !pdf_path_excluded(file_path.relativePath)) {
-        let pdf_txt = await hdoc_build_pdf.process_images(file_path, html_txt);
-        pdf_txt = `${pdf_header}\n${pdf_txt}`;
-
-        // Generate PDF file from HTML
-        const pdf_file_path = file_path.path.replace(
-          path.extname(file_path.path),
-          ".pdf"
-        );
-        pdf_size = await hdoc_build_pdf.generate_pdf(
-          browser,
-          pdf_template_path,
-          pdf_template,
-          hdocbook_config,
-          pdf_txt,
-          pdf_file_path,
-          css_templates,
-          verbose
-        );
-      }
-      if (pdf_size > 0) pdf_created++;
-
-      // Wrap h2 and h3 tags, plus content, in id'd divs
-      html_txt = hdoc.wrapHContent(html_txt);
-
-      if (inline_content) html_txt = `${fm_header}\n${html_txt}`;
-      else html_txt = `${fm_header}\n${doc_header}\n${html_txt}`;
-
-
-      // Save HTML into HTML file
-      const target_file = file_path.path.replace(
-        path.extname(file_path.path),
-        ".html"
-      );
-      let relative_path = file_path.relativePath.replace(
-        path.extname(file_path.path),
-        ".html"
-      );
-      try {
-        fs.writeFileSync(target_file, html_txt);
-      } catch (err) {
-        console.error("Error writing:", target_file, "\n", err);
-      }
-
-      if (
-        !bc[relative_path.replace(".html", "")] &&
-        bc[relative_path.replace("/index.html", "")]
-      ) {
-        relative_path = relative_path.replace("/index.html", "");
-      }
-
-      const index_data = hdoc_index.transform_html_for_index(html_txt);
-
-      index_data.sections.forEach(section => {
-        index_records.push({
-          relative_path: relative_path,
-          index_html: { fm_props: index_data.fm_props, text: section.text, preview: section.preview, id: section.id ? section.id : null},
-          metadata: metadata,
-          contributors: contribs,
-          pdf_size: pdf_size,
-          md5: file_path.hash,
-          lastmod: last_commit !== null ? last_commit : file_path.hb_lastmod,
-          inline: inline_content,
-        });
-      });
-
-      // Add MD file to delete queue
-      md_files_delete.push(file_path.path);
-
-      conversion_success++;
-      return true;
-    }
-    conversion_failed++;
-    console.error("MD file does not exist:", file_path.path);
-    return false;
-  };
-
-  const tidy_code_tags = function (markdown, file) {
-    const json_to_tidy = markdown.match(/```json[\r\n](\s|.)*?```/g);
-    if (json_to_tidy && json_to_tidy.length > 0) {
-      for (let i = 0; i < json_to_tidy.length; i++) {
-        if (json_to_tidy[i] !== "") {
-          let json_tidy = json_to_tidy[i]
-            .replace("```json", "")
-            .replace("```", "");
-          try {
-            json_tidy = JSON.stringify(JSON.parse(json_tidy), null, 2);
-          } catch (e) {
-            console.info(
-              `[WARNING] Could not tidy JSON in file [${file}]: ${e}`
-            );
-          }
-          markdown = markdown.replace(
-            json_to_tidy[i],
-            "```json\n" + json_tidy + "\n```"
-          );
-        }
-      }
-    }
-
-    const xml_to_tidy = markdown.match(/```xml[\r\n](\s|.)*?```/g);
-    if (xml_to_tidy && xml_to_tidy.length > 0) {
-      for (let i = 0; i < xml_to_tidy.length; i++) {
-        if (xml_to_tidy[i] !== "") {
-          const xml_tidy = xml_to_tidy[i]
-            .replace("```xml", "")
-            .replace("```", "");
-          let new_xml_string = xml_tidy;
-          try {
-            new_xml_string = xmlFormat(xml_tidy, {
-              indentation: "  ",
-              collapseContent: true,
-              lineSeparator: "\n",
-            });
-          } catch (e) {
-            console.info(`[WARNING] Could not tidy XML in file [${file}]: ${e}`);
-          }
-          markdown = markdown.replace(
-            xml_to_tidy[i],
-            "```xml\n" + new_xml_string + "\n```"
-          );
-        }
-      }
-    }
-    return markdown;
-  };
-
-  const process_doc_header = function (fm_headers, doc_path, template, h1) {
-    let wip_doc_header = template;
-    let used_h1 = false;
-    if (h1 && h1 !== "") {
-      wip_doc_header = wip_doc_header.replaceAll("{{title}}", h1);
-      used_h1 = true;
-    }
-    // Process fm_headers properties first
-    for (let i = 0; i < fm_headers.length; i++) {
-      switch (fm_headers[i].id) {
-        case "title":
-          if (!used_h1)
-            wip_doc_header = wip_doc_header.replaceAll(
-              "{{title}}",
-              fm_headers[i].value
-            );
-          break;
-        case "reading-time":
-          wip_doc_header = wip_doc_header.replaceAll(
-            "{{reading-time}}",
-            fm_headers[i].value
-          );
-          break;
-        case "contributor-count":
-          wip_doc_header = wip_doc_header.replaceAll(
-            "{{contributor-count}}",
-            fm_headers[i].value
-          );
-          break;
-        case "type":
-          wip_doc_header = wip_doc_header.replaceAll(
-            "{{doc-type}}",
-            fm_headers[i].value
-          );
-          break;
-        case "edit-path":
-          wip_doc_header = wip_doc_header.replaceAll(
-            "{{edit-url}}",
-            fm_headers[i].value
-          );
-          break;
-        case "last-commit":
-          let last_commit_date = fm_headers[i].value;
-          if (last_commit_date !== "No Commit Date Available") {
-            last_commit_date = new Date(fm_headers[i].value).toDateString();
-          }
-          wip_doc_header = wip_doc_header.replaceAll(
-            "{{last-update}}",
-            last_commit_date
-          );
-          break;
-      }
-    }
-
-    // Now sort out breadcrumbs
-    const logical_path = doc_path.replace(path.extname(doc_path), "");
-    const bc_for_path = bc[logical_path];
-    let bc_tags = "\n";
-    if (bc_for_path) {
-      for (let i = 0; i < bc_for_path.length - 1; i++) {
-        let bc_link = "/";
-        if (redirects[bc_for_path[i].link]) {
-          if (redirects[bc_for_path[i].link].location) {
-            bc_link += redirects[bc_for_path[i].link].location;
-          }
-        } else {
-          if (bc_for_path[i].link) {
-            bc_link = bc_for_path[i].link.startsWith("/")
-              ? bc_for_path[i].link
-              : `/${bc_for_path[i].link}`;
-          } else {
-            bc_link = "";
-          }
-        }
-        if (bc_link !== "") {
-          bc_tags += `\t\t\t\t<li class="mt-0 nav-bar-item"><a href="${bc_link}" class="ps-0 pe-0 text-decoration-none">${bc_for_path[i].text}</a></li>\n`;
-        } else {
-          bc_tags += `\t\t\t\t<li class="mt-0 nav-bar-item">${bc_for_path[i].text}</li>\n`;
-        }
-      }
-    } else {
-      if (verbose) {
-        console.info(
-          `[WARNING] Path is not present in navigation items: ${logical_path}`
-        );
-      }
-    }
-    bc_tags += "\t\t\t";
-    wip_doc_header = wip_doc_header.replaceAll("{{breadcrumbs}}", bc_tags);
-    return wip_doc_header;
-  };
-
-  // File callback for build scan
-  const build_file_callback = function (element) {
-    if (element.extension === "md") {
-      element.hb_source_path = path.join(
-        global_source_path,
-        element.relativePath
-      );
-      const fstats = fs.statSync(element.hb_source_path);
-      element.hb_lastmod = `${fstats.mtime.toISOString().slice(0, 19)}Z`;
-      md_files.push(element);
-    } else {
-      // File is html, see if there's a matching md file and if there is then ignore the html
-      const md_path = element.path.replace(path.extname(element.path), ".md");
-      if (fs.existsSync(md_path)) {
-        return;
-      }
-      element.hb_source_path = path.join(
-        global_source_path,
-        element.relativePath
-      );
-      const fstats = fs.statSync(element.hb_source_path);
-      element.hb_lastmod = `${fstats.mtime.toISOString().slice(0, 19)}Z`;
-      static_html_files.push(element);
-    }
-  };
-
-  // File & folder callback for MD5 hash of built content
-  const hash_callback = function (element) {
-    if (element.extension !== "db") {
-      built_file_hashes.push({
-        path: element.relativePath,
-        hash: element.hash,
-      });
-    }
-  };
-
-  // File scan callback for filename validation
-  const filename_validation_callback = function (element) {
-    if (element.relativePath.startsWith('_inline/')) return;
-    if (element.name.toLowerCase() === '.ds_store') return;
-    if (element.name === 'article_ext.md' || element.name === 'description_ext.md') return;
-    if (image_extensions.includes(element.extension)) return;
-    const file_no_ext = element.name.replace(`.${element.extension}`, '');
-    if (!file_no_ext.match(regex_filename)) errors_filename.push(element.relativePath);
-  };
-
-
-  const dreeOptions = {
-    hash: true,
-    extensions: ["md", "html", "htm"],
-    normalize: true,
-    stat: true,
-  };
-
-  const dreeOptionsAllFiles = {
-    descendants: true,
-    excludeEmptyDirectories: true,
-    hash: false,
-    normalize: true,
-    size: false,
-    sizeInBytes: false,
-    symbolicLinks: false,
-  };
-
-  const md5DreeOptions = {
-    hash: true,
-    normalize: true,
-    sorted: true,
-  };
-
-  exports.run = async function (
-    source_path,
-    verbose_output,
-    github_api_token,
-    validate,
-    gen_exclude,
-    build_version = ""
-  ) {
-    if (github_api_token !== "") {
-      git_token = github_api_token;
-    }
-    global_source_path = source_path;
-    verbose = verbose_output;
-
-    const start_time = Date.now();
-    // GERRY: The purpose of this function is to create a zip file containing the hdocbook content,
-    // * Create a _work folder
-    // * copy the hdocbook content to the work folder
-    // * Render all markdown into side-by-side HTML file
-    // * Replace SERVER_VARS embedded in documents with the right version information etc.
-    // * Build an index (sqlite FTS5) by extracting text from all HTML content in the work
-    //   folder, conceptually we are making a little mini website crawler to index all of the content
-    //   within the book.
-    // * Package everything up into a ZIP file, ready for the build controller to package and publish
-
-    console.log("Hornbill HDocBook Build", "\n");
-    console.log("  Document Path:", source_path, "\n");
-    const build_start_dt = new Date().toLocaleString();
-
-    // Load the hdocbook-project.json file to get the docId
-    // use the docId to get the book config
-    const hdocbook_project_config_path = path.join(
-      source_path,
-      "hdocbook-project.json"
-    );
-    try {
-      hdocbook_project = require(hdocbook_project_config_path);
-    } catch (e) {
-      console.error("File not found: hdocbook-project.json\n");
-      console.error(
-        "hdoc build/validate needs to be run in the root of a HDoc Book.\n"
-      );
-      process.exit(1);
-    }
-    doc_id = hdocbook_project.docId;
-
-    if (
-      !validate &&
-      hdocbook_project.pdfGeneration !== undefined &&
-      hdocbook_project.pdfGeneration.enable !== undefined
-    ) {
-      pdf_enable = hdocbook_project.pdfGeneration.enable;
-    }
-
-    if (
-      hdocbook_project.redirects &&
-      hdocbook_project.redirects instanceof Array
-    ) {
-      for (let i = 0; i < hdocbook_project.redirects.length; i++) {
-        const redirect_key =
-          hdocbook_project.redirects[i].url.indexOf("/") == 0
-            ? hdocbook_project.redirects[i].url.substring(1)
-            : hdocbook_project.redirects[i].url;
-        redirects[redirect_key] = hdocbook_project.redirects[i];
-      }
-    }
-
-    console.log(`Loading hdocbook config...`);
-
-    const book_path = path.join(source_path, doc_id),
-      hdocbook_path = path.join(book_path, "hdocbook.json"),
-      work_path = path.join(source_path, "_work"),
-      work_hdocbook_path = path.join(work_path, doc_id, "hdocbook.json");
-
-    hdocbook_config = require(hdocbook_path);
-    if (build_version !== "") {
-      if (build_version.match(regex_version)) {
-        hdocbook_config.version = build_version;
-      } else {
-        console.info(
-          `\n[WARNING] Argument build version [${build_version}] does not match expected pattern, defaulting to version specified in book [${hdocbook_config.version}]\n`
-        );
-      }
-    }
-
-    if (!hdocbook_config.version.match(regex_version)) {
-      console.error(
-        `ERROR: Version number does not match required format - ${hdocbook_config.version}\n`
-      );
-      process.exit(1);
-    }
-
-    if (
-      hdocbook_config.publicSource &&
-      hdocbook_config.publicSource.endsWith(".git")
-    )
-      hdocbook_config.publicSource = hdocbook_config.publicSource.substring(
-        0,
-        hdocbook_config.publicSource.length - 4
-      );
-
-    console.log(`Loading product families...`);
-    const prods = await hdoc.load_product_families();
-    if (!prods.success) {
-      console.error(`${prods.errors}\n`);
-      process.exit(1);
-    } else {
-      prod_families = prods.prod_families;
-      prods_supported = prods.prods_supported;
-    }
-
-    if (!validate) {
-      console.log("Caching CSS for PDF generation...");
-      const css_files = [
-        path.join(pdf_template_path, "css", "custom-block.css"),
-        path.join(pdf_template_path, "css", "hdocs-pdf.css"),
-        path.join(pdf_template_path, "css", "vars.css"),
-        path.join(ui_css_path, 'theme-default', 'styles', 'components', 'api-doc.css')
-      ];
-      for (let i = 0; i < css_files.length; i++) {
-        try {
-          css_templates.push(fs.readFileSync(css_files[i], "utf8"));
-        } catch (e) {
-          console.error(`Error reading file[${css_files[i]}]: ${e}`);
-        }
-      }
-    }
-
-    // Validate all filenames first
-    console.log(`Validating book filenames meet kebab-case requirements...`);
-    dree.scan(book_path, dreeOptionsAllFiles, filename_validation_callback);
-    if (errors_filename.length > 0) {
-        console.log("\r\n-----------------------");
-        console.log("   Validation Output   ");
-        console.log("-----------------------");
-      console.error(`${errors_filename.length} files do not meet filename requirements:`);
-      console.error(` - ${errors_filename.join("\n - ")}`);
-      console.log()
-      process.exit(1);
-    }
-
-    console.log(`Building: ${doc_id} v${hdocbook_config.version}...\n`);
-
-    // Make _work folder to copy everything into
-    work_path_content = path.join(work_path, doc_id);
-    if (fs.existsSync(work_path)) {
-      fs.rmSync(work_path, {
-        recursive: true,
-        force: true,
-      });
-    }
-    fs.mkdirSync(work_path);
-
-    const file_filter = (src) => {
-      return !src.toLowerCase().endsWith('.ds_store');
-    };
-
-    // Copy files from book into _work-doc_id folder
-    console.log(`Copying content into work folder...`);
-    try {
-      fs.copySync(path.join(source_path, doc_id), work_path_content, { filter: file_filter });
-    } catch (e) {
-      console.error("Error copying from source_path:\n", e);
-      process.exit(1);
-    }
-
-    // Create MD5 hash of content before build
-    console.log(`Creating Hash...`);
-
-    dree.scan(work_path_content, md5DreeOptions, hash_callback);
-    let concat_hash = "|";
-    for (let i = 0; i < built_file_hashes.length; i++) {
-      concat_hash +=
-        built_file_hashes[i].path + ":" + built_file_hashes[i].hash + "|";
-    }
-    if (concat_hash === "|") {
-      console.error("No hash of content has been returned.");
-      process.exit(1);
-    }
-
-    // Create hash and write file
-    const hash = crypto.createHash("md5").update(concat_hash).digest("hex");
-    const checksum_path = path.join(work_path_content, "checksum.md5");
-    try {
-      fs.writeFileSync(checksum_path, hash);
-      console.log("Hash file creation success:", checksum_path);
-    } catch (e) {
-      console.error("\nError creating", checksum_path, ":", e);
-      process.exit(1);
-    }
-
-    // Load document header templates
-    console.log(`Loading templates...`);
-    try {
-      doc_header_template = fs.readFileSync(doc_header_template_path, "utf8");
-      doc_header_template_non_git = fs.readFileSync(
-        non_git_doc_header_template_path,
-        "utf8"
-      );
-      pdf_header_template = fs.readFileSync(pdf_header_template_path, "utf8");
-      pdf_header_template_non_git = fs.readFileSync(
-        non_git_pdf_header_template_path,
-        "utf8"
-      );
-    } catch (err) {
-      console.error(`Error reading document header template: ${err}`);
-      process.exit(1);
-    }
-
-    if (pdf_enable) {
-      // Load PDF templates
-      try {
-        pdf_template = fs.readFileSync(pdf_template_file_path, "utf8");
-      } catch (err) {
-        console.error(`Error reading PDF template: ${err}`);
-        process.exit(1);
-      }
-    }
-    console.log(`Processing navigation breadcrumbs...`);
-    const bc_build = hdoc.build_breadcrumbs(hdocbook_config.navigation.items);
-    if (bc_build.errors.length > 0) {
-      console.log("\r\n-----------------------");
-      console.log("   Validation Output   ");
-      console.log("-----------------------");
-      console.log(
-        `\n${bc_build.errors.length} errors found when processing navigation:\n`
-      );
-      console.error(` - ${bc_build.errors.join("\n\n - ")}`);
-      console.log("\n");
-      process.exit(1);
-    }
-    bc = bc_build.bc;
-    console.log(`Processing content...`);
-    // Get a list of MD files in work_path
-    dree.scan(work_path, dreeOptions, build_file_callback);
-
-    if (pdf_enable) {
-      // Create a Chromium browser instance generate PDFs with
-      browser = await puppeteer.launch({ headless: 'shell' });
-    }
-
-    // Work through MD files and convert to HTML
-    let mdPromiseArray = [];
-    for (let i = 0; i < md_files.length; i++) {
-      mdPromiseArray.push(md_files[i]);
-    }
-    const chunkSize = 8;
-    for (let i = 0; i < mdPromiseArray.length; i += chunkSize) {
-      const chunk = mdPromiseArray.slice(i, i + chunkSize);
-      // do whatever
-      await Promise.all(
-        chunk.map(async (file) => {
-          await transform_markdown_and_save_html(file);
-        })
-      );
-    }
-
-    // Work through Static HTML files and add Frontmatter tags
-    let htmlPromiseArray = [];
-    for (let i = 0; i < static_html_files.length; i++) {
-      htmlPromiseArray.push(static_html_files[i]);
-    }
-    for (let i = 0; i < htmlPromiseArray.length; i += chunkSize) {
-      const chunk = htmlPromiseArray.slice(i, i + chunkSize);
-      await Promise.all(
-        chunk.map(async (file) => {
-          await transform_static_html(file);
-        })
-      );
-    }
-
-    if (pdf_enable) {
-      // Close the Chromium browser instance
-      await browser.close();
-    }
-
-    // Output to console
-    console.log(`\n                MD files found: ${conversion_attempted}`);
-    console.log(`Successfully converted to HTML: ${conversion_success}`);
-    if (conversion_failed > 0) console.error(`             Failed to convert: ${conversion_failed}\n`);
-    else console.log(`             Failed to convert: ${conversion_failed}\n`);
-    console.log(`                Includes Found: ${includes_found}`);
-    console.log(`              Includes Success: ${includes_success}`);
-    if (includes_failed > 0) console.error(`               Includes Failed: ${includes_failed}\n`);
-    else  console.log(`               Includes Failed: ${includes_failed}\n`);
-    console.log(
-      `       Static HTML Files Found: ${static_html_files.length}\n`
-    );
-    if (!validate) {
-      console.log(`             PDF Files Created: ${pdf_created}\n`);
-    }
-
-    // Validate content
-    const validation_success = await hdoc_validate.run(
-      work_path,
-      doc_id,
-      verbose,
-      hdocbook_config,
-      hdocbook_project,
-      bc,
-      prod_families,
-      prods_supported,
-      gen_exclude,
-      redirects
-    );
-    if (!validation_success) {
-      const end_time = Date.now();
-      console.log(`\nTime Taken: ${get_duration(start_time, end_time)}\n`);
-      process.exit(1);
-    }
-
-    // Delete markdown files
-    console.log(`Performing Markdown Cleanup`);
-
-    let filePromiseArray = [];
-    for (let i = 0; i < md_files_delete.length; i++) {
-      filePromiseArray.push(md_files_delete[i]);
-    }
-    await Promise.all(
-      filePromiseArray.map(async (file) => {
-        fs.unlink(file, (err) => {
-          if (err) console.error(`Error deleting ${file}: ${e}`);
-        });
-      })
-    );
-
-    // Add book read timing to the hdocbook.json
-    hdocbook_config.readingTime = Math.ceil(
-      book_read_time + (book_read_time / 100) * 10
-    );
-    hdocbook_config.navigation.items = hdoc.strip_drafts(
-      hdocbook_config.navigation.items
-    );
-    try {
-      fs.writeFileSync(
-        work_hdocbook_path,
-        JSON.stringify(hdocbook_config, null, 2)
-      );
-      console.log("\nhdocbook.json update success:", work_hdocbook_path);
-    } catch (e) {
-      console.error("\nError creating", work_hdocbook_path, ":", e);
-      process.exit(1);
-    }
-
-    // Build the index
-    // Create the DB and tables
-    console.log(`Building the Index`);
-    let db = hdoc_build_db.create_db(work_path, doc_id);
-    if (db.error && db.error !== null) {
-      console.error(db.error);
-      process.exit(1);
-    }
-    // Populate primary index tables
-    const index = await hdoc_build_db.populate_index(
-      db.db,
-      doc_id,
-      hdocbook_config,
-      index_records,
-      verbose
-    );
-    if (!index.success) {
-      console.error(index.error);
-      process.exit(1);
-    }
-
-    // Populate redirect index table records
-    if (
-      hdocbook_project.redirects &&
-      hdocbook_project.redirects instanceof Array &&
-      hdocbook_project.redirects.length > 0
-    ) {
-      const redirects_index = hdoc_build_db.populate_redirects(
-        db.db,
-        hdocbook_project.redirects,
-        verbose
-      );
-      if (!redirects_index.success) {
-        for (let i = 0; i < index.errors.length; i++) {
-          console.error(index.errors[i]);
-        }
-        process.exit(1);
-      }
-    }
-
-    if (!validate) {
-      try {
-        const zip_path = path.join(work_path, doc_id + ".zip");
-
-        var output = fs.createWriteStream(zip_path);
-        var archive = archiver("zip");
-        archive.on("error", function (err) {
-          throw err;
-        });
-        archive.pipe(output);
-
-        // append files from a sub-directory, putting its contents at the root of archive
-        archive.directory(work_path_content, false);
-        archive.finalize();
-
-        //await zip(work_path_content, zip_path);
-        console.log(`\nZIP Creation Success: ${zip_path}\n`);
-        console.log("  Build Started:", build_start_dt);
-        console.log(`Build Completed: ${new Date().toLocaleString()}\n`);
-      } catch (e) {
-        console.error("\nError creating ZIP: " + e);
-      }
-    } else {
-      console.log("\nValidation Complete\n");
-    }
-    const end_time = Date.now();
-    console.log(`Time Taken: ${get_duration(start_time, end_time)}\n`);
-  };
-
-  const get_duration = function (start, end) {
-    const total_time = new Date(end - start).toISOString().slice(11, 19);
-    const duration_arr = total_time.split(":");
-    let duration = "";
-    if (parseInt(duration_arr[0], 10) > 0) {
-      duration += parseInt(duration_arr[0], 10) + "h ";
-    }
-    if (duration !== "" || parseInt(duration_arr[1], 10)) {
-      duration += parseInt(duration_arr[1], 10) + "m ";
-    }
-    duration += parseInt(duration_arr[2], 10) + "s";
-    return duration;
-  };
-})();
+(() => {
+	const crypto = require("node:crypto");
+	const dree = require("dree");
+	const fs = require("fs-extra");
+	const mdfm = require("markdown-it-front-matter");
+	const path = require("node:path");
+	const puppeteer = require("puppeteer");
+	const URL = require("node:url").URL;
+	const hdoc_validate = require(path.join(__dirname, "hdoc-validate.js"));
+	const hdoc = require(path.join(__dirname, "hdoc-module.js"));
+	const hdoc_build_db = require(path.join(__dirname, "hdoc-build-db.js"));
+	const hdoc_build_pdf = require(path.join(__dirname, "hdoc-build-pdf.js"));
+	const hdoc_index = require(path.join(__dirname, "hdoc-db.js"));
+	const archiver = require("archiver");
+	const xmlFormat = require("xml-formatter");
+
+	const h_tags_to_search = ["h1", "h2", "h3"];
+	const image_extensions = ["png", "svg", "jpg"];
+	const doc_header_template_path = path.join(
+		__dirname,
+		"templates",
+		"doc-header.html",
+	);
+	const non_git_doc_header_template_path = path.join(
+		__dirname,
+		"templates",
+		"doc-header-non-git.html",
+	);
+	const pdf_header_template_path = path.join(
+		__dirname,
+		"templates",
+		"pdf-header.html",
+	);
+	const non_git_pdf_header_template_path = path.join(
+		__dirname,
+		"templates",
+		"pdf-header-non-git.html",
+	);
+	const pdf_template_path = path.join(__dirname, "templates", "pdf");
+	const ui_css_path = path.join(__dirname, "ui", "css");
+	const pdf_template_file_path = path.join(pdf_template_path, "template.html");
+	const regex_version = /^[0-9]{1,3}[.][0-9]{1,3}[.][0-9]{1,6}$/;
+	const h1_pattern = /(<h1.*?>)\s*.*\s*(.*<\/h1>)/;
+	const regex_filename = /^[a-z]+-{0,1}([-a-z0-9]+)*$/;
+
+	const built_file_hashes = [];
+	const css_templates = [];
+	const errors_filename = [];
+	const index_records = [];
+	const md_files = [];
+	const md_files_delete = [];
+	const redirects = {};
+	const static_html_files = [];
+
+	let bc = {}; // Breadcrumbs map
+	let book_read_time = 0;
+	let browser = {};
+	let conversion_attempted = 0;
+	let conversion_success = 0;
+	let conversion_failed = 0;
+	let doc_header_template = "";
+	let doc_header_template_non_git = "";
+	let global_source_path = "";
+	let pdf_created = 0;
+	let pdf_enable = false;
+	let pdf_header_template = "";
+	let pdf_header_template_non_git = "";
+	let pdf_template = "";
+	let prod_families = {};
+	let prods_supported = [];
+	let doc_id = "";
+	let git_token =
+		"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"; // Github fine-grained personal access token that has minimum read-only access to Hornbill Docs metadata
+	let hdocbook_config = {};
+	let hdocbook_project;
+	let includes_found = 0;
+	let includes_success = 0;
+	let includes_failed = 0;
+	let work_path_content = "";
+	let verbose = false;
+
+	const pdf_path_excluded = (relative_path) => {
+		if (
+			!hdocbook_project.pdfGeneration ||
+			hdocbook_project.pdfGeneration.exclude_paths === undefined
+		) {
+			return false;
+		}
+		let clean_rel_path = relative_path;
+		if (relative_path.startsWith("/")) {
+			clean_rel_path = clean_rel_path.slice(1, clean_rel_path.length);
+		}
+		for (
+			let i = 0;
+			i < hdocbook_project.pdfGeneration.exclude_paths.length;
+			i++
+		) {
+			const exclude_path = hdocbook_project.pdfGeneration.exclude_paths[i];
+			if (clean_rel_path === exclude_path) return true;
+			if (exclude_path.at(-1) === "*") {
+				if (clean_rel_path.startsWith(exclude_path.slice(0, -1))) {
+					return true;
+				}
+			}
+		}
+		return false;
+	};
+
+	const transform_static_html = async (file_path) => {
+		if (fs.existsSync(file_path.path)) {
+			// Load HTML file
+			let html_txt = fs.readFileSync(file_path.path, "utf8");
+			html_txt = html_txt.replace(/\r/gm, ""); // Remove CR's so we're just dealing with newlines
+
+			const fm_headers = [];
+			let existing_fm_headers = false;
+			let doc_type = "Article";
+			let doc_title = "";
+
+			// Check if we have a frontmatter comment
+			const fm_header = hdoc.getHTMLFrontmatterHeader(html_txt);
+			if (Object.keys(fm_header.fm_properties).length > 0) {
+				existing_fm_headers = true;
+
+				// We have some frontmatter headers, check if title is one of them
+				let fm_title_found = false;
+				if (
+					fm_header.fm_properties &&
+					fm_header.fm_properties.title !== undefined
+				) {
+					// We have a title - but does the title have a value
+					if (fm_header.fm_properties.title === "") {
+						// No value - remove title from the properties map  so we don't end up with 2 title properties, one empty and one with a value
+						fm_header.fm_properties.title = undefined;
+					} else {
+						// We have a value for the title property
+						fm_title_found = true;
+						doc_title = fm_header.fm_properties.title.trim();
+					}
+				}
+
+				// Is reading-time in the fm headers?
+				if (fm_header.fm_properties["reading-time"] === undefined) {
+					const read_time_mins = hdoc.get_html_read_time(html_txt);
+					book_read_time += read_time_mins;
+					fm_header.fm_properties["reading-time"] = read_time_mins;
+				}
+
+				for (const key in fm_header.fm_properties) {
+					if (Object.hasOwn(fm_header.fm_properties, key)) {
+						if (key === "type") doc_type = fm_header.fm_properties[key];
+						else {
+							fm_headers.push({
+								id: key,
+								value: fm_header.fm_properties[key],
+							});
+						}
+					}
+				}
+
+				if (
+					!fm_title_found &&
+					file_path.name !== "description_ext.md" &&
+					file_path.name !== "article_ext.md"
+				) {
+					// No frontmatter title found in properties
+					// Go get title from h tags in html
+					const html_heading = hdoc.getFirstHTMLHeading(
+						html_txt,
+						h_tags_to_search,
+					);
+
+					if (html_heading?.[0]?.children?.[0]?.data) {
+						// We've found a heading tag, add that as a title to the existing frontmatter properties
+						fm_headers.push({
+							id: "title",
+							value: html_heading[0].children[0].data,
+						});
+						doc_title = html_heading[0].children[0].data;
+					} else {
+						// No header tag, no frontmatter title, output a warning
+						console.info(
+							`[WARNING] No frontmatter title property, or ${h_tags_to_search.join(
+								", ",
+							)} tags detected in ${file_path.path}`,
+						);
+					}
+				}
+
+				// Do we have a description header?
+				if (
+					fm_header.fm_properties &&
+					fm_header.fm_properties.description !== undefined
+				) {
+					if (fm_header.fm_properties.description === "") {
+						const html_p_tag = hdoc.getFirstHTMLHeading(html_txt, ["p"]);
+						if (html_p_tag?.[0]?.children?.[0]?.data) {
+							fm_headers.push({
+								id: "description",
+								value:
+									`${doc_title}: ${html_p_tag[0].children[0].data.split(".")[0]}.`.trim(),
+							});
+						}
+					} else {
+						fm_headers.push({
+							id: "description",
+							value: fm_header.fm_properties.description.trim(),
+						});
+					}
+				} else {
+					const html_p_tag = hdoc.getFirstHTMLHeading(html_txt, ["p"]);
+					if (html_p_tag?.[0]?.children?.[0]?.data) {
+						fm_headers.push({
+							id: "description",
+							value:
+								`${doc_title}: ${html_p_tag[0].children[0].data.split(".")[0]}.`.trim(),
+						});
+					}
+				}
+			} else {
+				// We have no frontmatter headers, get and build one from the html headings
+				const html_heading = hdoc.getFirstHTMLHeading(
+					html_txt,
+					h_tags_to_search,
+				);
+				let doc_title = "";
+				// Add the title
+				if (html_heading?.[0]?.children?.[0]?.data) {
+					// We've found a heading tag, add that as a title to the frontmatter content
+					fm_headers.push({
+						id: "title",
+						value: html_heading[0].children[0].data,
+					});
+					doc_title = html_heading[0].children[0].data;
+				} else if (
+					file_path.name !== "description_ext.md" &&
+					file_path.name !== "article_ext.md"
+				) {
+					// No header tag, no frontmatter title, output a warning
+					console.info(
+						`[WARNING] No frontmatter title property, or ${h_tags_to_search.join(
+							", ",
+						)} tags detected in ${file_path.path}`,
+					);
+				}
+
+				// Add the reading time
+				const read_time_mins = hdoc.get_html_read_time(html_txt);
+				book_read_time += read_time_mins;
+				fm_headers.push({
+					id: "reading-time",
+					value: read_time_mins,
+				});
+
+				const html_p_tag = hdoc.getFirstHTMLHeading(html_txt, ["p"]);
+				if (html_p_tag?.[0]?.children?.[0]?.data) {
+					fm_headers.push({
+						id: "description",
+						value:
+							`${doc_title}: ${html_p_tag[0].children[0].data.split(".")[0]}.`.trim(),
+					});
+				}
+			}
+
+			// Add doc type
+			fm_headers.push({
+				id: "type",
+				value: doc_type,
+			});
+
+			const metadata = {};
+
+			// Remove the first <h1>title</h1> from the HTML as we'll add that in the document header
+			let html_h1 = h1_pattern.exec(html_txt);
+			if (html_h1?.[0])
+				html_h1 = html_h1[0].replace(/(<h1.*?>)/, "").replace(/(<\/h1>)/, "");
+
+			html_txt = html_txt.replace(h1_pattern, "");
+
+			// Get contributor data from Github, if exists
+			let contribs = [];
+			let last_commit = null;
+			if (
+				hdocbook_config.publicSource &&
+				hdocbook_config.publicSource !== "" &&
+				hdocbook_config.publicSource.includes("github.com/Hornbill-Docs")
+			) {
+				const github_paths = hdoc.get_github_api_path(
+					hdocbook_config.publicSource,
+					file_path.relativePath,
+				);
+				const contributors = hdoc.get_github_contributors(
+					github_paths.api_path,
+					git_token,
+				);
+
+				if (!contributors.success) {
+					console.error(
+						`Error retrieving contributors from Github: ${contributors.error}`,
+					);
+				} else {
+					last_commit = contributors.last_commit_date;
+					metadata.last_commit = contributors.last_commit_date;
+					metadata.contributor_count = contributors.contributor_count;
+					metadata.edit_url = github_paths.edit_path;
+					contribs = contributors.contributors;
+					contributors.editPath = github_paths.edit_path;
+					fm_headers.push({
+						id: "contributor-count",
+						value: contributors.contributor_count,
+					});
+					fm_headers.push({
+						id: "last-commit",
+						value: contributors.last_commit_date,
+					});
+					const target_file = file_path.path.replace(
+						path.extname(file_path.path),
+						"._info.json",
+					);
+					contributors.success = undefined;
+					contributors.error = undefined;
+					contributors.editPath = github_paths.edit_path;
+				}
+				fm_headers.push({
+					id: "edit-path",
+					value: github_paths.edit_path,
+				});
+			}
+
+			if (pdf_enable && !pdf_path_excluded(file_path.relativePath)) {
+				fm_headers.push({
+					id: "pdf-path",
+					value: file_path.relativePath.replace(
+						path.extname(file_path.relativePath),
+						".pdf",
+					),
+				});
+			}
+
+			let fm_header_content = "<!--[[FRONTMATTER\n";
+			if (fm_headers.length > 0) {
+				for (let i = 0; i < fm_headers.length; i++) {
+					fm_header_content += `${fm_headers[i].id}: ${fm_headers[i].value}\n`;
+				}
+				fm_header_content += "]]-->";
+
+				if (existing_fm_headers) {
+					html_txt = html_txt.replace(`<!--${fm_header.fm_header}-->`, "");
+				}
+			}
+
+			let doc_header = "";
+			let pdf_header = "";
+			const inline_content = file_path.relativePath.startsWith(
+				`${hdocbook_config.docId}/_inline/`,
+			);
+			if (hdocbook_config.publicSource?.includes("github.com/Hornbill-Docs")) {
+				// Build doc header from template and frontmatter tags
+				if (!inline_content)
+					doc_header = process_doc_header(
+						fm_headers,
+						file_path.relativePath,
+						doc_header_template,
+						html_h1,
+					);
+
+				if (pdf_enable && !pdf_path_excluded(file_path.relativePath))
+					pdf_header = process_doc_header(
+						fm_headers,
+						file_path.relativePath,
+						pdf_header_template,
+						html_h1,
+					);
+			} else {
+				if (!inline_content)
+					doc_header = process_doc_header(
+						fm_headers,
+						file_path.relativePath,
+						doc_header_template_non_git,
+						html_h1,
+					);
+
+				if (pdf_enable && !pdf_path_excluded(file_path.relativePath))
+					pdf_header = process_doc_header(
+						fm_headers,
+						file_path.relativePath,
+						pdf_header_template_non_git,
+						html_h1,
+					);
+			}
+
+			let pdf_size = 0;
+			if (pdf_enable && !pdf_path_excluded(file_path.relativePath)) {
+				let pdf_txt = await hdoc_build_pdf.process_images(file_path, html_txt);
+				pdf_txt = `${pdf_header}\n${pdf_txt}`;
+
+				// Generate PDF file from HTML
+				const pdf_file_path = file_path.path.replace(
+					path.extname(file_path.path),
+					".pdf",
+				);
+				pdf_size = await hdoc_build_pdf.generate_pdf(
+					browser,
+					pdf_template_path,
+					pdf_template,
+					hdocbook_config,
+					pdf_txt,
+					pdf_file_path,
+					css_templates,
+					verbose,
+				);
+			}
+			if (pdf_size > 0) pdf_created++;
+
+			// Wrap h2 and h3 tags, plus content, in id'd divs
+			html_txt = hdoc.wrapHContent(html_txt);
+
+			if (inline_content) html_txt = `${fm_header_content}\n${html_txt}`;
+			else html_txt = `${fm_header_content}\n${doc_header}\n${html_txt}`;
+
+			let relative_path = file_path.relativePath;
+			if (
+				!bc[relative_path.replace(".html", "")] &&
+				bc[relative_path.replace("/index.html", "")]
+			) {
+				relative_path = relative_path.replace("/index.html", "");
+			}
+
+			const index_data = hdoc_index.transform_html_for_index(html_txt);
+
+			for (const section of index_data.sections) {
+				index_records.push({
+					relative_path: relative_path,
+					index_html: {
+						fm_props: index_data.fm_props,
+						text: section.text,
+						preview: section.preview,
+						id: section.id ? section.id : null,
+					},
+					metadata: metadata,
+					contributors: contribs,
+					pdf_size: pdf_size,
+					md5: file_path.hash,
+					lastmod: last_commit !== null ? last_commit : file_path.hb_lastmod,
+					inline: inline_content,
+				});
+			}
+
+			// Save HTML into HTML file
+			try {
+				fs.writeFileSync(file_path.path, html_txt);
+			} catch (err) {
+				console.error("Error writing:", target_file, "\n", err);
+			}
+		}
+	};
+
+	const transform_markdown_and_save_html = async (file_path) => {
+		conversion_attempted++;
+
+		if (fs.existsSync(file_path.path)) {
+			// Load markdown file
+			let md_txt = hdoc.expand_variables(
+				fs.readFileSync(file_path.path, "utf8"),
+			);
+
+			// Pull in external includes
+			const includes_processed = await hdoc.process_includes(
+				file_path.path,
+				md_txt,
+				global_source_path,
+			);
+			md_txt = includes_processed.body.toString();
+			includes_found += includes_processed.found;
+			includes_success += includes_processed.success;
+			includes_failed += includes_processed.failed;
+			if (includes_processed.errors.length > 0) {
+				for (let i = 0; i < includes_processed.errors.length; i++) {
+					console.error(includes_processed.errors[i]);
+				}
+			}
+
+			// One markdown parser per file. Seems wrong, but doesn't work with a global one once past the first md file
+			// Steve - revisit this
+			const md = require("markdown-it")({
+				html: true,
+				linkify: true,
+				typographer: true,
+			});
+			md.linkify.set({
+				fuzzyEmail: false,
+				fuzzyLink: false,
+				fuzzyIP: false,
+			});
+
+			// Process Frontmatter tags
+			let frontmatter_content = "";
+			md.use(mdfm, (fm) => {
+				frontmatter_content = fm;
+			});
+
+			// Process tips
+			const tips = require(`${__dirname}/custom_modules/tips.js`);
+			md.use(tips, {
+				links: true,
+			});
+
+			// Tidy up ```json and ```xml code tags
+
+			if (md_txt.includes("```json") || md_txt.includes("```xml"))
+				md_txt = tidy_code_tags(md_txt, file_path.relativePath);
+
+			// Render markdown into HTML
+			let html_txt = md.render(md_txt);
+
+			// Prepare frontmatter headers
+			const fm_headers = [];
+			const fm_content = frontmatter_content.split(/\r?\n/);
+
+			let fm_contains_title = false;
+			let fm_contains_reading_time = false;
+			let fm_contains_description = false;
+			let doc_title = "";
+			let doc_type = "Article";
+
+			if (fm_content.length >= 0) {
+				for (fm_prop of fm_content) {
+					const fm_id = fm_prop.slice(0, fm_prop.indexOf(":"));
+					const fm_val = fm_prop.slice(fm_prop.indexOf(":") + 1);
+
+					if (
+						fm_id &&
+						fm_id.trim().length > 0 &&
+						fm_val &&
+						fm_val.trim().length > 0
+					) {
+						fm_headers.push({
+							id: fm_id.trim(),
+							value: fm_val.trim(),
+						});
+
+						if (fm_id.trim() === "title") {
+							fm_contains_title = true;
+							doc_title = fm_val.trim();
+						}
+						if (fm_id.trim() === "type") {
+							doc_type = fm_val.trim();
+						}
+						if (fm_id.trim() === "reading-time") {
+							book_read_time += Number.parseInt(fm_val.trim(), 10);
+							fm_contains_reading_time = true;
+						}
+						if (fm_id.trim() === "description") {
+							fm_contains_description = true;
+						}
+					}
+				}
+			}
+
+			// Add doc type
+			fm_headers.push({
+				id: "type",
+				value: doc_type,
+			});
+
+			// Does frontmatter tag contain a title property
+			if (!fm_contains_title) {
+				// Frontmatter tags don't contain a title property - go pull the first one from the html heading tags
+				const html_heading = hdoc.getFirstHTMLHeading(
+					html_txt,
+					h_tags_to_search,
+				);
+
+				if (html_heading?.[0]?.children?.[0]?.data) {
+					// We've found a heading tag, add that as a title to the frontmatter content
+					fm_headers.push({
+						id: "title",
+						value: html_heading[0].children[0].data.trim(),
+					});
+					doc_title = html_heading[0].children[0].data.trim();
+				} else if (
+					file_path.name !== "description_ext.md" &&
+					file_path.name !== "article_ext.md"
+				) {
+					// No header tag, no frontmatter title, output a warning
+					console.info(
+						`[WARNING] No frontmatter title property, or h1, h2 or h3 header tags detected in ${file_path.path}`,
+					);
+				}
+			}
+
+			// Does frontmatter contain a description header, generate one if not
+			if (!fm_contains_description) {
+				const html_p_tag = hdoc.getFirstHTMLHeading(html_txt, ["p"]);
+				if (html_p_tag?.[0]?.children?.[0]?.data) {
+					fm_headers.push({
+						id: "description",
+						value:
+							`${doc_title}: ${html_p_tag[0].children[0].data.split(".")[0]}.`.trim(),
+					});
+				}
+			}
+
+			// Does frontmatter tag contain a reading-time property
+			if (!fm_contains_reading_time) {
+				const read_time_mins = hdoc.get_html_read_time(html_txt);
+				book_read_time += read_time_mins;
+				fm_headers.push({
+					id: "reading-time",
+					value: read_time_mins,
+				});
+			}
+			const metadata = {};
+
+			// Remove the first <h1>title</h1> from the HTML as we'll add that in the document header
+			let html_h1 = h1_pattern.exec(html_txt);
+			if (html_h1?.[0])
+				html_h1 = html_h1[0].replace(/(<h1.*?>)/, "").replace(/(<\/h1>)/, "");
+
+			html_txt = html_txt.replace(h1_pattern, "");
+
+			// Get contributor data from Github, if exists
+			let contribs = [];
+			let last_commit = null;
+			if (
+				hdocbook_config.publicSource &&
+				hdocbook_config.publicSource !== "" &&
+				hdocbook_config.publicSource.includes("github.com/Hornbill-Docs")
+			) {
+				const github_paths = hdoc.get_github_api_path(
+					hdocbook_config.publicSource,
+					file_path.relativePath,
+				);
+				const contributors = await hdoc.get_github_contributors(
+					github_paths.api_path,
+					git_token,
+					hdocbook_config.publicSource,
+				);
+
+				if (!contributors.success) {
+					console.error(
+						`Error retrieving contributors from Github: ${contributors.error}`,
+					);
+				} else {
+					last_commit = contributors.last_commit_date;
+					metadata.last_commit = contributors.last_commit_date;
+					metadata.contributor_count = contributors.contributor_count;
+					metadata.edit_url = github_paths.edit_path;
+					contribs = contributors.contributors;
+					contributors.editPath = github_paths.edit_path;
+
+					fm_headers.push({
+						id: "contributor-count",
+						value: contributors.contributor_count,
+					});
+					fm_headers.push({
+						id: "last-commit",
+						value: contributors.last_commit_date,
+					});
+					const target_file = file_path.path.replace(
+						path.extname(file_path.path),
+						"._info.json",
+					);
+					contributors.success = undefined;
+					contributors.error = undefined;
+					contributors.editPath = github_paths.edit_path;
+					try {
+						fs.writeFileSync(
+							target_file,
+							JSON.stringify(contributors, null, 2),
+						);
+					} catch (err) {
+						console.error("Error writing:", target_file, "\n", err);
+					}
+				}
+				fm_headers.push({
+					id: "edit-path",
+					value: github_paths.edit_path,
+				});
+			}
+
+			if (pdf_enable && !pdf_path_excluded(file_path.relativePath)) {
+				fm_headers.push({
+					id: "pdf-path",
+					value: file_path.relativePath.replace(
+						path.extname(file_path.relativePath),
+						".pdf",
+					),
+				});
+			}
+
+			// Add frontmatter tags as comment
+			let fm_header = "<!--[[FRONTMATTER\n";
+			if (fm_headers.length > 0) {
+				for (let i = 0; i < fm_headers.length; i++) {
+					fm_header += `${fm_headers[i].id}: ${fm_headers[i].value}\n`;
+				}
+			}
+			fm_header += "]]-->";
+
+			let doc_header = "";
+			let pdf_header = "";
+			const inline_content = file_path.relativePath.startsWith(
+				`${hdocbook_config.docId}/_inline/`,
+			);
+			if (hdocbook_config.publicSource?.includes("github.com/Hornbill-Docs")) {
+				// Build doc header from template and frontmatter tags
+				if (!inline_content)
+					doc_header = process_doc_header(
+						fm_headers,
+						file_path.relativePath,
+						doc_header_template,
+						html_h1,
+					);
+
+				if (pdf_enable && !pdf_path_excluded(file_path.relativePath))
+					pdf_header = process_doc_header(
+						fm_headers,
+						file_path.relativePath,
+						pdf_header_template,
+						html_h1,
+					);
+			} else {
+				// Build doc header from template and frontmatter tags
+				if (!inline_content)
+					doc_header = process_doc_header(
+						fm_headers,
+						file_path.relativePath,
+						doc_header_template_non_git,
+						html_h1,
+					);
+
+				if (pdf_enable && !pdf_path_excluded(file_path.relativePath))
+					pdf_header = process_doc_header(
+						fm_headers,
+						file_path.relativePath,
+						pdf_header_template_non_git,
+						html_h1,
+					);
+			}
+
+			let pdf_size = 0;
+			if (pdf_enable && !pdf_path_excluded(file_path.relativePath)) {
+				let pdf_txt = await hdoc_build_pdf.process_images(file_path, html_txt);
+				pdf_txt = `${pdf_header}\n${pdf_txt}`;
+
+				// Generate PDF file from HTML
+				const pdf_file_path = file_path.path.replace(
+					path.extname(file_path.path),
+					".pdf",
+				);
+				pdf_size = await hdoc_build_pdf.generate_pdf(
+					browser,
+					pdf_template_path,
+					pdf_template,
+					hdocbook_config,
+					pdf_txt,
+					pdf_file_path,
+					css_templates,
+					verbose,
+				);
+			}
+			if (pdf_size > 0) pdf_created++;
+
+			// Wrap h2 and h3 tags, plus content, in id'd divs
+			html_txt = hdoc.wrapHContent(html_txt);
+
+			if (inline_content) html_txt = `${fm_header}\n${html_txt}`;
+			else html_txt = `${fm_header}\n${doc_header}\n${html_txt}`;
+
+			// Save HTML into HTML file
+			const target_file = file_path.path.replace(
+				path.extname(file_path.path),
+				".html",
+			);
+			let relative_path = file_path.relativePath.replace(
+				path.extname(file_path.path),
+				".html",
+			);
+			try {
+				fs.writeFileSync(target_file, html_txt);
+			} catch (err) {
+				console.error("Error writing:", target_file, "\n", err);
+			}
+
+			if (
+				!bc[relative_path.replace(".html", "")] &&
+				bc[relative_path.replace("/index.html", "")]
+			) {
+				relative_path = relative_path.replace("/index.html", "");
+			}
+
+			const index_data = hdoc_index.transform_html_for_index(html_txt);
+
+			for (section of index_data.sections) {
+				index_records.push({
+					relative_path: relative_path,
+					index_html: {
+						fm_props: index_data.fm_props,
+						text: section.text,
+						preview: section.preview,
+						id: section.id ? section.id : null,
+					},
+					metadata: metadata,
+					contributors: contribs,
+					pdf_size: pdf_size,
+					md5: file_path.hash,
+					lastmod: last_commit !== null ? last_commit : file_path.hb_lastmod,
+					inline: inline_content,
+				});
+			}
+
+			// Add MD file to delete queue
+			md_files_delete.push(file_path.path);
+
+			conversion_success++;
+			return true;
+		}
+		conversion_failed++;
+		console.error("MD file does not exist:", file_path.path);
+		return false;
+	};
+
+	const tidy_code_tags = (markdown, file) => {
+		let clean_markdown = markdown;
+		const json_to_tidy = clean_markdown.match(/```json[\r\n](\s|.)*?```/g);
+		if (json_to_tidy && json_to_tidy.length > 0) {
+			for (let i = 0; i < json_to_tidy.length; i++) {
+				if (json_to_tidy[i] !== "") {
+					let json_tidy = json_to_tidy[i]
+						.replace("```json", "")
+						.replace("```", "");
+					try {
+						json_tidy = JSON.stringify(JSON.parse(json_tidy), null, 2);
+					} catch (e) {
+						console.info(
+							`[WARNING] Could not tidy JSON in file [${file}]: ${e}`,
+						);
+					}
+					clean_markdown = clean_markdown.replace(
+						json_to_tidy[i],
+						`\`\`\`json\n${json_tidy}\n\`\`\``,
+					);
+				}
+			}
+		}
+
+		const xml_to_tidy = clean_markdown.match(/```xml[\r\n](\s|.)*?```/g);
+		if (xml_to_tidy && xml_to_tidy.length > 0) {
+			for (let i = 0; i < xml_to_tidy.length; i++) {
+				if (xml_to_tidy[i] !== "") {
+					const xml_tidy = xml_to_tidy[i]
+						.replace("```xml", "")
+						.replace("```", "");
+					let new_xml_string = xml_tidy;
+					try {
+						new_xml_string = xmlFormat(xml_tidy, {
+							indentation: "  ",
+							collapseContent: true,
+							lineSeparator: "\n",
+						});
+					} catch (e) {
+						console.info(
+							`[WARNING] Could not tidy XML in file [${file}]: ${e}`,
+						);
+					}
+					clean_markdown = clean_markdown.replace(
+						xml_to_tidy[i],
+						`\`\`\`xml\n${new_xml_string}\n\`\`\``,
+					);
+				}
+			}
+		}
+		return clean_markdown;
+	};
+
+	const process_doc_header = (fm_headers, doc_path, template, h1) => {
+		let wip_doc_header = template;
+		let used_h1 = false;
+		if (h1 && h1 !== "") {
+			wip_doc_header = wip_doc_header.replaceAll("{{title}}", h1);
+			used_h1 = true;
+		}
+		// Process fm_headers properties first
+		for (let i = 0; i < fm_headers.length; i++) {
+			switch (fm_headers[i].id) {
+				case "title":
+					if (!used_h1)
+						wip_doc_header = wip_doc_header.replaceAll(
+							"{{title}}",
+							fm_headers[i].value,
+						);
+					break;
+				case "reading-time":
+					wip_doc_header = wip_doc_header.replaceAll(
+						"{{reading-time}}",
+						fm_headers[i].value,
+					);
+					break;
+				case "contributor-count":
+					wip_doc_header = wip_doc_header.replaceAll(
+						"{{contributor-count}}",
+						fm_headers[i].value,
+					);
+					break;
+				case "type":
+					wip_doc_header = wip_doc_header.replaceAll(
+						"{{doc-type}}",
+						fm_headers[i].value,
+					);
+					break;
+				case "edit-path":
+					wip_doc_header = wip_doc_header.replaceAll(
+						"{{edit-url}}",
+						fm_headers[i].value,
+					);
+					break;
+				case "last-commit": {
+					let last_commit_date = fm_headers[i].value;
+					if (last_commit_date !== "No Commit Date Available") {
+						last_commit_date = new Date(fm_headers[i].value).toDateString();
+					}
+					wip_doc_header = wip_doc_header.replaceAll(
+						"{{last-update}}",
+						last_commit_date,
+					);
+					break;
+				}
+				default:
+					break;
+			}
+		}
+
+		// Now sort out breadcrumbs
+		const logical_path = doc_path.replace(path.extname(doc_path), "");
+		const bc_for_path = bc[logical_path];
+		let bc_tags = "\n";
+		if (bc_for_path) {
+			for (let i = 0; i < bc_for_path.length - 1; i++) {
+				let bc_link = "/";
+				if (redirects[bc_for_path[i].link]) {
+					if (redirects[bc_for_path[i].link].location) {
+						bc_link += redirects[bc_for_path[i].link].location;
+					}
+				} else {
+					if (bc_for_path[i].link) {
+						bc_link = bc_for_path[i].link.startsWith("/")
+							? bc_for_path[i].link
+							: `/${bc_for_path[i].link}`;
+					} else {
+						bc_link = "";
+					}
+				}
+				if (bc_link !== "") {
+					bc_tags += `\t\t\t\t<li class="mt-0 nav-bar-item"><a href="${bc_link}" class="ps-0 pe-0 text-decoration-none">${bc_for_path[i].text}</a></li>\n`;
+				} else {
+					bc_tags += `\t\t\t\t<li class="mt-0 nav-bar-item">${bc_for_path[i].text}</li>\n`;
+				}
+			}
+		} else {
+			if (verbose) {
+				console.info(
+					`[WARNING] Path is not present in navigation items: ${logical_path}`,
+				);
+			}
+		}
+		bc_tags += "\t\t\t";
+		wip_doc_header = wip_doc_header.replaceAll("{{breadcrumbs}}", bc_tags);
+		return wip_doc_header;
+	};
+
+	// File callback for build scan
+	const build_file_callback = (element) => {
+		if (element.extension === "md") {
+			element.hb_source_path = path.join(
+				global_source_path,
+				element.relativePath,
+			);
+			const fstats = fs.statSync(element.hb_source_path);
+			element.hb_lastmod = `${fstats.mtime.toISOString().slice(0, 19)}Z`;
+			md_files.push(element);
+		} else {
+			// File is html, see if there's a matching md file and if there is then ignore the html
+			const md_path = element.path.replace(path.extname(element.path), ".md");
+			if (fs.existsSync(md_path)) {
+				return;
+			}
+			element.hb_source_path = path.join(
+				global_source_path,
+				element.relativePath,
+			);
+			const fstats = fs.statSync(element.hb_source_path);
+			element.hb_lastmod = `${fstats.mtime.toISOString().slice(0, 19)}Z`;
+			static_html_files.push(element);
+		}
+	};
+
+	// File & folder callback for MD5 hash of built content
+	const hash_callback = (element) => {
+		if (element.extension !== "db") {
+			built_file_hashes.push({
+				path: element.relativePath,
+				hash: element.hash,
+			});
+		}
+	};
+
+	// File scan callback for filename validation
+	const filename_validation_callback = (element) => {
+		if (element.relativePath.startsWith("_inline/")) return;
+		if (element.name.toLowerCase() === ".ds_store") return;
+		if (
+			element.name === "article_ext.md" ||
+			element.name === "description_ext.md"
+		)
+			return;
+		if (image_extensions.includes(element.extension)) return;
+		const file_no_ext = element.name.replace(`.${element.extension}`, "");
+		if (!file_no_ext.match(regex_filename))
+			errors_filename.push(element.relativePath);
+	};
+
+	const dreeOptions = {
+		hash: true,
+		extensions: ["md", "html", "htm"],
+		normalize: true,
+		stat: true,
+	};
+
+	const dreeOptionsAllFiles = {
+		descendants: true,
+		excludeEmptyDirectories: true,
+		hash: false,
+		normalize: true,
+		size: false,
+		sizeInBytes: false,
+		symbolicLinks: false,
+	};
+
+	const md5DreeOptions = {
+		hash: true,
+		normalize: true,
+		sorted: true,
+	};
+
+	exports.run = async (
+		source_path,
+		verbose_output,
+		github_api_token,
+		validate,
+		gen_exclude,
+		build_version = "",
+	) => {
+		if (github_api_token !== "") {
+			git_token = github_api_token;
+		}
+		global_source_path = source_path;
+		verbose = verbose_output;
+
+		const start_time = Date.now();
+		// GERRY: The purpose of this function is to create a zip file containing the hdocbook content,
+		// * Create a _work folder
+		// * copy the hdocbook content to the work folder
+		// * Render all markdown into side-by-side HTML file
+		// * Replace SERVER_VARS embedded in documents with the right version information etc.
+		// * Build an index (sqlite FTS5) by extracting text from all HTML content in the work
+		//   folder, conceptually we are making a little mini website crawler to index all of the content
+		//   within the book.
+		// * Package everything up into a ZIP file, ready for the build controller to package and publish
+
+		console.log("Hornbill HDocBook Build", "\n");
+		console.log("  Document Path:", source_path, "\n");
+		const build_start_dt = new Date().toLocaleString();
+
+		// Load the hdocbook-project.json file to get the docId
+		// use the docId to get the book config
+		const hdocbook_project_config_path = path.join(
+			source_path,
+			"hdocbook-project.json",
+		);
+		try {
+			hdocbook_project = require(hdocbook_project_config_path);
+		} catch (e) {
+			console.error("File not found: hdocbook-project.json\n");
+			console.error(
+				"hdoc build/validate needs to be run in the root of a HDoc Book.\n",
+			);
+			process.exit(1);
+		}
+		doc_id = hdocbook_project.docId;
+
+		if (
+			!validate &&
+			hdocbook_project.pdfGeneration !== undefined &&
+			hdocbook_project.pdfGeneration.enable !== undefined
+		) {
+			pdf_enable = hdocbook_project.pdfGeneration.enable;
+		}
+
+		if (
+			hdocbook_project.redirects &&
+			Array.isArray(hdocbook_project.redirects)
+		) {
+			for (let i = 0; i < hdocbook_project.redirects.length; i++) {
+				const redirect_key =
+					hdocbook_project.redirects[i].url.indexOf("/") === 0
+						? hdocbook_project.redirects[i].url.substring(1)
+						: hdocbook_project.redirects[i].url;
+				redirects[redirect_key] = hdocbook_project.redirects[i];
+			}
+		}
+
+		console.log("Loading hdocbook config...");
+
+		const book_path = path.join(source_path, doc_id);
+		const hdocbook_path = path.join(book_path, "hdocbook.json");
+		const work_path = path.join(source_path, "_work");
+		const work_hdocbook_path = path.join(work_path, doc_id, "hdocbook.json");
+
+		hdocbook_config = require(hdocbook_path);
+		if (build_version !== "") {
+			if (build_version.match(regex_version)) {
+				hdocbook_config.version = build_version;
+			} else {
+				console.info(
+					`\n[WARNING] Argument build version [${build_version}] does not match expected pattern, defaulting to version specified in book [${hdocbook_config.version}]\n`,
+				);
+			}
+		}
+
+		if (!hdocbook_config.version.match(regex_version)) {
+			console.error(
+				`ERROR: Version number does not match required format - ${hdocbook_config.version}\n`,
+			);
+			process.exit(1);
+		}
+
+		if (hdocbook_config.publicSource?.endsWith(".git"))
+			hdocbook_config.publicSource = hdocbook_config.publicSource.substring(
+				0,
+				hdocbook_config.publicSource.length - 4,
+			);
+
+		console.log("Loading product families...");
+		const prods = await hdoc.load_product_families();
+		if (!prods.success) {
+			console.error(`${prods.errors}\n`);
+			process.exit(1);
+		} else {
+			prod_families = prods.prod_families;
+			prods_supported = prods.prods_supported;
+		}
+
+		if (!validate) {
+			console.log("Caching CSS for PDF generation...");
+			const css_files = [
+				path.join(pdf_template_path, "css", "custom-block.css"),
+				path.join(pdf_template_path, "css", "hdocs-pdf.css"),
+				path.join(pdf_template_path, "css", "vars.css"),
+				path.join(
+					ui_css_path,
+					"theme-default",
+					"styles",
+					"components",
+					"api-doc.css",
+				),
+			];
+			for (let i = 0; i < css_files.length; i++) {
+				try {
+					css_templates.push(fs.readFileSync(css_files[i], "utf8"));
+				} catch (e) {
+					console.error(`Error reading file[${css_files[i]}]: ${e}`);
+				}
+			}
+		}
+
+		// Validate all filenames first
+		console.log("Validating book filenames meet kebab-case requirements...");
+		dree.scan(book_path, dreeOptionsAllFiles, filename_validation_callback);
+		if (errors_filename.length > 0) {
+			console.log("\r\n-----------------------");
+			console.log("   Validation Output   ");
+			console.log("-----------------------");
+			console.error(
+				`${errors_filename.length} files do not meet filename requirements:`,
+			);
+			console.error(` - ${errors_filename.join("\n - ")}`);
+			console.log();
+			process.exit(1);
+		}
+
+		console.log(`Building: ${doc_id} v${hdocbook_config.version}...\n`);
+
+		// Make _work folder to copy everything into
+		work_path_content = path.join(work_path, doc_id);
+		if (fs.existsSync(work_path)) {
+			fs.rmSync(work_path, {
+				recursive: true,
+				force: true,
+			});
+		}
+		fs.mkdirSync(work_path);
+
+		const file_filter = (src) => {
+			return !src.toLowerCase().endsWith(".ds_store");
+		};
+
+		// Copy files from book into _work-doc_id folder
+		console.log("Copying content into work folder...");
+		try {
+			fs.copySync(path.join(source_path, doc_id), work_path_content, {
+				filter: file_filter,
+			});
+		} catch (e) {
+			console.error("Error copying from source_path:\n", e);
+			process.exit(1);
+		}
+
+		// Create MD5 hash of content before build
+		console.log("Creating Hash...");
+
+		dree.scan(work_path_content, md5DreeOptions, hash_callback);
+		let concat_hash = "|";
+		for (let i = 0; i < built_file_hashes.length; i++) {
+			concat_hash += `${built_file_hashes[i].path}:${built_file_hashes[i].hash}|`;
+		}
+		if (concat_hash === "|") {
+			console.error("No hash of content has been returned.");
+			process.exit(1);
+		}
+
+		// Create hash and write file
+		const hash = crypto.createHash("md5").update(concat_hash).digest("hex");
+		const checksum_path = path.join(work_path_content, "checksum.md5");
+		try {
+			fs.writeFileSync(checksum_path, hash);
+			console.log("Hash file creation success:", checksum_path);
+		} catch (e) {
+			console.error("\nError creating", checksum_path, ":", e);
+			process.exit(1);
+		}
+
+		// Load document header templates
+		console.log("Loading templates...");
+		try {
+			doc_header_template = fs.readFileSync(doc_header_template_path, "utf8");
+			doc_header_template_non_git = fs.readFileSync(
+				non_git_doc_header_template_path,
+				"utf8",
+			);
+			pdf_header_template = fs.readFileSync(pdf_header_template_path, "utf8");
+			pdf_header_template_non_git = fs.readFileSync(
+				non_git_pdf_header_template_path,
+				"utf8",
+			);
+		} catch (err) {
+			console.error(`Error reading document header template: ${err}`);
+			process.exit(1);
+		}
+
+		if (pdf_enable) {
+			// Load PDF templates
+			try {
+				pdf_template = fs.readFileSync(pdf_template_file_path, "utf8");
+			} catch (err) {
+				console.error(`Error reading PDF template: ${err}`);
+				process.exit(1);
+			}
+		}
+		console.log("Processing navigation breadcrumbs...");
+		const bc_build = hdoc.build_breadcrumbs(hdocbook_config.navigation.items);
+		if (bc_build.errors.length > 0) {
+			console.log("\r\n-----------------------");
+			console.log("   Validation Output   ");
+			console.log("-----------------------");
+			console.log(
+				`\n${bc_build.errors.length} errors found when processing navigation:\n`,
+			);
+			console.error(` - ${bc_build.errors.join("\n\n - ")}`);
+			console.log("\n");
+			process.exit(1);
+		}
+		bc = bc_build.bc;
+		console.log("Processing content...");
+		// Get a list of MD files in work_path
+		dree.scan(work_path, dreeOptions, build_file_callback);
+
+		if (pdf_enable) {
+			// Create a Chromium browser instance generate PDFs with
+			browser = await puppeteer.launch({ headless: "shell" });
+		}
+
+		// Work through MD files and convert to HTML
+		const mdPromiseArray = [];
+		for (let i = 0; i < md_files.length; i++) {
+			mdPromiseArray.push(md_files[i]);
+		}
+		const chunkSize = 8;
+		for (let i = 0; i < mdPromiseArray.length; i += chunkSize) {
+			const chunk = mdPromiseArray.slice(i, i + chunkSize);
+			// do whatever
+			await Promise.all(
+				chunk.map(async (file) => {
+					await transform_markdown_and_save_html(file);
+				}),
+			);
+		}
+
+		// Work through Static HTML files and add Frontmatter tags
+		const htmlPromiseArray = [];
+		for (let i = 0; i < static_html_files.length; i++) {
+			htmlPromiseArray.push(static_html_files[i]);
+		}
+		for (let i = 0; i < htmlPromiseArray.length; i += chunkSize) {
+			const chunk = htmlPromiseArray.slice(i, i + chunkSize);
+			await Promise.all(
+				chunk.map(async (file) => {
+					await transform_static_html(file);
+				}),
+			);
+		}
+
+		if (pdf_enable) {
+			// Close the Chromium browser instance
+			await browser.close();
+		}
+
+		// Output to console
+		console.log(`\n                MD files found: ${conversion_attempted}`);
+		console.log(`Successfully converted to HTML: ${conversion_success}`);
+		if (conversion_failed > 0)
+			console.error(`             Failed to convert: ${conversion_failed}\n`);
+		else console.log(`             Failed to convert: ${conversion_failed}\n`);
+		console.log(`                Includes Found: ${includes_found}`);
+		console.log(`              Includes Success: ${includes_success}`);
+		if (includes_failed > 0)
+			console.error(`               Includes Failed: ${includes_failed}\n`);
+		else console.log(`               Includes Failed: ${includes_failed}\n`);
+		console.log(
+			`       Static HTML Files Found: ${static_html_files.length}\n`,
+		);
+		if (!validate) {
+			console.log(`             PDF Files Created: ${pdf_created}\n`);
+		}
+
+		// Validate content
+		const validation_success = await hdoc_validate.run(
+			work_path,
+			doc_id,
+			verbose,
+			hdocbook_config,
+			hdocbook_project,
+			bc,
+			prod_families,
+			prods_supported,
+			gen_exclude,
+			redirects,
+		);
+		if (!validation_success) {
+			const end_time = Date.now();
+			console.log(`\nTime Taken: ${get_duration(start_time, end_time)}\n`);
+			process.exit(1);
+		}
+
+		// Delete markdown files
+		console.log("Performing Markdown Cleanup");
+
+		const filePromiseArray = [];
+		for (let i = 0; i < md_files_delete.length; i++) {
+			filePromiseArray.push(md_files_delete[i]);
+		}
+		await Promise.all(
+			filePromiseArray.map(async (file) => {
+				fs.unlink(file, (err) => {
+					if (err) console.error(`Error deleting ${file}: ${e}`);
+				});
+			}),
+		);
+
+		// Add book read timing to the hdocbook.json
+		hdocbook_config.readingTime = Math.ceil(
+			book_read_time + (book_read_time / 100) * 10,
+		);
+		hdocbook_config.navigation.items = hdoc.strip_drafts(
+			hdocbook_config.navigation.items,
+		);
+		try {
+			fs.writeFileSync(
+				work_hdocbook_path,
+				JSON.stringify(hdocbook_config, null, 2),
+			);
+			console.log("\nhdocbook.json update success:", work_hdocbook_path);
+		} catch (e) {
+			console.error("\nError creating", work_hdocbook_path, ":", e);
+			process.exit(1);
+		}
+
+		// Build the index
+		// Create the DB and tables
+		console.log("Building the Index");
+		const db = hdoc_build_db.create_db(work_path, doc_id);
+		if (db.error && db.error !== null) {
+			console.error(db.error);
+			process.exit(1);
+		}
+		// Populate primary index tables
+		const index = await hdoc_build_db.populate_index(
+			db.db,
+			doc_id,
+			hdocbook_config,
+			index_records,
+			verbose,
+		);
+		if (!index.success) {
+			console.error(index.error);
+			process.exit(1);
+		}
+
+		// Populate redirect index table records
+		if (
+			hdocbook_project.redirects &&
+			Array.isArray(hdocbook_project.redirects) &&
+			hdocbook_project.redirects.length > 0
+		) {
+			const redirects_index = hdoc_build_db.populate_redirects(
+				db.db,
+				hdocbook_project.redirects,
+				verbose,
+			);
+			if (!redirects_index.success) {
+				for (let i = 0; i < index.errors.length; i++) {
+					console.error(index.errors[i]);
+				}
+				process.exit(1);
+			}
+		}
+
+		if (!validate) {
+			try {
+				const zip_path = path.join(work_path, `${doc_id}.zip`);
+
+				const output = fs.createWriteStream(zip_path);
+				const archive = archiver("zip");
+				archive.on("error", (err) => {
+					throw err;
+				});
+				archive.pipe(output);
+
+				// append files from a sub-directory, putting its contents at the root of archive
+				archive.directory(work_path_content, false);
+				archive.finalize();
+
+				//await zip(work_path_content, zip_path);
+				console.log(`\nZIP Creation Success: ${zip_path}\n`);
+				console.log("  Build Started:", build_start_dt);
+				console.log(`Build Completed: ${new Date().toLocaleString()}\n`);
+			} catch (e) {
+				console.error(`\nError creating ZIP: ${e}`);
+			}
+		} else {
+			console.log("\nValidation Complete\n");
+		}
+		const end_time = Date.now();
+		console.log(`Time Taken: ${get_duration(start_time, end_time)}\n`);
+	};
+
+	const get_duration = (start, end) => {
+		const total_time = new Date(end - start).toISOString().slice(11, 19);
+		const duration_arr = total_time.split(":");
+		let duration = "";
+		if (Number.parseInt(duration_arr[0], 10) > 0) {
+			duration += `${Number.parseInt(duration_arr[0], 10)}h `;
+		}
+		if (duration !== "" || Number.parseInt(duration_arr[1], 10)) {
+			duration += `${Number.parseInt(duration_arr[1], 10)}m `;
+		}
+		duration += `${Number.parseInt(duration_arr[2], 10)}s`;
+		return duration;
+	};
+})();