Configuration

Examples

Table of contents

1. Basic Usage
   1. Converting from a File Path
   2. Converting from a Buffer
   3. Converting from Base64
2. Spreadsheet Conversion
   1. Excel to Markdown Table
   2. CSV to Markdown Table
3. Advanced Usage
   1. Saving Output to a File
   2. Jupyter Notebook Conversion
   3. Error Handling
4. Source Files
5. Next Steps

---

Basic Usage

Converting from a File Path

The simplest way to convert a file is to provide its path:

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

const markdown = await convertToMarkdown('./path/to/document.pdf');
console.log(markdown);

Converting from a Buffer

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

const buffer = readFileSync('./document.docx');
const markdown = await convertToMarkdown(buffer, {
  fileName: 'document.docx'
});
console.log(markdown);

Converting from Base64

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

// With data URL
const base64 = 'data:application/pdf;base64,JVBERi0xLjU...';
const markdown = await convertToMarkdown(base64);

// Or plain base64 with a hint for format detection
const plainBase64 = 'JVBERi0xLjU...';
const markdown2 = await convertToMarkdown(plainBase64, {
  fileName: 'document.pdf'
});

Spreadsheet Conversion

Excel to Markdown Table

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

const markdown = await convertToMarkdown('./data.xlsx');
console.log(markdown);
// Output: Markdown table with rows and columns

CSV to Markdown Table

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

const markdown = await convertToMarkdown('./data.csv');
console.log(markdown);

Advanced Usage

Saving Output to a File

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

const markdown = await convertToMarkdown('./document.pdf');
const outputPath = await saveToMarkdownFile(
  markdown,
  'converted-document', // filename without extension
  './output'            // output directory
);

console.log(`Saved to: ${outputPath}`);

Jupyter Notebook Conversion

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

const markdown = await convertToMarkdown('./notebook.ipynb');
console.log(markdown);

Error Handling

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

try {
  const markdown = await convertToMarkdown('./document.pdf');
  console.log(markdown);
} catch (error) {
  console.error('Conversion failed:', error.message);
}

Source Files

The full example source files are available in the examples/ directory of the repository.

Next Steps

• Review the Converter Options
• Explore Format Support
• Learn about Error Handling

This site is open source. Improve this page.