hdoc-tools 0.9.41 → 0.9.43

package/hdoc-build.js

@@ -24,7 +24,6 @@
         non_git_pdf_header_template_path = path.join(__dirname, 'templates', 'pdf-header-non-git.html'),
         pdf_template_path = path.join(__dirname, 'templates', 'pdf'),
         pdf_template_file_path = path.join(pdf_template_path, 'template.html'),
-        regex_set_version = /^[0-9]{1,3}[.][0-9]{1,3}[.][0-9]{0,6}$/,
         regex_version = /^[0-9]{1,3}[.][0-9]{1,3}[.][0-9]{1,6}$/;
 
     let bc = {}, // Breadcrumbs map
@@ -611,16 +610,16 @@
         if (!validate && hdocbook_project.pdfGeneration !== undefined && hdocbook_project.pdfGeneration.enable !== undefined) {
             pdf_enable = hdocbook_project.pdfGeneration.enable;
         }
-    
+
         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 !== '') {
             if (build_version.match(regex_version)) {
                 hdocbook_config.version = build_version;
             } else {
@@ -631,7 +630,7 @@
         if (!hdocbook_config.version.match(regex_version)) {
             console.log(`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);
 
@@ -660,7 +659,7 @@
                 }
             }
         }
-        
+
         console.log(`Building: ${doc_id} v${hdocbook_config.version}...\n`);
 
         // Make _work folder to copy everything into
@@ -684,7 +683,7 @@
 
         // 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++) {
@@ -736,7 +735,7 @@
 
         if (pdf_enable) {
             // Create a Chromium browser instance generate PDFs with
-            browser = await puppeteer.launch({headless: 'new'});
+            browser = await puppeteer.launch({ headless: 'new' });
         }
 
         // Work through MD files and convert to HTML
@@ -805,7 +804,7 @@
                 if (err) console.log(`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);
@@ -842,7 +841,7 @@
                 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.log('\nError creating ZIP: ' + e);
             }
@@ -853,8 +852,8 @@
         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 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) {

package/hdoc-module.js

@@ -299,7 +299,8 @@
         recurse_nav(return_nav);
         return return_nav;
     };
-    const recurse_nav = function(nav_items) {
+
+    const recurse_nav = function (nav_items) {
         for (const key in nav_items) {
             if (nav_items[key].draft) {
                 nav_items.splice(key, 1);
@@ -311,91 +312,42 @@
     };
 
     exports.build_breadcrumbs = function (nav_items) {
-        let bc = {};
-        // Steve - need to rework this to use recursion, as it's hard-coded for a maximum of 4 levels deep right now
-        for (let a = 0; a < nav_items.length; a++) {
-            const nav_a = nav_items[a];
-            const parent_a = nav_a.text;
-            if (nav_a.link) {
-                bc[nav_a.link] = [{
-                    text: nav_a.text,
-                    link: nav_a.link
-                }];
+        const bc = {};
+        const buildBreadcrumb = (items, parentLinks) => {
+
+            // Process parent links
+            let parentlink = true;
+            if (parentLinks.length > 0) {
+                if (parentLinks[0].link === undefined || parentLinks[0].link === '') parentlink = false;
+                if (parentLinks[1] && parentLinks[1].link === undefined && items.length > 0 && items[0].link) {
+                    parentLinks[1].link = items[0].link;
+                }
+                if (parentLinks[2] && parentLinks[2].link === undefined && items.length > 0 && items[0].link) {
+                    parentLinks[2].link = items[0].link;
+                }
             }
-            if (nav_a.items) {
-                for (let b = 0; b < nav_a.items.length; b++) {
-                    const nav_b = nav_a.items[b];
-                    const parent_b = nav_b.text;
-                    if (nav_b.link) {
-                        if (bc[nav_a.link]) {
-                            bc[nav_b.link] = bc[nav_a.link];
-                        } else {
-                            bc[nav_b.link] = [{
-                                text: parent_a,
-                                link: nav_a.items[0].link !== undefined ? nav_a.items[0].link : '' 
-                            }];
-                        }
-                        bc[nav_b.link].push({
-                            text: nav_b.text,
-                            link: nav_b.link
-                        });
-                    }
 
-                    if (nav_b.items) {
-                        for (let c = 0; c < nav_b.items.length; c++) {
-                            const nav_c = nav_b.items[c];
-                            const parent_c = nav_c.text;
-                            if (nav_c.link) {
-                                if (bc[nav_b.link]) {
-                                    bc[nav_c.link] = bc[nav_b.link];
-                                } else {
-                                    bc[nav_c.link] = [{
-                                        text: parent_a,
-                                        link: nav_a.items[0].link !== undefined ? nav_a.items[0].link : '' 
-                                    }];
-                                    bc[nav_c.link].push({
-                                        text: parent_b,
-                                        link: nav_b.items[0].link
-                                    });
-                                }
-                                bc[nav_c.link].push({
-                                    text: nav_c.text,
-                                    link: nav_c.link
-                                });
-                            }
+            // Loop through items, build breadcrumb
+            for (let i = 0; i < items.length; i++) {
+                const item = items[i];
+                if (!parentlink && item.link) {
+                    parentLinks[0].link = item.link;
+                    parentlink = true;
+                }
+                const { text, link, items: subItems } = item;
+                const breadcrumb = [...parentLinks, { text, link }];
 
-                            if (nav_c.items) {
-                                for (let d = 0; d < nav_c.items.length; d++) {
-                                    const nav_d = nav_c.items[d];
-                                    if (nav_d.link) {
-                                        if (bc[nav_c.link]) {
-                                            bc[nav_d.link] = bc[nav_c.link];
-                                        } else {
-                                            bc[nav_d.link] = [{
-                                                text: parent_a,
-                                                link: nav_a.items[0].link !== undefined ? nav_a.items[0].link : '' 
-                                            }];
-                                            bc[nav_d.link].push({
-                                                text: parent_b,
-                                                link: nav_b.items[0].link
-                                            });
-                                            bc[nav_d.link].push({
-                                                text: parent_c,
-                                                link: nav_c.items[0].link
-                                            });
-                                        }
-                                        bc[nav_d.link].push({
-                                            text: nav_d.text,
-                                            link: nav_d.link
-                                        });
-                                    }
-                                }
-                            }
-                        }
-                    }
+                if (link) {
+                    bc[link] = breadcrumb;
+                }
+
+                if (subItems) {
+                    buildBreadcrumb(subItems, breadcrumb);
                 }
             }
-        }
+        };
+
+        buildBreadcrumb(nav_items, []);
         return bc;
     };
 
@@ -406,7 +358,7 @@
             prods_supported: [],
             errors: ''
         };
-        
+
         try {
             const prods = await axios.get('https://docs.hornbill.com/_books/products.json', {
                 httpsAgent: agent

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hdoc-tools",
-  "version": "0.9.41",
+  "version": "0.9.43",
   "description": "Hornbill HDocBook Development Support Tool",
   "main": "hdoc.js",
   "bin": {
@@ -41,7 +41,6 @@
     "dree": "^3.4.2",
     "express": "^4.18.2",
     "fs-extra": "^11.1.0",
-    "highlight.js": "^11.6.0",
     "html-to-text": "^8.2.1",
     "js-yaml": "^4.1.0",
     "markdown-it": "^13.0.1",
@@ -56,4 +55,4 @@
     "words-count": "^2.0.2",
     "zip-a-folder": "^1.1.5"
   }
-}
+}

package/templates/pdf/css/hdocs-pdf.css

@@ -128,7 +128,7 @@ audio,
 iframe,
 embed,
 object {
-  display:none;
+  display: none;
 }
 
 figure {
@@ -240,4 +240,8 @@ video {
 
 .hdoc-alert.alert-icon-warning code {
   background-color: var(--htl-custom-block-warning-code-bg);
+}
+
+code {
+  font-size: 0.9em;
 }

package/templates/pdf/template.html

@@ -1,7 +1,20 @@
 <!DOCTYPE html>
 <html>
-    <head><link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap-icons@1.9.1/font/bootstrap-icons.css" /></head>
-    <body>
-        {{document_content}}
-    </body>
+
+<head>
+    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap-icons@1.9.1/font/bootstrap-icons.css" />
+    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.7.0/styles/vs2015.min.css">
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.7.0/highlight.min.js"></script>
+</head>
+
+<body>
+    {{document_content}}
+</body>
+<script type="text/javascript">
+
+    // Using highlightAll method to
+    // highlight the code
+    hljs.highlightAll();
+</script>
+
 </html>