Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pstaender/csv2md
Converts csv data to markdown tables
https://github.com/pstaender/csv2md
Last synced: 9 days ago
JSON representation
Converts csv data to markdown tables
- Host: GitHub
- URL: https://github.com/pstaender/csv2md
- Owner: pstaender
- License: mit
- Created: 2014-08-02T11:25:50.000Z (almost 10 years ago)
- Default Branch: main
- Last Pushed: 2024-04-22T09:35:03.000Z (2 months ago)
- Last Synced: 2024-06-18T17:14:17.074Z (10 days ago)
- Language: TypeScript
- Homepage:
- Size: 173 KB
- Stars: 70
- Watchers: 4
- Forks: 15
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-stars - pstaender/csv2md - Converts csv data to markdown tables (TypeScript)
README
# Transforms csv to markdown table
[](https://travis-ci.org/pstaender/csv2md)
Install with:
```sh
$ npm install -g csv2md
```
Small tool to convert (larger) csv to markdown tables. Processes `stdin` or csv file.
## Usage
```sh
$ csv2md data.csv > data.md
```
Piping data is possible (and recommend for larger files):
```sh
$ csv2md < data.csv
max_i | min_i | max_f | min_f
---|---|---|---
-122.1430195 | -122.1430195 | -122.415278 | 37.778643
-122.1430195 | -122.1430195 | -122.40815 | 37.785034
-122.4194155 | -122.4194155 | -122.4330827 | 37.7851673
```
To write the resulting markdown to a file, use the familiar stream syntax:
```sh
$ 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:
```sh
$ csv2md -p < data.csv
| max_i | min_i | max_f | min_f |
|--------------|--------------|--------------|------------|
| -122.1430195 | -122.1430195 | -122.415278 | 37.778643 |
| -122.1430195 | -122.1430195 | -122.40815 | 37.785034 |
| -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:
```sh
$ csv2md -h
```
## Using csv2md programatically
```js
import { Csv2md } from 'csv2md'
let csvString = fs.readFileSync(__dirname + '/data.csv').toString()
let csv2md = new Csv2md({
pretty: true
})
let markdown = await csv2md.convert(csvString)
```
### Synchronous usage
```js
import { Csv2md, csv2md } from 'csv2md'
let csvString = `
a,b,c_1,c_2
-122.1430195,124.3,true,false
null, a ,a very long string,~
a,b,c_1,c_2`.trim()
let markdown = csv2md(csvString, {
pretty: true
})
```
### Stream
```js
import { Csv2md } from 'csv2md'
import * as transform from 'stream-transform'
const transformer = transform((record, cb) =>
csv2md.transform(record, cb)
)
process.stdin
.pipe(parser)
.pipe(transformer)
.pipe(process.stdout)
}
```
## Contributors
- [dbohdan](https://github.com/dbohdan)