hdoc-tools 0.8.23 → 0.8.25

package/hdoc-build-pdf.js

@@ -0,0 +1,169 @@
+(function () {
+    'use strict';
+
+    const cheerio = require('cheerio'),
+        dree = require('dree'),
+        fs = require('fs-extra'),
+        mime = require('mime-types'),
+        path = require('path'),
+        puppeteer = require('puppeteer'),
+        request = require('sync-request'),
+        hdoc = require(path.join(__dirname, 'hdoc-module.js'));
+
+    const dree_options = {
+        extensions: ['css'],
+        normalize: true,
+    };
+
+    let css_files = [],
+        hb_logo = '',
+        header = '',
+        footer = '';
+
+    const file_callback = function (element) {
+        css_files.push(element.path);
+    };
+
+    const get_footer = function (template_path) {
+        let footer_content = null;
+        try {
+            footer_content = fs.readFileSync(path.join(template_path, 'template-footer.html'), 'utf8');
+        } catch (err) {
+            console.log(`Error loading template: ${err}`);
+        }
+        return footer_content;
+    };
+
+    exports.process_images = async function (file_path, html_source, verbose) {
+        const book_work_root = file_path.path.replace(file_path.relativePath, '');
+        if (verbose) console.log('Parsing img tags from HTML source');
+
+        // Use cheerio to parse html
+        const $ = cheerio.load(html_source);
+        
+        // Get iFrames from HTML, to replace with a tags
+        let iframes = [];
+        const iframe_html = $('iframe').map(function () {
+            const response = {
+                html: $.html(this),
+                src: $(this).attr('src'),
+                title: $(this).attr('title') ? $(this).attr('title') : 'No Link Title Provided'
+            };
+            return response;
+        }).get();
+        iframes.push(...iframe_html);
+        for (let i = 0; i < iframes.length; i++) {
+            const link = `<p><a href="${iframes[i].src}">${iframes[i].title}</a></p>`;
+            const regex = new RegExp(`<iframe.*src="${iframes[i].src.replace('/', '\\/')}".*</iframe>`);
+            html_source = html_source.replace(regex, link);
+        }
+        
+        // Get image links from HTML, to embed into the pdf
+        let imgs = [];
+        const srcs = $('img').map(function (i) {
+            return $(this).attr('src');
+        }).get();
+        imgs.push(...srcs);
+        for (let i = 0; i < imgs.length; i++) {
+            if (hdoc.valid_url(imgs[i]).valid) {
+                // External Link
+                const file_response = request('GET', imgs[i]);
+                if (file_response.statusCode === 200) {
+                    const image_buffer = file_response.getBody();
+                    const mime_type = mime.lookup(imgs[i]);
+                    let image_b64 = image_buffer.toString("base64");
+                    image_b64 = `data:${mime_type};base64,${image_b64}`;
+                    html_source = html_source.replace(imgs[i], image_b64);
+                } else {
+                    throw `Unexpected Status ${file_response.statusCode}`;
+                }
+            } else {
+                // Internal link
+                const image_path = path.join(book_work_root, imgs[i].replace('_books/', ''));
+                try {
+                    const image_buffer = fs.readFileSync(image_path);
+                    const mime_type = mime.lookup(image_path);
+                    let image_b64 = image_buffer.toString("base64");
+                    image_b64 = `data:${mime_type};base64,${image_b64}`;
+                    html_source = html_source.replace(imgs[i], image_b64);
+                } catch (err) {
+                    console.log('Error reading image from HTML source [', image_path, '] - ', err);
+                    return null;
+                }
+            }
+        }
+
+        return html_source;
+    };
+
+    exports.generate_pdf = async function (pdf_template_path, pdf_template_content, book_config, html_source, target_file, verbose = false) {
+        if (verbose) console.log(`Generating PDF: ${target_file}`);
+
+        // Cache footer
+        if (footer === '') footer = get_footer(pdf_template_path);
+
+        // Read svg logo file into buffer, convert to B64 string 
+        if (hb_logo === '') {
+            const hb_logo_path = path.join(pdf_template_path, 'images', 'hornbill-logo-full.svg');
+            try {
+                const hb_logo_file_buffer = fs.readFileSync(hb_logo_path);
+                hb_logo = hb_logo_file_buffer.toString("base64");
+                hb_logo = `data:image/svg+xml;base64,${hb_logo}`;
+            } catch (err) {
+                console.log('Error reading logo from template:', err);
+                return;
+            }
+        }
+
+        html_source = pdf_template_content.replace('{{book_title}}', book_config.title).replace('{{document_content}}', html_source).replace('{{hb_logo}}', hb_logo);
+
+        // Create a browser instance
+        const browser = await puppeteer.launch();
+
+        // Create a new page
+        const page = await browser.newPage();
+
+        // Set HTML content from HTML source
+        await page.setContent(html_source, {
+            waitUntil: 'domcontentloaded'
+        });
+
+        // To reflect CSS used for screens instead of print
+        await page.emulateMediaType('screen');
+
+        if (css_files.length === 0) {
+            // Get a list of CSS files
+            dree.scan(pdf_template_path, dree_options, file_callback);
+        }
+
+        for (let i = 0; i < css_files.length; i++) {
+            await page.addStyleTag({
+                path: css_files[i]
+            });
+        }
+
+        try {
+            await page.pdf({
+                path: target_file,
+                margin: {
+                    top: '30px',
+                    right: '35px',
+                    bottom: '80px',
+                    left: '35px'
+                },
+                printBackground: true,
+                format: 'A4',
+                displayHeaderFooter: true,
+                headerTemplate: '<div />',
+                footerTemplate: footer
+            });
+            if (verbose) console.log('PDF generation success.');
+
+        } catch (err) {
+            console.log(`Error generating PDF ${target_file} - ${err}`);
+        }
+
+        // Close the browser instance
+        await browser.close();
+    };
+})();

