Improve search speed and prevent page freeze

Author: cortex-lp

.github/workflows/checklink.yml

@@ -37,6 +37,9 @@ jobs:
           HUGO_ENVIRONMENT: production
           HUGO_ENV: production
         run: hugo --environment GitHubPages -d $GITHUB_WORKSPACE/dist --buildFuture
+      - name: Generate Search index
+        run: |
+          node ./assets/js/generate-lunr-index.js $GITHUB_WORKSPACE/dist
       - name: Test HTML
         uses: wjdp/htmltest-action@master
         with:

.github/workflows/hugo.yml

@@ -63,6 +63,9 @@ jobs:
           HUGO_ENV: production
         run: |
           hugo --environment GitHubPages
+      - name: Generate Search index
+        run: |
+          node ./assets/js/generate-lunr-index.js
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:

.gitignore

@@ -8,4 +8,5 @@ content/en/docs/latest/
 content/static/latest/
 content/static/**/*.dtmp
 content/static/**/*.bkp
-content/static/**/*.crswap
+content/static/**/*.crswap
+content/static/lunr-index.json

assets/js/generate-lunr-index.js

@@ -0,0 +1,54 @@
+const fs = require('fs');
+const lunr = require('lunr');
+
+/**
+ * This script is used to generate a lunr index from the offline-search-index.json file.
+ * Hugo must be built before running this script, as jt requires the offline-search-index.json file to have been generated.
+ * 
+ * The script will output a lunr-index.json file in the content/static directory and the docs directory.
+ */
+
+const args = process.argv.slice(2);
+
+// Arguments should only be provided from a pipeline build.
+const isFromPipeline = args[0] !== undefined;
+
+const source = isFromPipeline
+    ? args[0]
+    : "./docs";
+
+const destination = isFromPipeline
+    ? `${args[0]}`
+    : "./docs";
+
+const data = JSON.parse(fs.readFileSync(`${source}/offline-search-index.json`));
+
+const idx = lunr(function () {
+    this.ref('ref');
+    this.field('title', { boost: 5 });
+    this.field('categories', { boost: 3 });
+    this.field('tags', { boost: 3 });
+    this.field('description', { boost: 2 });
+    this.field('body');
+
+    data.forEach((doc) => {
+        if (doc
+            && doc.ref !== undefined
+            && !doc.ref.includes('/_shared/')
+        ) {
+            this.add(doc);
+        }
+    });
+});
+
+if (!isFromPipeline) {
+    fs.writeFileSync(`./content/static/lunr-index.json`, JSON.stringify(idx));
+}
+
+fs.writeFileSync(`${destination}/lunr-index.json`, JSON.stringify(idx));
+
+// check if file got created
+if (!fs.existsSync(`${destination}/lunr-index.json`)) {
+    console.error('Failed to create lunr index, hugo must be build using `hugo` command before running this script.');
+    process.exit(1);
+}