Vitepress build fix and search improvements

Author: Gianluca Beil

internal/documentation/.vitepress/config.ts

@@ -4,6 +4,8 @@ import { defineConfig } from "vitepress";
 
 // markdown
 import MarkdownItImplicitFigures from "markdown-it-implicit-figures";
+import { pagefindPlugin } from 'vitepress-plugin-pagefind'
+
 
 import fs from "node:fs";
 import path from "node:path";
@@ -82,14 +84,6 @@ export default defineConfig({
 
 
     },
-
-    search: {
-      provider: "local",
-      //hotKeys: [], // disable hotkeys to avoid search while using UI5 web components input
-    },
-
-
-
   },
 
   markdown: {
@@ -106,7 +100,8 @@ export default defineConfig({
   vite: {
     build: {
       chunkSizeWarningLimit: 4000, // chunk for local search index dominates
-    }
+    },
+    plugins: [pagefindPlugin()]
   }
 });
 

internal/documentation/jsdoc-to-markdown.js

@@ -150,8 +150,9 @@ for (const file of fs.readdirSync(path.join("dist", "api"))) {
     // Point all js links to GitHub
     const linkMatches = markdown.matchAll(/"[^"]*\.[A-Za-z0-9]+\.[A-Za-z0-9]+[^"]*"/g);
     for (const linkMatch of linkMatches) {
+        if (!linkMatch[0].endsWith(".js.html\"")) continue;
         const githubUrl = packageTagName +
-            linkMatch[0].replaceAll("\"", "").replace(".js.html", "").replaceAll("_", "/").replace("project", "") +
+            linkMatch[0].replaceAll("\"", "").replace(".js.html", "").replaceAll("_", "/") +
             ".js";
         markdown = markdown
                     .replaceAll(linkMatch[0].replaceAll("\"", "") + "#line", githubUrl + "#L")
@@ -161,6 +162,8 @@ for (const file of fs.readdirSync(path.join("dist", "api"))) {
     // Add target="_blank" to the a element (Must link to external site) for a better user experience
     markdown = markdown.replaceAll("<a href=\"http", "<a target=\"_blank\" href=\"http");
 
+    markdown = stripHtmlComments(markdown);
+
     for (const aElement of markdown.matchAll(aElementRegex + "g")) {
         deadLinksCheckPromises.push(checkDeadlinks(aElement[1], filePath));
     }
@@ -183,6 +186,10 @@ async function checkDeadlinks(link, sourcePath) {
     }
 }
 
+function stripHtmlComments(str) {
+  return str.replace(/<!--[\s\S]*?-->/g, "");
+}
+
 console.log("Conversion done");
 console.log("Found", deadLinks.length, "dead links");
 if (deadLinks.length != 0) {

internal/documentation/jsdoc/templates/layout.tmpl

@@ -3,27 +3,14 @@
 // This file was initialy copied from https://github.com/clenemt/docdash/blob/-/tmpl/layout.tmpl
 // and adjusted to offer a customized footer according to the SAP Web Presence Policy.
 // See also the corresponding stylesheet content in lib/jsdoc/plugin/template/custom.css.
-// ##### END: MODIFIED BY SAP
 ?>
 
-<div id="main">
     <?js if (title != 'Home') { ?>
     <h1 class="page-title"><?js= title ?></h1>
     <?js } ?>
 
     <?js= content ?>
-    
-    <?js if (env.conf.docdash.disqus) { ?>
-    <div id="disqus_thread"></div>
-    <script>
-    (function() { // DON'T EDIT BELOW THIS LINE
-    var d = document, s = d.createElement('script');
-    s.src = '//<?js= env.conf.docdash.disqus ?>.disqus.com/embed.js';
-    s.setAttribute('data-timestamp', +new Date());
-    (d.head || d.body).appendChild(s);
-    })();
-    </script>
-    <noscript>Please enable JavaScript to view the <a href="https://disqus.com/?ref_noscript">comments powered by Disqus.</a></noscript>
-    <?js } ?>
-</div>
-</html>
+
+<?js
+// ##### END: MODIFIED BY SAP
+?>