@cognipeer/to-markdown

A versatile, TypeScript-first utility library for converting various file formats to Markdown.

✨ Features

• 🎯 Multiple Format Support: Convert PDF, DOCX, HTML, Excel, CSV, and more
• 🔎 OCR Support: Extract text from scanned PDFs and images
• 📦 Simple API: Easy to use with Promise-based interface
• 🔧 TypeScript First: Written in TypeScript with full type definitions
• 🚀 Fast & Efficient: Optimized for performance with modular architecture
• 📚 Well Documented: Comprehensive documentation with examples
• 🎨 Customizable: Options to control conversion behavior

📦 Installation

npm install @cognipeer/to-markdown

Using other package managers:

# Yarn
yarn add @cognipeer/to-markdown

# pnpm
pnpm add @cognipeer/to-markdown

Optional OCR dependency (for default tesseract OCR provider):

npm install tesseract.js

🔧 Development

Building from Source

# Install dependencies
npm install

# Build TypeScript and bundles
npm run build

# Watch mode for development
npm run dev

Scripts

• npm run build - Build TypeScript and create bundles
• npm run build:ts - Compile TypeScript only
• npm run build:rollup - Create rollup bundles only
• npm run clean - Remove dist directory
• npm run dev - Watch mode for TypeScript compilation

🤝 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 some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

📝 Changelog

Version 3.0.0 (Latest)

• 🔎 Added OCR support for images and scanned PDFs
• ⚙️ Added ocr option in ConverterOptions (boolean | OCROptions)
• 🌐 Added OCR provider support: tesseract, openai-vlm, anthropic-vlm, ollama-vlm, azure-vision, custom-vlm
• 🧠 Added PDF OCR modes: auto, always, never

Version 2.0.0

• ✨ Rewritten in TypeScript with full type definitions
• 🏗️ Modular architecture with separate converter modules
• 📚 Comprehensive documentation with GitHub Pages
• 💡 Added usage examples
• 🎯 Improved error handling
• 📦 Better package exports (ESM + CJS)

Version 1.0.1

• Initial release with JavaScript implementation

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

👤 Author

Cognipeer

• GitHub: @Cognipeer
• npm: @cognipeer

🙏 Acknowledgments

Built with these amazing libraries:

• pdf2md - PDF parsing
• mammoth - DOCX conversion
• turndown - HTML to Markdown
• xlsx - Excel parsing
• cheerio - HTML parsing
• sharp - Image processing

🔗 Links

• Documentation
• npm Package
• GitHub Repository
• Issue Tracker

Made with ❤️ by Cognipeer

🚀 Quick Start

Basic Usage

import { convertToMarkdown, saveToMarkdownFile } from "@cognipeer/to-markdown";

// Convert from file path
const markdown = await convertToMarkdown("/path/to/document.docx");
console.log(markdown);

// Convert from buffer
const buffer = fs.readFileSync("document.pdf");
const markdown = await convertToMarkdown(buffer, {
  fileName: "document.pdf",
});
console.log(markdown);

// Convert from base64 string
const base64Content = "data:application/pdf;base64,JVBERi0xLjUNCiW...";
const markdown = await convertToMarkdown(base64Content);
console.log(markdown);

// Save converted markdown to a file
await saveToMarkdownFile(markdown, "converted-document", "./output");

TypeScript Usage

import {
  convertToMarkdown,
  saveToMarkdownFile,
  type ConverterOptions,
  type ConverterInput,
} from "@cognipeer/to-markdown";

// Type-safe conversion
const options: ConverterOptions = {
  fileName: "document.pdf",
  forceExtension: ".pdf",
  ocr: {
    provider: "tesseract",
    lang: "eng",
    pdfMode: "auto",
  },
};

const input: ConverterInput = "./document.pdf";
const result: string = await convertToMarkdown(input, options);

📖 API Reference

convertToMarkdown(input, options?)

Converts various file formats to Markdown.

Parameters:

• input: ConverterInput - File path (string), base64 data (string), or Buffer
• options?: ConverterOptions - Optional configuration
  • fileName?: string - Name of the file (helpful for buffer inputs)
  • forceExtension?: string - Force a specific file extension for processing
  • url?: string - Original URL (used for web content like YouTube or Bing search)
  • ocr?: boolean | OCROptions - Enable OCR for images and scanned PDFs (opt-in)

