@joaodotwork/md-2-pdf 1.0.2 → 1.1.0

package/README.md

@@ -1,95 +1,75 @@
-# Markdown to PDF Converter with Mermaid Support
+# md-2-pdf
 
-A Python utility to convert Markdown files to PDF while properly rendering Mermaid diagrams.
+A powerful CLI tool to convert Markdown files to PDF with built-in Mermaid diagram support.
 
-## Features
-
-- Converts Markdown files to PDF
-- Properly renders Mermaid diagrams as images in the PDF
-- Processes individual files or entire directories
-- Customizable output and temporary directories
-
-## Requirements
-
-- Python 3.6+
-- Node.js and npm (for Mermaid CLI)
-- Pandoc (for Markdown to PDF conversion)
-- LaTeX (XeLaTeX for PDF generation)
+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).
 
 ## Installation
 
-1. Ensure you have Python 3.6+ installed
-2. Install Node.js and npm
-3. Install Pandoc: https://pandoc.org/installing.html
-4. Install a LaTeX distribution like TeX Live or MiKTeX
-5. Clone this repository or download the script
+### Prerequisites
 
-The script will automatically install the Mermaid CLI (@mermaid-js/mermaid-cli) if needed.
+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`)
 
-## Usage
-
-### Basic Usage
-
-Convert a single Markdown file to PDF:
+### Install via npm
 
 ```bash
-python md_to_pdf.py path/to/file.md
+npm install -g @joaodotwork/md-2-pdf
 ```
 
-Convert all Markdown files in a directory:
+## Usage
+
+### Convert a File
 
 ```bash
-python md_to_pdf.py path/to/directory
+md-2-pdf input.md
 ```
+This creates `input.pdf` in the same directory.
 
-### Advanced Options
+### Convert a Directory
 
-Specify output file or directory:
+Process all `.md` files in a folder:
 
 ```bash
-python md_to_pdf.py path/to/input.md -o path/to/output.pdf
-python md_to_pdf.py path/to/input_dir -o path/to/output_dir
+md-2-pdf ./docs
 ```
 
-Specify custom temporary directory:
+### Options
 
 ```bash
-python md_to_pdf.py path/to/input.md -t path/to/temp_dir
-```
+# Specify output location
+md-2-pdf input.md -o output.pdf
 
-Check if all dependencies are installed:
-
-```bash
-python md_to_pdf.py --check-only
+# Check dependencies
+md-2-pdf --check-only
 ```
 
-## How It Works
-
-1. The script reads the Markdown file and extracts Mermaid diagram code blocks
-2. For each Mermaid diagram, it:
-   - Saves the diagram code to a temporary file
-   - Uses Mermaid CLI to render the diagram as an image
-   - Replaces the Mermaid code block with an image reference
-3. The modified Markdown with image references is saved to a temporary file
-4. Pandoc converts the modified Markdown to PDF using XeLaTeX
-
-## Example
+## Features
 
-Input Markdown:
+- **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.
 
-````markdown
-# Sample Document
+- **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.
 
-Here's a diagram:
+## License
 
-```mermaid
-flowchart TD
-    A[Start] --> B{Decision}
-    B -->|Yes| C[Process 1]
-    B -->|No| D[Process 2]
-    C --> E[End]
-    D --> E
-```
-````
+ISC
 
-This will be converted to a PDF with the diagram properly rendered.
+```

package/md_to_pdf.py

@@ -84,7 +84,7 @@ def replace_mermaid_with_images(
     updated_content = markdown_content
     
     for i, (full_match, mermaid_code) in enumerate(mermaid_blocks):
-        image_filename = f"{base_filename}_diagram_{i}.png"
+        image_filename = f"{base_filename}_diagram_{i}.pdf"
         image_path = os.path.join(output_dir, image_filename)
         
         if render_mermaid_diagram(mermaid_code, image_path):
@@ -122,6 +122,8 @@ def convert_markdown_to_pdf(
     else:
         os.makedirs(temp_dir, exist_ok=True)
     
+    print(f"Using temporary directory: {temp_dir}")
+    
     # Read the markdown content
     with open(input_path, 'r') as f:
         content = f.read()
@@ -171,13 +173,17 @@ def convert_markdown_to_pdf(
         input_for_pandoc,
         '-o', output_path,
         f'--pdf-engine={pdf_engine}',
-        '-V', 'geometry:margin=0.8in',
+        '-V', 'geometry:top=0.75in',
+        '-V', 'geometry:bottom=1in',
+        '-V', 'geometry:left=0.75in',
+        '-V', 'geometry:right=0.75in',
         '-V', 'fontsize=11pt',
-        '-V', 'linestretch=1.2',
+        '-V', 'linestretch=1.0',
+        '-V', 'parskip=6pt',
         '-V', 'colorlinks=true',
         '-V', 'linkcolor=blue',
         '-V', 'urlcolor=blue',
-        '-V', 'header-includes=\\renewcommand{\\rule}[2]{\\vspace{1em}}'
+        '-V', 'header-includes=\\renewcommand{\\rule}[2]{\\vspace{0.5em}} \\widowpenalty=10000 \\clubpenalty=10000 \\brokenpenalty=10000'
     ]
     
     try:

package/package.json

@@ -1,14 +1,11 @@
 {
   "name": "@joaodotwork/md-2-pdf",
-  "version": "1.0.2",
+  "version": "1.1.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",
@@ -24,5 +21,8 @@
     "md_to_pdf.py",
     "bin/",
     "requirements.txt"
-  ]
+  ],
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  }
 }