csv-to-markdown-table

CSV To Markdown Table

Simple JavaScript CSV to Markdown Table Converter

You can see it in action and play with the Live Example.

Requires no external libraries. Works in Node as well as in the browser.

Install

npm install csv-to-markdown-table

Usage

CLI

This package also includes a CLI tool. You can install it globally with:

npm install -g csv-to-markdown-table

Then you can use it like so:

$ csv-to-markdown-table --help
Usage: csv-to-markdown-table [options]
// … help output

$ csv-to-markdown-table --delimiter ',' --headers < example.csv
| cats | dogs | fish | 
|------|------|------| 
| 1    | 2    | 3    | 
| 4    | 5    | 6    |
$ csv-to-markdown-table
Reading from stdin... (press Ctrl+D at the start of a line to finish)
CSV Delimiter: \t (tab) Headers: false
[interactive input]

Browser via CDN (UMD)

<script src="https://unpkg.com/csv-to-markdown-table"></script>
<script>
  console.log(
    csvToMarkdown("header1,header2,header3\nValue1,Value2,Value3", ",", true)
  );
</script>

Node.js with CommonJS (require)

const csvToMarkdown = require("csv-to-markdown-table");

console.log(
  csvToMarkdown("header1,header2,header3\nValue1,Value2,Value3", ",", true)
);

Node.js with ES Modules (import)

import csvToMarkdown from "csv-to-markdown-table";

console.log(
  csvToMarkdown("header1,header2,header3\nValue1,Value2,Value3", ",", true)
);

TypeScript

import csvToMarkdown from "csv-to-markdown-table";

console.log(
  csvToMarkdown("header1,header2,header3\nValue1,Value2,Value3", ",", true)
);

Outputs:

| header1 | header2 | header3 | 
|---------|---------|---------| 
| Value1  | Value2  | Value3  | 

Which displays in markdown as:

header1	header2	header3
Value1	Value2	Value3

Distribution Formats

This package is distributed in multiple formats:

• UMD: Universal Module Definition for browsers and legacy environments (includes csvToMarkdown global variable when loaded in a browser)
  • lib/CsvToMarkdown.js (unminified)
  • lib/CsvToMarkdown.min.js (minified)
• ESM: ES Modules for modern JavaScript environments
  • lib/CsvToMarkdown.mjs
• CJS: CommonJS for Node.js
  • lib/CsvToMarkdown.cjs

The package.json is configured with the appropriate fields to ensure the correct format is used in each environment:

• main: Points to the CommonJS build
• module: Points to the ESM build
• browser: Points to the UMD build
• unpkg: Points to the minified UMD build
• exports: Provides conditional exports for different environments