@joaodotwork/md-2-pdf 1.1.0 → 1.3.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Joao Doria de Souza
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,21 +1,39 @@
 # md-2-pdf
 
-A powerful CLI tool to convert Markdown files to PDF with built-in Mermaid diagram support.
+[![npm version](https://img.shields.io/npm/v/@joaodotwork/md-2-pdf.svg)](https://www.npmjs.com/package/@joaodotwork/md-2-pdf)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-It automatically handles:
-- **Mermaid Diagrams:** Renders `mermaid` code blocks into high-quality vector graphics (PDF) for lossless scaling.
-- **PDF Generation:** Uses `xelatex` (or `weasyprint`/`wkhtmltopdf` as fallbacks) for professional PDF output.
-- **Smart Formatting:** Includes improved defaults for readability (margins, fonts, links) and prevents bad page breaks (widows/orphans).
+A powerful CLI tool to convert Markdown files to PDF with built-in **Mermaid diagram support**. It bridges the gap between GitHub-flavored documentation and professional PDF exports.
+
+## Why md-2-pdf?
+
+Most markdown-to-pdf converters struggle with diagrams or produce poorly formatted documents. `md-2-pdf` is designed to:
+- **Preserve Vector Quality:** Renders Mermaid diagrams as PDF vectors (not bitmaps) for lossless scaling.
+- **Support GFM Conventions:** Handles lists interrupting paragraphs, task lists, and other GitHub Flavored Markdown features.
+- **Professional Typography:** Uses `xelatex` by default for high-quality typesetting with smart page breaking.
+
+## Key Features
+
+- **Mermaid Diagrams:** Automatically detects ````mermaid` blocks and renders them as vector graphics.
+- **Smart Formatting:**
+  - Standardized 11pt font and optimized line spacing.
+  - Interactive, blue clickable links.
+  - Automatic widow/orphan protection (keeps headers with content).
+  - Wide tables wrap to fit the page — pipe tables with short separator dashes (`|---|---|`) get equal column widths and wrapping cells instead of overflowing.
+  - Customizable margins and geometry.
+- **Multi-Engine Support:** Automatically detects and uses the best available PDF engine (`xelatex`, `pdflatex`, `weasyprint`, or `wkhtmltopdf`).
+- **Batch Processing:** Convert single files or entire directories with one command.
 
 ## Installation
 
 ### Prerequisites
 
-1.  **Node.js & npm** (Installed automatically with the package)
-2.  **Python 3** (Required for the core script)
-3.  **PDF Engine** (One of the following):
-    *   **Recommended:** `xelatex` (Install via [MacTeX](https://tug.org/mactex/) on macOS or `texlive` on Linux)
-    *   *Fallback:* `weasyprint` (`pip install weasyprint`)
+1.  **Node.js & npm** (Required for Mermaid rendering)
+2.  **Python 3** (Required for the core logic)
+3.  **Pandoc** (The engine behind the conversion)
+4.  **PDF Engine** (One of the following):
+    *   **Recommended:** `xelatex` (Install via [MacTeX](https://tug.org/mactex/) on macOS or `texlive-full` on Linux)
+    *   *Alternative:* `weasyprint` (`pip install weasyprint`)
 
 ### Install via npm
 
@@ -23,53 +41,59 @@ It automatically handles:
 npm install -g @joaodotwork/md-2-pdf
 ```
 
+*Or use `pnpm` / `yarn`:*
+```bash
+pnpm add -g @joaodotwork/md-2-pdf
+```
+
 ## Usage
 
-### Convert a File
+### Single File Conversion
 
 ```bash
-md-2-pdf input.md
+md-2-pdf manual.md
 ```
-This creates `input.pdf` in the same directory.
+*Creates `manual.pdf` in the same directory.*
 
-### Convert a Directory
+### Batch Processing
 
-Process all `.md` files in a folder:
+Convert all markdown files in a directory:
 
 ```bash
-md-2-pdf ./docs
+md-2-pdf ./documentation
 ```
 
-### Options
+### Advanced Options
 
 ```bash
-# Specify output location
-md-2-pdf input.md -o output.pdf
+# Specify a custom output name
+md-2-pdf proposal.md -o Final_Proposal.pdf
 
-# Check dependencies
+# Check if all dependencies are correctly installed
 md-2-pdf --check-only
 ```
 
-## Features
+## Mermaid Support
+
+Simply use standard Mermaid syntax in your markdown:
+
+```mermaid
+graph TD;
+    A[Markdown File] -->|Processor| B(Extract Mermaid);
+    B --> C{Render to PDF};
+    C -->|Vector| D[High-Quality PDF];
+```
+
+The tool will extract these blocks, render them using `mermaid-cli`, and embed them back into the final document seamlessly.
 
-- **Mermaid Support:**
-  ```mermaid
-  graph TD;
-      A-->B;
-      A-->C;
-      B-->D;
-      C-->D;
-  ```
-  Just use standard ````mermaid blocks in your markdown. Now renders as vector graphics (PDF) instead of bitmaps for perfect clarity in your PDF exports.
+## Troubleshooting
 
-- **Clean Layout:**
-  - Standardized font size (11pt) and line spacing (1.2).
-  - Blue clickable links.
-  - Horizontal rules (`---`) rendered as vertical space instead of lines.
-  - Smart page breaking rules to keep headers with content.
+If you encounter issues with PDF generation, ensure `pandoc` and a LaTeX engine (like `xelatex`) are in your PATH. You can verify this by running:
 
-## License
+```bash
+md-2-pdf --check-only
+```
 
-ISC
+## License
 
-```
+MIT © [Joao Doria de Souza](https://github.com/joaodotwork)

package/filters/table-fit.lua

@@ -0,0 +1,27 @@
+-- Assign equal column widths to tables that have none set.
+--
+-- Pandoc's pipe-table reader leaves column widths undefined when the
+-- separator-row dashes are short (e.g. `|---|---|`). The LaTeX writer then
+-- emits `l` columns, which do not wrap and overflow the page on wide tables.
+-- Setting equal widths summing to 1.0 makes the writer emit `p{...}` columns
+-- sized to \linewidth, so cells wrap.
+
+function Table(tbl)
+  local n = #tbl.colspecs
+  if n == 0 then return nil end
+
+  local total = 0
+  for _, c in ipairs(tbl.colspecs) do
+    local w = c[2]
+    if type(w) == "number" then
+      total = total + w
+    end
+  end
+  if total > 0 then return nil end
+
+  local equal = 1.0 / n
+  for i = 1, n do
+    tbl.colspecs[i] = { tbl.colspecs[i][1], equal }
+  end
+  return tbl
+end

package/md_to_pdf.py

@@ -167,12 +167,18 @@ def convert_markdown_to_pdf(
 
     print(f"Using PDF engine: {pdf_engine}")
 
+    # Locate bundled Lua filters
+    script_dir = Path(__file__).resolve().parent
+    table_fit_filter = script_dir / 'filters' / 'table-fit.lua'
+
     # Convert to PDF using pandoc
     cmd = [
         'pandoc',
         input_for_pandoc,
         '-o', output_path,
+        '--from=gfm',
         f'--pdf-engine={pdf_engine}',
+        f'--lua-filter={table_fit_filter}',
         '-V', 'geometry:top=0.75in',
         '-V', 'geometry:bottom=1in',
         '-V', 'geometry:left=0.75in',
@@ -183,7 +189,7 @@ def convert_markdown_to_pdf(
         '-V', 'colorlinks=true',
         '-V', 'linkcolor=blue',
         '-V', 'urlcolor=blue',
-        '-V', 'header-includes=\\renewcommand{\\rule}[2]{\\vspace{0.5em}} \\widowpenalty=10000 \\clubpenalty=10000 \\brokenpenalty=10000'
+        '-V', 'header-includes=\\renewcommand{\\rule}[2]{\\vspace{0.5em}} \\widowpenalty=10000 \\clubpenalty=10000 \\brokenpenalty=10000 \\setlength{\\emergencystretch}{3em} \\usepackage{newunicodechar} \\newunicodechar{·}{\\textperiodcentered\\allowbreak} \\newunicodechar{•}{\\textbullet\\allowbreak}'
     ]
     
     try:

package/package.json

@@ -1,28 +1,36 @@
 {
   "name": "@joaodotwork/md-2-pdf",
-  "version": "1.1.0",
+  "version": "1.3.0",
   "description": "Convert markdown files to PDF with mermaid diagram support",
   "main": "index.js",
   "bin": {
     "md-2-pdf": "./bin/index.js"
   },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
   "keywords": [
     "markdown",
     "pdf",
     "mermaid",
     "converter"
   ],
-  "author": "Joao",
-  "license": "ISC",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/joaodotwork/md-2-pdf.git"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "author": "Joao Doria de Souza",
+  "license": "MIT",
   "dependencies": {
     "@mermaid-js/mermaid-cli": "^11.4.2"
   },
   "files": [
     "md_to_pdf.py",
     "bin/",
+    "filters/",
     "requirements.txt"
-  ],
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  }
-}
+  ]
+}