package/hdoc-build.js

@@ -10,12 +10,17 @@
         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')),
         zipper = require('zip-local');
 
     const h_tags_to_search = ['h1', 'h2', 'h3'],
         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');
+        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'),
+        pdf_template_file_path = path.join(pdf_template_path, 'template.html');
 
     let bc = {}, // Breadcrumbs map
         book_read_time = 0,
@@ -25,6 +30,9 @@
         conversion_failed = 0,
         doc_header_template = '',
         doc_header_template_non_git = '',
+        pdf_header_template = '',
+        pdf_header_template_non_git = '',
+        pdf_template = '',
         doc_id = '',
         git_token = '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', // Github fine-grained personal access token that has minimum read-only access to Hornbill Docs org repo content
         hdocbook_config = {},
@@ -211,7 +219,7 @@
         }
     };
 
-    const transform_markdown_and_save_html = async function (file_path) {
+    const transform_markdown_and_save_html = async function (file_path, verbose) {
         conversion_attempted++;
         if (fs.existsSync(file_path.path)) {
             // Load markdown file
@@ -372,17 +380,24 @@
             fm_header += ']]-->';
 
             let doc_header = '';
+            let pdf_header = '';
             if (hdocbook_config.publicSource.includes('github.com/Hornbill-Docs')) {
                 // Build doc header from template and frontmatter tags
                 doc_header = process_doc_header(fm_headers, file_path.relativePath, doc_header_template);
+                pdf_header = process_doc_header(fm_headers, file_path.relativePath, pdf_header_template);
             } else {
                 // Build doc header from template and frontmatter tags
                 doc_header = process_doc_header(fm_headers, file_path.relativePath, doc_header_template_non_git);
+                pdf_header = process_doc_header(fm_headers, file_path.relativePath, pdf_header_template_non_git);
             }
-            /*
-            const pdf_html = `${fm_header}\n${doc_header}\n${html_txt}`;
-            const pdf_file = file_path.path.replace(path.extname(file_path.path), '.pdf');
-            */
+
+            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');
+            await hdoc_build_pdf.generate_pdf(pdf_template_path, pdf_template, hdocbook_config, pdf_txt, pdf_file_path, verbose);
+            
             html_txt = `${fm_header}\n${doc_header}\n${html_txt}`;
 
             // Save HTML into HTML file
@@ -658,21 +673,32 @@
         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.log(`Error reading document header template: ${err}`);
             process.exit(1);
         }
 
+        // Load PDF templates
+        try {
+            pdf_template = fs.readFileSync(pdf_template_file_path, 'utf8');
+        } catch (err) {
+            console.log(`Error reading PDF template: ${err}`);
+            process.exit(1);
+        }
+
         build_breadcrumbs(hdocbook_config.navigation.items);
 
+        console.log('Processing content...');
         // Get a list of MD files in work_path
         dree.scan(work_path, dreeOptions, build_file_callback);
 
         // Work through MD files and convert to HTML
         for (let i = 0; i < md_files.length; i++) {
-            await transform_markdown_and_save_html(md_files[i]);
+            await transform_markdown_and_save_html(md_files[i], verbose);
         }
-        
+
         // Work through Static HTML files and add Frontmatter tags
         for (let i = 0; i < static_html_files.length; i++) {
             await transform_static_html(static_html_files[i]);

package/hdoc-init.js

@@ -3,7 +3,6 @@
 
     // Required modules
     const prompt = require('prompt');
-    //const fs = require('fs');
     const fs = require('fs-extra');
     const path = require('path');
 

package/hdoc-validate.js

@@ -1,5 +1,3 @@
-const parseLinkDestination = require('markdown-it/lib/helpers/parse_link_destination');
-
 (function () {
     'use strict';
 

package/hdoc.js

@@ -1,4 +1,4 @@
-#!/usr/bin/env node
+#!/usr/bin/env node
 
 (async function () {
    'use strict';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hdoc-tools",
-  "version": "0.8.23",
+  "version": "0.8.25",
   "description": "Hornbill HDocBook Development Support Tool",
   "main": "hdoc.js",
   "bin": {
@@ -11,6 +11,7 @@
     "hdoc-db.js",
     "hdoc-build.js",
     "hdoc-build-db.js",
+    "hdoc-build-pdf.js",
     "hdoc-help.js",
     "hdoc-init.js",
     "hdoc-module.js",
@@ -43,9 +44,10 @@
     "markdown-it": "^13.0.1",
     "markdown-it-container": "^3.0.0",
     "markdown-it-front-matter": "^0.2.3",
+    "mime-types": "^2.1.35",
     "multer": "^1.4.5-lts.1",
-    "pdf-creator-node": "^2.3.5",
     "prompt": "^1.3.0",
+    "puppeteer": "^19.6.0",
     "stream": "0.0.2",
     "sync-request": "^6.1.0",
     "words-count": "^2.0.2",

package/templates/pdf/css/custom-block.css

@@ -0,0 +1,90 @@
+.custom-block {
+  border: 1px solid transparent;
+  border-radius: 8px;
+  padding: 16px 16px 8px;
+  line-height: 24px;
+  font-size: var(--htl-default-font-size);
+  color: var(--htl-c-text-2);
+}
+
+.custom-block.info {
+  border-color: var(--htl-custom-block-info-border);
+  color: var(--htl-custom-block-info-text);
+  background-color: var(--htl-custom-block-info-bg);
+}
+
+.custom-block.info code {
+  background-color: var(--htl-custom-block-info-code-bg);
+}
+
+.custom-block.tip {
+  border-color: var(--htl-custom-block-tip-border);
+  color: var(--htl-custom-block-tip-text);
+  background-color: var(--htl-custom-block-tip-bg);
+}
+
+.custom-block.tip code {
+  background-color: var(--htl-custom-block-tip-code-bg);
+}
+
+.custom-block.warning {
+  border-color: var(--htl-custom-block-warning-border);
+  color: var(--htl-custom-block-warning-text);
+  background-color: var(--htl-custom-block-warning-bg);
+}
+
+.custom-block.warning code {
+  background-color: var(--htl-custom-block-warning-code-bg);
+}
+
+.custom-block.danger {
+  border-color: var(--htl-custom-block-danger-border);
+  color: var(--htl-custom-block-danger-text);
+  background-color: var(--htl-custom-block-danger-bg);
+}
+
+.custom-block.danger code {
+  background-color: var(--htl-custom-block-danger-code-bg);
+}
+
+.custom-block.details {
+  border-color: var(--htl-custom-block-details-border);
+  color: var(--htl-custom-block-details-text);
+  background-color: var(--htl-custom-block-details-bg);
+}
+
+.custom-block.details code {
+  background-color: var(--htl-custom-block-details-code-bg);
+}
+
+.custom-block-title {
+  font-weight: 700;
+}
+
+.custom-block p + p {
+  margin: 8px 0;
+}
+
+.custom-block.details summary {
+  margin: 0 0 8px;
+  font-weight: 700;
+}
+
+.custom-block.details summary + p {
+  margin: 8px 0;
+}
+
+.custom-block a {
+  color: inherit;
+  font-weight: 600;
+  text-decoration: underline;
+  transition: opacity 0.25s;
+}
+
+.custom-block a:hover {
+  opacity: 0.6;
+}
+
+.custom-block code {
+  font-size: var(--htl-custom-block-code-font-size);
+}

package/templates/pdf/css/fonts.css

@@ -0,0 +1,221 @@
+/* webfont-marker-begin */
+@import url('https://fonts.googleapis.com/css2?family=Inter:wght@100..900&display=swap');
+/* webfont-marker-end */
+
+@font-face {
+  font-family: 'Inter var';
+  font-weight: 100 900;
+  font-display: swap;
+  font-style: normal;
+  font-named-instance: 'Regular';
+  src: url('../fonts/inter-roman-cyrillic.woff2') format('woff2');
+  unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;
+}
+
+@font-face {
+  font-family: 'Inter var';
+  font-weight: 100 900;
+  font-display: swap;
+  font-style: normal;
+  font-named-instance: 'Regular';
+  src: url('../fonts/inter-roman-cyrillic-ext.woff2') format('woff2');
+  unicode-range: U+0460-052F, U+1C80-1C88, U+20B4, U+2DE0-2DFF, U+A640-A69F,
+    U+FE2E-FE2F;
+}
+
+@font-face {
+  font-family: 'Inter var';
+  font-weight: 100 900;
+  font-display: swap;
+  font-style: normal;
+  font-named-instance: 'Regular';
+  src: url('../fonts/inter-roman-greek.woff2') format('woff2');
+  unicode-range: U+0370-03FF;
+}
+
+@font-face {
+  font-family: 'Inter var';
+  font-weight: 100 900;
+  font-display: swap;
+  font-style: normal;
+  font-named-instance: 'Regular';
+  src: url('../fonts/inter-roman-greek-ext.woff2') format('woff2');
+  unicode-range: U+1F00-1FFF;
+}
+
+@font-face {
+  font-family: 'Inter var';
+  font-weight: 100 900;
+  font-display: swap;
+  font-style: normal;
+  font-named-instance: 'Regular';
+  src: url('../fonts/inter-roman-latin.woff2') format('woff2');
+  unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA,
+    U+02DC, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215,
+    U+FEFF, U+FFFD;
+}
+
+@font-face {
+  font-family: 'Inter var';
+  font-weight: 100 900;
+  font-display: swap;
+  font-style: normal;
+  font-named-instance: 'Regular';
+  src: url('../fonts/inter-roman-latin-ext.woff2') format('woff2');
+  unicode-range: U+0100-024F, U+0259, U+1E00-1EFF, U+2020, U+20A0-20AB,
+    U+20AD-20CF, U+2113, U+2C60-2C7F, U+A720-A7FF;
+}
+
+@font-face {
+  font-family: 'Inter var';
+  font-weight: 100 900;
+  font-display: swap;
+  font-style: normal;
+  font-named-instance: 'Regular';
+  src: url('../fonts/inter-roman-vietnamese.woff2') format('woff2');
+  unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1,
+    U+01AF-01B0, U+1EA0-1EF9, U+20AB;
+}
+
+@font-face {
+  font-family: 'Inter var';
+  font-weight: 100 900;
+  font-display: swap;
+  font-style: italic;
+  font-named-instance: 'Italic';
+  src: url('../fonts/inter-italic-cyrillic.woff2') format('woff2');
+  unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;
+}
+
+@font-face {
+  font-family: 'Inter var';
+  font-weight: 100 900;
+  font-display: swap;
+  font-style: italic;
+  font-named-instance: 'Italic';
+  src: url('../fonts/inter-italic-cyrillic-ext.woff2') format('woff2');
+  unicode-range: U+0460-052F, U+1C80-1C88, U+20B4, U+2DE0-2DFF, U+A640-A69F,
+    U+FE2E-FE2F;
+}
+
+@font-face {
+  font-family: 'Inter var';
+  font-weight: 100 900;
+  font-display: swap;
+  font-style: italic;
+  font-named-instance: 'Italic';
+  src: url('../fonts/inter-italic-greek.woff2') format('woff2');
+  unicode-range: U+0370-03FF;
+}
+
+@font-face {
+  font-family: 'Inter var';
+  font-weight: 100 900;
+  font-display: swap;
+  font-style: italic;
+  font-named-instance: 'Italic';
+  src: url('../fonts/inter-italic-greek-ext.woff2') format('woff2');
+  unicode-range: U+1F00-1FFF;
+}
+
+@font-face {
+  font-family: 'Inter var';
+  font-weight: 100 900;
+  font-display: swap;
+  font-style: italic;
+  font-named-instance: 'Italic';
+  src: url('../fonts/inter-italic-latin.woff2') format('woff2');
+  unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA,
+    U+02DC, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215,
+    U+FEFF, U+FFFD;
+}
+
+@font-face {
+  font-family: 'Inter var';
+  font-weight: 100 900;
+  font-display: swap;
+  font-style: italic;
+  font-named-instance: 'Italic';
+  src: url('../fonts/inter-italic-latin-ext.woff2') format('woff2');
+  unicode-range: U+0100-024F, U+0259, U+1E00-1EFF, U+2020, U+20A0-20AB,
+    U+20AD-20CF, U+2113, U+2C60-2C7F, U+A720-A7FF;
+}
+
+@font-face {
+  font-family: 'Inter var';
+  font-weight: 100 900;
+  font-display: swap;
+  font-style: italic;
+  font-named-instance: 'Italic';
+  src: url('../fonts/inter-italic-vietnamese.woff2') format('woff2');
+  unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1,
+    U+01AF-01B0, U+1EA0-1EF9, U+20AB;
+}
+
+@font-face {
+  font-family: 'Inter var experimental';
+  font-weight: 100 900;
+  font-display: swap;
+  font-style: oblique 0deg 10deg;
+  src: url('../fonts/inter-cyrillic.woff2') format('woff2');
+  unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;
+}
+
+@font-face {
+  font-family: 'Inter var experimental';
+  font-weight: 100 900;
+  font-display: swap;
+  font-style: oblique 0deg 10deg;
+  src: url('../fonts/inter-cyrillic-ext.woff2') format('woff2');
+  unicode-range: U+0460-052F, U+1C80-1C88, U+20B4, U+2DE0-2DFF, U+A640-A69F,
+    U+FE2E-FE2F;
+}
+
+@font-face {
+  font-family: 'Inter var experimental';
+  font-weight: 100 900;
+  font-display: swap;
+  font-style: oblique 0deg 10deg;
+  src: url('../fonts/inter-greek.woff2') format('woff2');
+  unicode-range: U+0370-03FF;
+}
+
+@font-face {
+  font-family: 'Inter var experimental';
+  font-weight: 100 900;
+  font-display: swap;
+  font-style: oblique 0deg 10deg;
+  src: url('../fonts/inter-greek-ext.woff2') format('woff2');
+  unicode-range: U+1F00-1FFF;
+}
+
+@font-face {
+  font-family: 'Inter var experimental';
+  font-weight: 100 900;
+  font-display: swap;
+  font-style: oblique 0deg 10deg;
+  src: url('../fonts/inter-latin.woff2') format('woff2');
+  unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA,
+    U+02DC, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215,
+    U+FEFF, U+FFFD;
+}
+
+@font-face {
+  font-family: 'Inter var experimental';
+  font-weight: 100 900;
+  font-display: swap;
+  font-style: oblique 0deg 10deg;
+  src: url('../fonts/inter-latin-ext.woff2') format('woff2');
+  unicode-range: U+0100-024F, U+0259, U+1E00-1EFF, U+2020, U+20A0-20AB,
+    U+20AD-20CF, U+2113, U+2C60-2C7F, U+A720-A7FF;
+}
+
+@font-face {
+  font-family: 'Inter var experimental';
+  font-weight: 100 900;
+  font-display: swap;
+  font-style: oblique 0deg 10deg;
+  src: url('../fonts/inter-vietnamese.woff2') format('woff2');
+  unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1,
+    U+01AF-01B0, U+1EA0-1EF9, U+20AB;
+}