@speajus/markdown-to-pdf 1.0.12 → 1.0.14

package/README.md

@@ -2,7 +2,7 @@
 
 A lightweight TypeScript library that converts Markdown files into styled PDF documents. Built on [marked](https://github.com/markedjs/marked) for parsing and [PDFKit](https://pdfkit.org/) for PDF generation. [README.pdf](./README.pdf) | [Live Demo](https://speajus.github.io/markdown-to-pdf/)
 
-[![Live Demo](./docs/image.png)](https://speajus.github.io/markdown-to-pdf/)
+-[![Live Demo](./docs/image.png)]([https://speajus.github.io/markdown-to-pdf/](https://speajus.github.io/markdown-to-pdf/))
 
 ## Features
 
@@ -128,16 +128,16 @@ await generatePdf(markdown, {
 
 The full `ThemeConfig` interface exposes styles for:
 
-| Section        | Configurable properties                             |
-| -------------- | --------------------------------------------------- |
-| `headings`     | Font, size, and color for each level (h1–h6)        |
-| `body`         | Font, size, color, and line gap                     |
-| `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, cell padding, and zebra color |
-| `linkColor`    | Color for hyperlink text                             |
-| `horizontalRuleColor` | Color for `---` dividers                      |
+| Section | Configurable properties |
+| --- | --- |
+| headings | Font, size, and color for each level (h1–h6) |
+| body | Font, size, color, and line gap |
+| 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, cell padding, and zebra color |
+| linkColor | Color for hyperlink text |
+| horizontalRuleColor | Color for --- dividers |
 
 ## Project Structure
 
@@ -163,18 +163,18 @@ The full `ThemeConfig` interface exposes styles for:
 ## Dependencies
 
 | Package | Purpose |
-| ------- | ------- |
-| [marked](https://github.com/markedjs/marked) | Markdown parsing and tokenization |
-| [pdfkit](https://pdfkit.org/) | PDF document generation |
-| [@resvg/resvg-js](https://github.com/nicolo-ribaudo/resvg-js) | SVG-to-PNG rasterization for image embedding |
+| --- | --- |
+| marked | Markdown parsing and tokenization |
+| pdfkit | PDF document generation |
+| @resvg/resvg-js | SVG-to-PNG rasterization for image embedding |
 
 ## Scripts
 
 | Command | Description |
-| ------- | ----------- |
-| `npm run build` | Compile TypeScript to `dist/` |
-| `npm run generate` | Generate sample PDFs from `samples/*.md` into `output/` |
+| --- | --- |
+| npm run build | Compile TypeScript to dist/ |
+| npm run generate | Generate sample PDFs from samples/*.md into output/ |
 
 ## License
 
-ISC
+ISC

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/cli.js

@@ -9,6 +9,9 @@ const path_1 = __importDefault(require("path"));
 const fs_1 = __importDefault(require("fs"));
 const index_js_1 = require("./index.js");
 async function readMdWritePdf(inputPath, outputPath, extraOptions) {
+    if (inputPath === outputPath) {
+        throw new Error(`input path can not be the same as output path.`);
+    }
     console.log(`Converting ${inputPath} → ${outputPath}`);
     const resolvedInput = path_1.default.resolve(inputPath);
     const markdown = fs_1.default.readFileSync(resolvedInput, "utf-8");

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

@@ -67,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
@@ -92,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"
@@ -101,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() {
@@ -684,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/types.d.ts

@@ -73,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 {
@@ -146,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.12",
+  "version": "1.0.14",
   "description": "A new project created with Intent by Augment.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -29,9 +29,11 @@
     "README.md"
   ],
   "scripts": {
+    "docs:dev": "cd docs && $npm_execpath dev",
     "build": "tsc && mkdir -p dist/fonts && cp src/fonts/* dist/fonts/",
     "generate": "tsx samples/generate.ts",
-    "test": "tsx --test test/*.test.ts && tsx samples/generate.ts && tsx ./src/cli.ts README.md README.pdf"
+    "readme": "pnpm tsx ./src/cli.ts README.md README.pdf",
+    "test": "tsx --test test/*.test.ts && tsx samples/generate.ts && pnpm run readme"
   },
   "keywords": [
     "markdown",