md-preview-pdf 1.0.4

package/CONTRIBUTING.md

@@ -0,0 +1,170 @@
+# Contributing to MD Preview PDF
+
+First off, thank you for considering contributing to MD Preview PDF! It's people like you that make this tool better for everyone.
+
+## Code of Conduct
+
+This project and everyone participating in it is governed by our [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
+
+## How Can I Contribute?
+
+### Reporting Bugs
+
+Before creating bug reports, please check the existing issues to avoid duplicates. When you create a bug report, include as many details as possible:
+
+- **Use a clear and descriptive title**
+- **Describe the exact steps to reproduce the problem**
+- **Provide specific examples** (markdown files, configurations)
+- **Describe the behavior you observed and what you expected**
+- **Include your environment details** (OS, Node.js version, package version)
+- **Add screenshots** if applicable
+
+### Suggesting Enhancements
+
+Enhancement suggestions are tracked as GitHub issues. When creating an enhancement suggestion:
+
+- **Use a clear and descriptive title**
+- **Provide a detailed description of the suggested enhancement**
+- **Explain why this enhancement would be useful**
+- **List any similar features in other tools** if applicable
+
+### Pull Requests
+
+1. **Fork the repository** and create your branch from `main`
+2. **Follow the coding style** of the project (ESLint configuration provided)
+3. **Write clear commit messages** following conventional commits format:
+   - `feat:` for new features
+   - `fix:` for bug fixes
+   - `docs:` for documentation changes
+   - `test:` for test additions/changes
+   - `refactor:` for code refactoring
+   - `chore:` for maintenance tasks
+4. **Update documentation** if you're changing functionality
+5. **Add tests** if you're adding features
+6. **Ensure all tests pass** by running `npm test`
+7. **Update CHANGELOG.md** with your changes
+
+## Development Setup
+
+```bash
+# Clone your fork
+git clone https://github.com/your-username/md-preview-pdf.git
+cd md-preview-pdf
+
+# Install dependencies
+npm install
+
+# Build the project
+npm run build
+
+# Run tests
+npm test
+
+# Run linting
+npm run lint
+```
+
+## Development Workflow
+
+1. Create a new branch:
+   ```bash
+   git checkout -b feature/your-feature-name
+   ```
+
+2. Make your changes and test them:
+   ```bash
+   npm run build
+   npm test
+   npm run dev -- tests/samples/comprehensive-test.md
+   ```
+
+3. Commit your changes:
+   ```bash
+   git add .
+   git commit -m "feat: add amazing feature"
+   ```
+
+4. Push to your fork:
+   ```bash
+   git push origin feature/your-feature-name
+   ```
+
+5. Create a Pull Request on GitHub
+
+## Coding Guidelines
+
+### TypeScript Style
+
+- Use **TypeScript** for all new code
+- Follow the existing **ESLint** configuration
+- Use **explicit types** for function parameters and return values
+- Prefer **interfaces** over type aliases for object shapes
+- Use **const** for variables that don't change
+- Use **async/await** over promises chains
+
+### Code Organization
+
+- Keep functions **small and focused** (single responsibility)
+- **Extract reusable logic** into utility functions
+- Add **JSDoc comments** for public APIs
+- Use **descriptive variable names**
+- Organize imports: Node.js built-ins → third-party → local
+
+### Testing
+
+- Write **unit tests** for utility functions
+- Write **integration tests** for the converter
+- Test with **various markdown features**
+- Test **error cases** and edge conditions
+- Aim for **>80% code coverage**
+
+### Documentation
+
+- Update **README.md** for user-facing changes
+- Update **ARCHITECTURE.md** for architectural changes
+- Add **JSDoc comments** for public APIs
+- Include **examples** in documentation
+- Keep documentation **clear and concise**
+
+## Project Structure
+
+```
+md-preview-pdf/
+├── src/
+│   ├── index.ts           # Main entry point and exports
+│   ├── cli.ts             # Command-line interface
+│   ├── converter.ts       # Main converter class
+│   ├── parser/            # Markdown parsing logic
+│   ├── renderers/         # HTML, PDF, and Mermaid rendering
+│   ├── themes/            # CSS themes
+│   ├── utils/             # Utility functions
+│   └── types/             # TypeScript type definitions
+├── tests/
+│   ├── samples/           # Test markdown files
+│   └── *.test.ts          # Test files
+├── .github/
+│   └── workflows/         # CI/CD workflows
+└── docs/                  # Additional documentation
+```
+
+## Testing Checklist
+
+Before submitting a PR, ensure:
+
+- [ ] All tests pass (`npm test`)
+- [ ] Linting passes (`npm run lint`)
+- [ ] Code builds successfully (`npm run build`)
+- [ ] Documentation is updated
+- [ ] CHANGELOG.md is updated
+- [ ] No console.log() statements left in code
+- [ ] New features have tests
+- [ ] All commits follow conventional commits format
+
+## Questions?
+
+Feel free to:
+- Open an issue for discussion
+- Join our community discussions
+- Reach out to the maintainers
+
+Thank you for contributing! 🎉

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026
+
+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

@@ -0,0 +1,391 @@
+# MD Preview PDF 📄
+
+A state-of-the-art Markdown to PDF converter that preserves the exact visual appearance of markdown previews, including full support for Mermaid diagrams, syntax highlighting, math equations, and GitHub Flavored Markdown.
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Node.js Version](https://img.shields.io/badge/node-%3E%3D18.0.0-brightgreen)](https://nodejs.org/)
+[![TypeScript](https://img.shields.io/badge/TypeScript-5.4-blue)](https://www.typescriptlang.org/)
+[![ESLint](https://img.shields.io/badge/ESLint-9.0-brightgreen)](https://eslint.org/)
+![Tests](https://img.shields.io/badge/Tests-26%20passing-brightgreen)
+
+## ✨ Features
+
+- **Full Markdown Support**: Complete GFM (GitHub Flavored Markdown) support
+- **Mermaid Diagrams**: Flowcharts, sequence diagrams, class diagrams, and more
+- **Syntax Highlighting**: 150+ programming languages with beautiful themes
+- **Math Equations**: LaTeX math rendering via KaTeX
+- **Multiple Themes**: GitHub (light/dark), VS Code (light/dark)
+- **Table of Contents**: Auto-generated TOC with customizable depth
+- **Task Lists**: Checkbox support for TODO lists
+- **Footnotes**: Full footnote support
+- **Custom Containers**: Tips, warnings, info boxes, and more
+- **Emoji Support**: Convert `:emoji:` shortcodes to unicode
+- **High-Fidelity Output**: Uses Puppeteer for pixel-perfect PDF generation
+
+## 📦 Installation
+
+### From Source (Development)
+
+```bash
+# Clone the repository
+git clone https://github.com/anuragkr29/md-preview-pdf.git
+cd md-preview-pdf
+
+# Install dependencies
+npm install
+
+# Build the project
+npm run build
+
+# Link for global CLI usage (optional)
+npm link
+```
+
+### From NPM (Coming Soon)
+
+```bash
+# Global installation
+npm install -g md-preview-pdf
+
+# Local installation
+npm install md-preview-pdf
+```
+
+## 🚀 Quick Start
+
+### Command Line
+
+```bash
+# Basic conversion
+md-preview-pdf document.md
+
+# Specify output file
+md-preview-pdf document.md output.pdf
+
+# Use dark theme
+md-preview-pdf document.md --theme github-dark
+
+# Add page numbers
+md-preview-pdf document.md --page-numbers
+
+# Generate table of contents
+md-preview-pdf document.md --toc
+```
+
+### Programmatic Usage
+
+```typescript
+import { Converter, convert } from 'md-preview-pdf';
+
+// Quick convert
+const result = await convert('document.md', 'output.pdf', {
+  theme: { name: 'github' },
+  pdf: { format: 'A4' },
+});
+
+// Using the Converter class
+const converter = new Converter({
+  theme: { name: 'github-dark' },
+  toc: true,
+  math: true,
+});
+
+const result = await converter.convertFile('input.md', 'output.pdf');
+console.log(`PDF generated: ${result.outputPath}`);
+
+// Don't forget to cleanup
+await converter.cleanup();
+```
+
+## 📋 CLI Options
+
+| Option | Description | Default |
+|--------|-------------|---------|
+| `-t, --theme <theme>` | Theme (github, github-dark, vscode-light, vscode-dark) | `github` |
+| `-f, --format <format>` | Page format (A4, A3, A5, Letter, Legal, Tabloid) | `A4` |
+| `--landscape` | Use landscape orientation | `false` |
+| `--no-background` | Disable background printing | `true` |
+| `-m, --margin <margin>` | Page margins (e.g., "20mm" or "10mm,15mm,20mm,15mm") | `20mm` |
+| `--toc` | Generate table of contents | `false` |
+| `--toc-depth <depth>` | TOC heading depth (1-6) | `3` |
+| `--html` | Also output HTML file | `false` |
+| `--no-math` | Disable KaTeX math rendering | `true` |
+| `--no-emoji` | Disable emoji conversion | `true` |
+| `--no-highlight` | Disable syntax highlighting | `true` |
+| `--mermaid-theme <theme>` | Mermaid theme (default, forest, dark, neutral) | `default` |
+| `--header <template>` | Custom header HTML template | - |
+| `--footer <template>` | Custom footer HTML template | - |
+| `--page-numbers` | Add page numbers to footer | `false` |
+| `--css <path>` | Custom CSS file path | - |
+| `--debug` | Run in debug mode (show browser) | `false` |
+| `-v, --verbose` | Verbose output | `false` |
+| `-q, --quiet` | Quiet mode | `false` |
+
+## 🎨 Themes
+
+List available themes:
+
+```bash
+md-preview-pdf themes
+```
+
+### Available Themes
+
+- **github**: GitHub light theme (default)
+- **github-dark**: GitHub dark theme
+- **vscode-light**: VS Code light theme
+- **vscode-dark**: VS Code dark theme
+
+### Customizing Theme Styling
+
+Each theme is defined as a CSS string in the `src/themes/` directory. To customize a theme:
+
+1. **GitHub Light Theme** (`src/themes/github.ts`)
+   - Background color: `#ffffff` (white)
+   - Text color: `#24292f` (dark gray)
+   - Edit the `.markdown-body` styling and color variables
+
+2. **GitHub Dark Theme** (`src/themes/github-dark.ts`)
+   - Background color: `#0d1117` (very dark gray)
+   - Text color: `#c9d1d9` (light gray)
+   - Edit the `.markdown-body` styling and color variables
+
+3. **VS Code Light Theme** (`src/themes/vscode-light.ts`)
+   - Background color: `#ffffff` (white)
+   - Text color: `#333333` (dark gray)
+   - Edit the `.markdown-body` styling to match VS Code light theme
+
+4. **VS Code Dark Theme** (`src/themes/vscode-dark.ts`)
+   - Background color: `#1e1e1e` (VS Code dark)
+   - Text color: `#d4d4d4` (light gray)
+   - Edit the `.markdown-body` styling to match VS Code dark theme
+
+To test your theme changes:
+```bash
+npm run build
+md-preview-pdf tests/samples/simple-test.md output.pdf --theme github-dark
+```
+
+### Sample Output
+
+The following PDFs demonstrate the output quality across all themes:
+
+| Theme | Simple Test | File Size |
+|-------|-------------|-----------|
+| [GitHub Light](tests/output/examples/simple-github.pdf) | [View](tests/output/examples/simple-github.pdf) | 130 KB |
+| [GitHub Dark](tests/output/examples/simple-github-dark.pdf) | [View](tests/output/examples/simple-github-dark.pdf) | 130 KB |
+| [VS Code Light](tests/output/examples/simple-vscode-light.pdf) | [View](tests/output/examples/simple-vscode-light.pdf) | 134 KB |
+| [VS Code Dark](tests/output/examples/simple-vscode-dark.pdf) | [View](tests/output/examples/simple-vscode-dark.pdf) | 134 KB |
+
+## 📊 Supported Mermaid Diagrams
+
+
+```mermaid
+flowchart TD
+    A[Start] --> B{Decision}
+    B -->|Yes| C[OK]
+    B -->|No| D[End]
+```
+
+
+Supported diagram types:
+- Flowcharts
+- Sequence diagrams
+- Class diagrams
+- State diagrams
+- Entity Relationship diagrams
+- Gantt charts
+- Pie charts
+- Git graphs
+- User Journey diagrams
+
+## ➗ Math Equations
+
+Inline math with single dollar signs:
+
+```markdown
+The formula $E = mc^2$ is famous.
+```
+
+Block math with double dollar signs:
+
+```markdown
+$$
+\int_{a}^{b} f(x) \, dx = F(b) - F(a)
+$$
+```
+
+## 📝 Front Matter
+
+Use YAML front matter to configure document-specific options:
+
+```yaml
+---
+title: "My Document"
+author: "John Doe"
+date: "2024-01-01"
+pdf:
+  format: Letter
+  margin:
+    top: "25mm"
+    bottom: "25mm"
+theme: github-dark
+---
+```
+
+## 📁 Custom Containers
+
+```markdown
+::: tip Pro Tip
+This is a helpful tip!
+:::
+
+::: warning Warning
+Be careful about this!
+:::
+
+::: danger Danger
+This is critical!
+:::
+
+::: info Information
+Here's some additional info.
+:::
+
+::: details Click to expand
+Hidden content here...
+:::
+```
+
+## 🛠️ Development
+
+```bash
+# Install dependencies
+npm install
+
+# Build
+npm run build
+
+# Run tests
+npm test
+
+# Run in development mode
+npm run dev -- input.md
+
+# Lint code
+npm run lint
+```
+
+## 📂 Project Structure
+
+```
+md-preview-pdf/
+├── src/
+│   ├── index.ts              # Main entry point
+│   ├── cli.ts                # CLI interface
+│   ├── converter.ts          # Main converter class
+│   ├── parser/               # Markdown parsing
+│   ├── renderers/            # HTML/PDF/Mermaid rendering
+│   ├── themes/               # CSS themes
+│   ├── utils/                # Utilities
+│   └── types/                # TypeScript types
+├── tests/
+│   ├── samples/              # Test markdown files
+│   └── *.test.ts             # Test files
+├── package.json
+├── tsconfig.json
+└── README.md
+```
+
+## 🔧 API Reference
+
+### Converter Class
+
+```typescript
+class Converter {
+  constructor(options?: ConverterOptions);
+  
+  // Convert markdown file to PDF
+  convertFile(input: string, output?: string): Promise<ConversionResult>;
+  
+  // Convert markdown string to PDF buffer
+  convertString(markdown: string, basePath?: string): Promise<Buffer>;
+  
+  // Convert multiple files
+  convertFiles(inputs: string[], outputDir?: string): Promise<ConversionResult[]>;
+  
+  // Generate HTML from markdown
+  generateHtml(markdown: string, basePath?: string): Promise<string>;
+  
+  // Parse markdown without rendering
+  parseMarkdown(markdown: string): ParsedMarkdown;
+  
+  // Update options
+  setOptions(options: Partial<ConverterOptions>): void;
+  
+  // Get current options
+  getOptions(): ConverterOptions;
+  
+  // Clean up resources
+  cleanup(): Promise<void>;
+}
+```
+
+### ConverterOptions
+
+```typescript
+interface ConverterOptions {
+  pdf?: PDFOptions;           // PDF generation options
+  theme?: ThemeOptions;       // Theme configuration
+  mermaid?: MermaidOptions;   // Mermaid diagram options
+  toc?: boolean;              // Enable table of contents
+  tocDepth?: number;          // TOC depth (1-6)
+  outputHtml?: boolean;       // Also output HTML
+  math?: boolean;             // Enable KaTeX math
+  emoji?: boolean;            // Enable emoji conversion
+  highlight?: boolean;        // Enable syntax highlighting
+  basePath?: string;          // Base path for relative resources
+  debug?: boolean;            // Debug mode
+}
+```
+
+## 🧪 Testing
+
+```bash
+# Run all tests
+npm test
+
+# Run tests with coverage
+npm test -- --coverage
+
+# Run tests in watch mode
+npm test -- --watch
+```
+
+## 📄 License
+
+MIT License - see [LICENSE](LICENSE) for details.
+
+## 🤝 Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+## 🙏 Acknowledgments
+
+- [markdown-it](https://github.com/markdown-it/markdown-it) - Markdown parser
+- [Puppeteer](https://pptr.dev/) - Headless Chrome for PDF generation
+- [Mermaid](https://mermaid.js.org/) - Diagram rendering
+- [KaTeX](https://katex.org/) - Math rendering
+- [highlight.js](https://highlightjs.org/) - Syntax highlighting
+
+---
+
+**Created by [Anurag Kumar](https://github.com/anuragkr29)**
+
+**Repository**: [md-preview-pdf](https://github.com/anuragkr29/md-preview-pdf)

package/SECURITY.md

@@ -0,0 +1,100 @@
+# Security Policy
+
+## Supported Versions
+
+We release patches for security vulnerabilities. Which versions are eligible for receiving such patches depends on the CVSS v3.0 Rating:
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 1.0.x   | :white_check_mark: |
+
+## Reporting a Vulnerability
+
+We take the security of MD Preview PDF seriously. If you believe you have found a security vulnerability, please report it to us as described below.
+
+### Where to Report
+
+**Please do not report security vulnerabilities through public GitHub issues.**
+
+Instead, please report them via email to:
+- **Email**: anuragkr29@outlook.com
+- **Subject**: [SECURITY] MD Preview PDF - Brief Description
+
+### What to Include
+
+Please include the following information in your report:
+
+- Type of issue (e.g., buffer overflow, SQL injection, cross-site scripting, etc.)
+- Full paths of source file(s) related to the manifestation of the issue
+- The location of the affected source code (tag/branch/commit or direct URL)
+- Any special configuration required to reproduce the issue
+- Step-by-step instructions to reproduce the issue
+- Proof-of-concept or exploit code (if possible)
+- Impact of the issue, including how an attacker might exploit it
+
+### What to Expect
+
+After you submit a report, you can expect:
+
+- **Acknowledgment**: We'll acknowledge receipt of your vulnerability report within 48 hours
+- **Initial Assessment**: We'll provide an initial assessment within 5 business days
+- **Updates**: We'll keep you informed of our progress
+- **Fix & Disclosure**: Once the issue is fixed, we'll work with you on disclosure timing
+
+### Preferred Languages
+
+We prefer all communications to be in English.
+
+## Security Best Practices
+
+When using MD Preview PDF:
+
+1. **Input Validation**: Always validate and sanitize markdown input, especially when processing user-generated content
+2. **File Paths**: Use absolute paths and validate file locations to prevent directory traversal attacks
+3. **Resource Limits**: Set appropriate timeouts and resource limits when processing large documents
+4. **Updates**: Keep the package and its dependencies up to date
+5. **Sandbox**: Consider running the converter in a sandboxed environment if processing untrusted input
+
+## Known Security Considerations
+
+### Puppeteer and Chromium
+
+This package uses Puppeteer, which downloads and runs a full Chromium browser. Key security considerations:
+
+- Chromium is regularly updated for security patches
+- The browser runs in headless mode with limited privileges
+- Network access is controlled but not completely disabled
+- Consider running in a containerized environment for untrusted input
+
+### Markdown Processing
+
+- HTML tags in markdown are processed by default
+- Consider using sanitization libraries for user-generated content
+- Be cautious with custom CSS that may contain malicious code
+- Validate external resources (images, links) before processing
+
+### File System Access
+
+- The tool requires read access to input files
+- It requires write access to output directories
+- Ensure proper file permissions in your environment
+- Validate all file paths to prevent unauthorized access
+
+## Disclosure Policy
+
+- We follow responsible disclosure practices
+- We aim to patch confirmed vulnerabilities within 30 days
+- We'll publicly acknowledge security researchers who report valid issues (unless they prefer to remain anonymous)
+- We'll coordinate disclosure timing with the reporter
+
+## Comments on this Policy
+
+If you have suggestions on how this process could be improved, please submit a pull request or open an issue.
+
+## Updates
+
+This security policy may be updated periodically. Significant changes will be announced in release notes.
+
+---
+
+Last Updated: January 3, 2026

package/dist/cli.d.ts

@@ -0,0 +1,7 @@
+#!/usr/bin/env node
+/**
+ * MD Preview PDF CLI
+ * Command-line interface for converting Markdown to PDF
+ */
+export {};
+//# sourceMappingURL=cli.d.ts.map

package/dist/cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AAEA;;;GAGG"}