add summaries to js code

Author: cortex-lp

assets/js/generate-lunr-index.js

@@ -1,6 +1,13 @@
 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.

assets/js/offline-search.js

@@ -1,31 +1,26 @@
-// Adapted from code by Matt Walters https://www.mattwalters.net/posts/hugo-and-lunr/
+
+/**
+ * This script is used for the offline search feature.
+ * It calls the worker.js to generate the index and search the index.
+ * 
+ * Adapted from code by Matt Walters https://www.mattwalters.net/posts/hugo-and-lunr/
+ */
 
 (function ($) {
     'use strict';
 
     $(document).ready(function () {
         const $searchInput = $('.td-search-input');
 
-        //
-        // Options for popover
-        //
-
         $searchInput.data('html', true);
         $searchInput.data('placement', 'bottom');
         $searchInput.data(
             'template',
             '<div class="popover offline-search-result" role="tooltip"><div class="arrow"></div><h3 class="popover-header"></h3><div class="popover-body"></div></div>'
         );
 
-        //
-        // Lunr
-        //
-
-        let idx = null; // Lunr index
-        const resultDetails = new Map(); // Will hold the data for the search results (titles and summaries)
         let worker = null;
 
-
         if (window.Worker) {
             worker = new Worker('/js/worker.js');
             const url = '/lunr-index.json';
@@ -128,15 +123,9 @@
         }
 
         const render = ($targetSearchInput) => {
-            // Dispose the previous result
             $targetSearchInput.popover('dispose');
             currentTarget = $targetSearchInput;
 
-            //
-            // Search
-            //
-
-
             const searchQuery = $targetSearchInput.val();
             if (searchQuery === '') {
                 return;
@@ -150,10 +139,7 @@
             });
         };
 
-        //
-        // Register handler
-        //
-
+        // Renders the search results when the input changes.
         $searchInput.on('change', (event) => {
             render($(event.target));
 

assets/js/worker.js

@@ -1,15 +1,24 @@
+/**
+ * This worker is responsible for loading the lunr index, searching the index and returning the results.
+ * 
+ * It has 2 action types, 'init' and 'search'.
+ * 
+ * 'init' action is used to load the lunr index and the raw index data.
+ * 'search' action is used to search the lunr index with the provided query.
+ */
+
 if (typeof importScripts === 'function') {
     importScripts('https://unpkg.com/[email protected]/lunr.min.js');
 }
 
 let idx;
 const versionRegex = new RegExp("^\/docs\/([0-9\.]*|latest)\/");
-const resultDetails = new Map(); // Will hold the data for the search results (titles and summaries)
+const resultDetails = new Map();
 let indexReadyPromise;
 
-// Initialize the index
 self.onmessage = async function (event) {
     if (event.data.type === 'init') {
+        // Initialize the lunr index and the raw index data.
         indexReadyPromise = new Promise(async (resolve, reject) => {
             try {
                 const rawIndex = await fetch(event.data.rawIndexUrl);
@@ -33,6 +42,7 @@ self.onmessage = async function (event) {
             }
         });
     } else if (event.data.type === 'search') {
+        // Search the lunr index with the provided query.
         try {
             await indexReadyPromise;
             const regexResults = versionRegex.exec(event.data.currentPath);