OCROptions includes:

• provider?: 'tesseract' | 'openai-vlm' | 'anthropic-vlm' | 'ollama-vlm' | 'azure-vision' | 'custom-vlm'
• lang?: string - Tesseract language code (default: eng)
• pdfMode?: 'auto' | 'always' | 'never' - PDF OCR mode (default: auto)
• vlm?: { model: string; apiKey?: string; apiBase?: string; prompt?: string; maxTokens?: number }

Returns: Promise<string> - The converted markdown content

Example:

const markdown = await convertToMarkdown("./document.pdf", {
  forceExtension: ".pdf",
});

OCR Examples

// 1) OCR scanned PDF with default provider (tesseract)
const scannedPdf = await convertToMarkdown("./scan.pdf", {
  ocr: true,
});

// 2) OCR image with explicit tesseract options
const imageText = await convertToMarkdown("./receipt.png", {
  ocr: { provider: "tesseract", lang: "eng" },
});

// 3) OCR PDF only when native text extraction is empty
const autoFallback = await convertToMarkdown("./document.pdf", {
  ocr: { pdfMode: "auto" },
});

saveToMarkdownFile(content, fileName, outputDir?)

Saves the markdown content to a file.

Parameters:

• content: string - The markdown content to save
• fileName: string - Name for the output file (without .md extension)
• outputDir?: string - Directory to save the file (defaults to "output")

Returns: Promise<string> - Path to the saved file

Example:

const filePath = await saveToMarkdownFile(markdown, "document", "./output");
console.log(`Saved to: ${filePath}`);

📚 Documentation

For comprehensive documentation, please visit our documentation site.

• Getting Started Guide
• API Documentation
• Format Support
• Error Handling

💡 Examples

Check out the examples/ directory for more usage examples:

• Basic Usage - File path, buffer, and base64 conversions
• Spreadsheet Conversion - Excel and CSV to Markdown tables
• Advanced Usage - Jupyter notebooks and complex HTML

Running Examples

# Using tsx (recommended for development)
npx tsx examples/basic-usage.ts

# Or build and run
npm run build
node dist/examples/basic-usage.js

🏗️ Project Structure

to-markdown/
├── src/
│   ├── converters/      # Format-specific converters
│   │   ├── pdf.ts
│   │   ├── docx.ts
│   │   ├── html.ts
│   │   └── ...
│   ├── types/           # TypeScript type definitions
│   │   └── index.ts
│   ├── utils/           # Utility functions
│   │   ├── markdown.ts
│   │   └── fileDetection.ts
│   └── index.ts         # Main entry point
├── examples/            # Usage examples
├── docs/                # GitHub Pages documentation
├── dist/                # Compiled output
└── package.json

• Web content: Special handling for YouTube videos and Bing search results

Examples

Convert PDF to Markdown

import { convertToMarkdown } from "@cognipeer/to-markdown";
import fs from "fs";

const pdfBuffer = fs.readFileSync("document.pdf");
const markdown = await convertToMarkdown(pdfBuffer, {
  fileName: "document.pdf",
});

console.log(markdown);

Convert DOCX to Markdown

import { convertToMarkdown } from "@cognipeer/to-markdown";

const markdown = await convertToMarkdown("/path/to/document.docx");
console.log(markdown);

Convert HTML to Markdown

import { convertToMarkdown, saveToMarkdownFile } from "@cognipeer/to-markdown";
import fs from "fs";

const htmlContent = fs.readFileSync("page.html", "utf-8");
const markdown = await convertToMarkdown(htmlContent, {
  forceExtension: ".html",
});
console.log(markdown);

Convert and Save to File

import { convertToMarkdown, saveToMarkdownFile } from "@cognipeer/to-markdown";

const markdown = await convertToMarkdown("/path/to/document.pdf");
const savedPath = await saveToMarkdownFile(
  markdown,
  "converted-document",
  "./output",
);
console.log(`Saved to: ${savedPath}`);

License

MIT