Transforms csv to markdown table

Install with:

1  $ npm install -g csv2md

Small tool to convert (larger) csv to markdown tables. Processes stdin or csv file.

Usage

1  $ csv2md data.csv > data.md

Piping data is possible (and recommend for larger files):

1  $ csv2md < data.csv
2
3  max_i | min_i | max_f | min_f
4  ---|---|---|---
5  -122.1430195 | -122.1430195 | -122.415278 | 37.778643
6  -122.1430195 | -122.1430195 | -122.40815 | 37.785034
7  -122.4194155 | -122.4194155 | -122.4330827 | 37.7851673

To write the resulting markdown to a file, use the familiar stream syntax:

1  $ csv2md < data.csv > data.md

Pretty Markdown

The pretty / p option will pad cells to uniform width and uses beginning and ending |-delimiters by default:

1  $ csv2md -p < data.csv
2
3  | max_i        | min_i        | max_f        | min_f      |
4  |--------------|--------------|--------------|------------|
5  | -122.1430195 | -122.1430195 | -122.415278  | 37.778643  |
6  | -122.1430195 | -122.1430195 | -122.40815   | 37.785034  |
7  | -122.4194155 | -122.4194155 | -122.4330827 | 37.7851673 |

It's much more human readable than the default inline-style but will disable stream processing.

Options

Use -h for more command options:

1  $ csv2md -h

Using csv2md programatically

1import { Csv2md } from 'csv2md'
2
3let csvString = fs.readFileSync(__dirname + '/data.csv').toString()
4
5let csv2md = new Csv2md({
6  pretty: true
7})
8
9let markdown = await csv2md.convert(csvString)

Synchronous usage

1import { Csv2md, csv2md } from 'csv2md'
2
3let csvString = `
4a,b,c_1,c_2
5-122.1430195,124.3,true,false
6null, a ,a very long string,~
7a,b,c_1,c_2`.trim()
8
9let markdown = csv2md(csvString, {
10  pretty: true
11})

Stream

1import { Csv2md } from 'csv2md'
2import * as transform from 'stream-transform'
3
4const transformer = transform((record, cb) =>
5  csv2md.transform(record, cb)
6)
7process.stdin
8  .pipe(parser)
9  .pipe(transformer)
10  .pipe(process.stdout)
11}

Contributors

• dbohdan