@speajus/markdown-to-pdf 1.0.11 → 1.0.13

package/README.md

@@ -88,6 +88,7 @@ interface PdfOptions {
   syntaxHighlight?: boolean; // Enable syntax highlighting (default: true)
   lineNumbers?: boolean;   // Show line numbers in code blocks (default: false)
   languages?: string[];    // Prism.js languages to load (default: all)
+  zebraStripes?: boolean;  // Zebra-stripe table rows (default: true)
 }
 ```
 
@@ -134,7 +135,7 @@ The full `ThemeConfig` interface exposes styles for:
 | `code.inline`  | Font, size, color, and background color              |
 | `code.block`   | Font, size, color, background color, and padding     |
 | `blockquote`   | Border color, border width, italic flag, and indent  |
-| `table`        | Header background, border color, and cell padding    |
+| `table`        | Header background, border color, cell padding, and zebra color |
 | `linkColor`    | Color for hyperlink text                             |
 | `horizontalRuleColor` | Color for `---` dividers                      |
 

package/dist/browser.d.ts

@@ -1,6 +1,9 @@
+/**
+ * Browser-specific entry point that excludes Node.js dependencies
+ */
 export { createBrowserImageRenderer } from "./browser-image-renderer.js";
 export { createBrowserColorEmojiRenderer } from './color-emoji.js';
-export type { TextStyle, PageLayout, CodeStyle, CodeBlockStyle, BlockquoteStyle, TableStyles, TokenColors, SyntaxHighlightTheme, ThemeConfig, PdfOptions, ColorEmojiRenderer, } from './types.js';
+export type { TextStyle, PageLayout, CodeStyle, CodeBlockStyle, BlockquoteStyle, TableStyles, TokenColors, SyntaxHighlightTheme, ThemeConfig, PdfOptions, ColorEmojiRenderer, CustomFontDefinition, } from './types.js';
 export { defaultTheme, defaultPageLayout, defaultSyntaxHighlightTheme } from './styles.js';
 export { themes, modernTheme, academicTheme, minimalTheme, oceanTheme } from './themes/index.js';
 export { renderMarkdownToPdf } from "./renderer.js";

package/dist/browser.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.renderMarkdownToPdf = exports.oceanTheme = exports.minimalTheme = exports.academicTheme = exports.modernTheme = exports.themes = exports.defaultSyntaxHighlightTheme = exports.defaultPageLayout = exports.defaultTheme = exports.createBrowserColorEmojiRenderer = exports.createBrowserImageRenderer = void 0;
+/**
+ * Browser-specific entry point that excludes Node.js dependencies
+ */
 var browser_image_renderer_js_1 = require("./browser-image-renderer.js");
 Object.defineProperty(exports, "createBrowserImageRenderer", { enumerable: true, get: function () { return browser_image_renderer_js_1.createBrowserImageRenderer; } });
 var color_emoji_js_1 = require("./color-emoji.js");

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-export type { TextStyle, PageLayout, CodeStyle, CodeBlockStyle, BlockquoteStyle, TableStyles, TokenColors, SyntaxHighlightTheme, ThemeConfig, PdfOptions, ColorEmojiRenderer, } from './types.js';
+export type { TextStyle, PageLayout, CodeStyle, CodeBlockStyle, BlockquoteStyle, TableStyles, TokenColors, SyntaxHighlightTheme, ThemeConfig, PdfOptions, ColorEmojiRenderer, CustomFontDefinition, } from './types.js';
 export { defaultTheme, defaultPageLayout, defaultSyntaxHighlightTheme } from './styles.js';
 export { renderMarkdownToPdf as generatePdf, renderMarkdownToPdf, } from "./renderer.js";
 export { createBrowserImageRenderer } from './browser-image-renderer.js';

package/dist/renderer.js

@@ -23,6 +23,7 @@ async function renderMarkdownToPdf(markdown, options) {
         (0, highlight_prism_js_1.loadHighlightLanguages)(options?.languages);
     }
     const lineNumbers = options?.lineNumbers ?? false;
+    const zebraStripes = options?.zebraStripes !== false;
     const emojiFontOpt = options?.emojiFont ?? true;
     // Use provided image renderer or create default Node.js renderer
     const imageRenderer = options?.renderImage ?? defaults_js_1.DEFAULTS.renderImage(basePath);
@@ -66,6 +67,26 @@ async function renderMarkdownToPdf(markdown, options) {
             // fall through without emoji support.
         }
     }
+    // ── Custom font registration ─────────────────────────────────────────────
+    // Register user-supplied font families so they can be referenced by name
+    // in ThemeConfig font fields.  Each variant is registered with a suffix:
+    //   name (regular), name-Bold, name-Italic, name-BoldItalic
+    // Missing variants fall back: boldItalic → bold → regular, italic → regular.
+    const customFontNames = new Set();
+    if (options?.customFonts) {
+        for (const cf of options.customFonts) {
+            try {
+                doc.registerFont(cf.name, cf.regular);
+                doc.registerFont(`${cf.name}-Bold`, cf.bold ?? cf.regular);
+                doc.registerFont(`${cf.name}-Italic`, cf.italic ?? cf.regular);
+                doc.registerFont(`${cf.name}-BoldItalic`, cf.boldItalic ?? cf.bold ?? cf.regular);
+                customFontNames.add(cf.name);
+            }
+            catch {
+                // Font registration failed — skip this font gracefully.
+            }
+        }
+    }
     // ── Color emoji pre-render ─────────────────────────────────────────────
     // When a colorEmoji renderer is provided, pre-scan the entire markdown for
     // every unique emoji and convert them all to PNG buffers up-front.  This
@@ -91,8 +112,38 @@ async function renderMarkdownToPdf(markdown, options) {
             doc.addPage();
         }
     }
-    /** Derive the italic variant of a PDFKit built-in font name. */
+    /** Check whether `font` (or its base name) is a registered custom font. */
+    function isCustomFont(font) {
+        if (customFontNames.has(font))
+            return true;
+        // Also match variant names like "Roboto-Bold"
+        const dash = font.lastIndexOf('-');
+        if (dash > 0)
+            return customFontNames.has(font.substring(0, dash));
+        return false;
+    }
+    /** Return the base (registered) name of a custom font, stripping any variant suffix. */
+    function customFontBase(font) {
+        if (customFontNames.has(font))
+            return font;
+        const dash = font.lastIndexOf('-');
+        if (dash > 0) {
+            const base = font.substring(0, dash);
+            if (customFontNames.has(base))
+                return base;
+        }
+        return font;
+    }
+    /** Derive the italic variant of a font name. */
     function italicVariant(font) {
+        // Custom fonts use Name-Italic / Name-BoldItalic
+        if (isCustomFont(font)) {
+            const base = customFontBase(font);
+            if (font.endsWith('-Bold'))
+                return `${base}-BoldItalic`;
+            return `${base}-Italic`;
+        }
+        // Built-in Times family
         if (font.startsWith('Times'))
             return font.replace(/-Bold$/, '-BoldItalic').replace(/^Times-Roman$/, 'Times-Italic');
         // Helvetica / Courier families use "Oblique"
@@ -100,22 +151,49 @@ async function renderMarkdownToPdf(markdown, options) {
             return font + 'Oblique';
         return font + '-Oblique';
     }
+    /** Resolve the correct font variant (regular / bold / italic / bold-italic). */
+    function resolveFont(baseFont, bold, italic) {
+        if (isCustomFont(baseFont)) {
+            const base = customFontBase(baseFont);
+            if (bold && italic)
+                return `${base}-BoldItalic`;
+            if (bold)
+                return `${base}-Bold`;
+            if (italic)
+                return `${base}-Italic`;
+            return base;
+        }
+        // Built-in PDFKit fonts — strip existing variant suffix before applying,
+        // so that e.g. 'Helvetica-Bold' + bold doesn't produce 'Helvetica-Bold-Bold'.
+        if (baseFont.startsWith('Times')) {
+            if (bold && italic)
+                return 'Times-BoldItalic';
+            if (bold)
+                return 'Times-Bold';
+            if (italic)
+                return 'Times-Italic';
+            return baseFont;
+        }
+        // Helvetica / Courier families: strip any existing variant suffix first
+        const family = baseFont.replace(/-(Bold|Oblique|BoldOblique)$/, '');
+        if (bold && italic)
+            return `${family}-BoldOblique`;
+        if (bold)
+            return `${family}-Bold`;
+        if (italic)
+            return `${family}-Oblique`;
+        return family;
+    }
     function applyBodyFont(bold, italic) {
         if (headingCtx) {
             // Inside a heading — use heading style as the base.
             let font = headingCtx.font;
-            if (italic)
-                font = italicVariant(font);
+            if (bold || italic)
+                font = resolveFont(font, bold, italic);
             doc.font(font).fontSize(headingCtx.fontSize).fillColor(headingCtx.color);
             return;
         }
-        let font = theme.body.font;
-        if (bold && italic)
-            font = 'Helvetica-BoldOblique';
-        else if (bold)
-            font = 'Helvetica-Bold';
-        else if (italic)
-            font = 'Helvetica-Oblique';
+        const font = resolveFont(theme.body.font, bold, italic);
         doc.font(font).fontSize(theme.body.fontSize).fillColor(theme.body.color);
     }
     function resetBodyFont() {
@@ -549,8 +627,16 @@ async function renderMarkdownToPdf(markdown, options) {
         doc.restore();
         y += rowH;
         // Body rows
-        for (const row of table.rows) {
+        const zebraColor = theme.table.zebraColor ?? '#f9f9f9';
+        for (let r = 0; r < table.rows.length; r++) {
+            const row = table.rows[r];
             ensureSpace(rowH);
+            // Zebra stripe: fill even rows (0-indexed, so odd visual rows) with a tinted background
+            if (zebraStripes && r % 2 === 1) {
+                doc.save();
+                doc.rect(startX, y, contentWidth, rowH).fill(zebraColor);
+                doc.restore();
+            }
             for (let c = 0; c < colCount; c++) {
                 const cellX = startX + c * colWidth;
                 await renderCellTokens(row[c], cellX + cellPad, y + textInsetY, colWidth - cellPad * 2, table.align[c] || 'left', false);
@@ -675,7 +761,7 @@ async function renderMarkdownToPdf(markdown, options) {
                 for (const child of t.tokens) {
                     if (child.type === 'paragraph') {
                         const p = child;
-                        const font = bq.italic ? 'Helvetica-Oblique' : theme.body.font;
+                        const font = bq.italic ? italicVariant(theme.body.font) : theme.body.font;
                         doc.font(font).fontSize(theme.body.fontSize).fillColor(theme.body.color);
                         doc.text('', textX, doc.y, { width: textWidth });
                         await renderInlineTokens(p.tokens, false, false, bq.italic);

package/dist/styles.js

@@ -55,8 +55,8 @@ exports.defaultTheme = {
         inline: {
             font: 'Courier',
             fontSize: 10,
-            color: '#c7254e',
-            backgroundColor: '#f9f2f4',
+            color: '#1a1a1a',
+            backgroundColor: '#f0f0f0',
         },
         block: {
             font: 'Courier',
@@ -78,6 +78,7 @@ exports.defaultTheme = {
         headerBackground: '#f0f0f0',
         borderColor: '#cccccc',
         cellPadding: 6,
+        zebraColor: '#f9f9f9',
     },
     syntaxHighlight: exports.defaultSyntaxHighlightTheme,
 };

package/dist/themes/index.js

@@ -16,13 +16,13 @@ exports.modernTheme = {
     },
     body: { font: 'Helvetica', fontSize: 11, color: '#2d3436', lineGap: 5 },
     code: {
-        inline: { font: 'Courier', fontSize: 10, color: '#e17055', backgroundColor: '#ffeaa7' },
+        inline: { font: 'Courier', fontSize: 10, color: '#2d3436', backgroundColor: '#e8e8e8' },
         block: { font: 'Courier', fontSize: 9, color: '#2d3436', backgroundColor: '#dfe6e9', padding: 10 },
     },
     blockquote: { borderColor: '#0d7377', borderWidth: 3, italic: true, indent: 20 },
     linkColor: '#0984e3',
     horizontalRuleColor: '#b2bec3',
-    table: { headerBackground: '#dfe6e9', borderColor: '#b2bec3', cellPadding: 7 },
+    table: { headerBackground: '#dfe6e9', borderColor: '#b2bec3', cellPadding: 7, zebraColor: '#f0f5f5' },
     syntaxHighlight: {
         background: '#e8f0f2',
         gutter: '#636e72',
@@ -52,13 +52,13 @@ exports.academicTheme = {
     },
     body: { font: 'Times-Roman', fontSize: 12, color: '#1a1a2e', lineGap: 4 },
     code: {
-        inline: { font: 'Courier', fontSize: 10, color: '#6c3483', backgroundColor: '#f4ecf7' },
+        inline: { font: 'Courier', fontSize: 10, color: '#1a1a2e', backgroundColor: '#ececec' },
         block: { font: 'Courier', fontSize: 9, color: '#1a1a2e', backgroundColor: '#f2f3f4', padding: 8 },
     },
     blockquote: { borderColor: '#6c3483', borderWidth: 2, italic: true, indent: 24 },
     linkColor: '#2e4057',
     horizontalRuleColor: '#aab7b8',
-    table: { headerBackground: '#eaecee', borderColor: '#aab7b8', cellPadding: 6 },
+    table: { headerBackground: '#eaecee', borderColor: '#aab7b8', cellPadding: 6, zebraColor: '#f7f8f8' },
     syntaxHighlight: {
         background: '#f2f3f4',
         gutter: '#7f8c8d',
@@ -88,13 +88,13 @@ exports.minimalTheme = {
     },
     body: { font: 'Helvetica', fontSize: 10, color: '#444444', lineGap: 5 },
     code: {
-        inline: { font: 'Courier', fontSize: 9, color: '#555555', backgroundColor: '#f7f7f7' },
+        inline: { font: 'Courier', fontSize: 9, color: '#333333', backgroundColor: '#eeeeee' },
         block: { font: 'Courier', fontSize: 9, color: '#444444', backgroundColor: '#fafafa', padding: 10 },
     },
     blockquote: { borderColor: '#cccccc', borderWidth: 2, italic: false, indent: 18 },
     linkColor: '#555555',
     horizontalRuleColor: '#e0e0e0',
-    table: { headerBackground: '#fafafa', borderColor: '#e0e0e0', cellPadding: 8 },
+    table: { headerBackground: '#fafafa', borderColor: '#e0e0e0', cellPadding: 8, zebraColor: '#f5f5f5' },
     syntaxHighlight: {
         background: '#f8f8f8',
         gutter: '#999999',
@@ -124,13 +124,13 @@ exports.oceanTheme = {
     },
     body: { font: 'Helvetica', fontSize: 11, color: '#2c3e50', lineGap: 4 },
     code: {
-        inline: { font: 'Courier', fontSize: 10, color: '#c0392b', backgroundColor: '#eaf2f8' },
+        inline: { font: 'Courier', fontSize: 10, color: '#1b2631', backgroundColor: '#e0e0e0' },
         block: { font: 'Courier', fontSize: 9, color: '#2c3e50', backgroundColor: '#eaf2f8', padding: 8 },
     },
     blockquote: { borderColor: '#2980b9', borderWidth: 3, italic: true, indent: 20 },
     linkColor: '#2471a3',
     horizontalRuleColor: '#aed6f1',
-    table: { headerBackground: '#d4e6f1', borderColor: '#85c1e9', cellPadding: 6 },
+    table: { headerBackground: '#d4e6f1', borderColor: '#85c1e9', cellPadding: 6, zebraColor: '#eaf2f8' },
     syntaxHighlight: {
         background: '#eaf2f8',
         gutter: '#5d6d7e',

package/dist/types.d.ts

@@ -34,6 +34,10 @@ export interface TableStyles {
     headerBackground: string;
     borderColor: string;
     cellPadding: number;
+    /** Background color for alternating (even) body rows when zebra striping is enabled.
+     *  @default '#f9f9f9'
+     */
+    zebraColor?: string;
 }
 export interface TokenColors {
     [key: string]: string;
@@ -69,6 +73,25 @@ export interface ThemeConfig {
      */
     syntaxHighlight?: SyntaxHighlightTheme;
 }
+/**
+ * A custom font definition providing font data for registration with PDFKit.
+ *
+ * Supply at minimum a `name` and `regular` buffer.  Missing bold / italic /
+ * bold-italic variants fall back: boldItalic → bold → regular,
+ * italic → regular, bold → regular.
+ */
+export interface CustomFontDefinition {
+    /** The name to use in ThemeConfig font fields (e.g. 'Roboto'). */
+    name: string;
+    /** Regular weight font data. */
+    regular: Buffer;
+    /** Bold variant (falls back to regular). */
+    bold?: Buffer;
+    /** Italic variant (falls back to regular). */
+    italic?: Buffer;
+    /** Bold-italic variant (falls back to bold or regular). */
+    boldItalic?: Buffer;
+}
 /** Converts a single emoji string to a PNG `Buffer`. */
 export type ColorEmojiRenderer = (emoji: string) => Promise<Buffer>;
 export interface PdfOptions {
@@ -107,6 +130,14 @@ export interface PdfOptions {
      * @default false
      */
     lineNumbers?: boolean;
+    /**
+     * Enable zebra striping (alternating row backgrounds) on tables.
+     *
+     * The stripe color is controlled by `theme.table.zebraColor`.
+     *
+     * @default true
+     */
+    zebraStripes?: boolean;
     /**
      * Emoji font configuration.
      *
@@ -134,4 +165,12 @@ export interface PdfOptions {
      * monochrome font or the body font.
      */
     colorEmoji?: ColorEmojiRenderer;
+    /**
+     * Custom font definitions to register with PDFKit.
+     *
+     * Each entry provides font data (as `Buffer`s) for a named font family
+     * with optional bold, italic, and bold-italic variants.  The `name` can
+     * then be used in any `ThemeConfig` font field (e.g. `body.font`).
+     */
+    customFonts?: CustomFontDefinition[];
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@speajus/markdown-to-pdf",
-  "version": "1.0.11",
+  "version": "1.0.13",
   "description": "A new project created with Intent by Augment.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",