https://github.com/ad-si/tabledown
Easily create Markdown and ASCII tables in JavaScript. Including CLI tool to pretty print JSON as tables.
https://github.com/ad-si/tabledown
ascii-art cli javascript json markdown pretty-print table
Last synced: 6 months ago
JSON representation
Easily create Markdown and ASCII tables in JavaScript. Including CLI tool to pretty print JSON as tables.
- Host: GitHub
- URL: https://github.com/ad-si/tabledown
- Owner: ad-si
- Created: 2016-04-09T22:34:21.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-06-29T19:14:25.000Z (over 8 years ago)
- Last Synced: 2025-03-23T06:02:56.088Z (7 months ago)
- Topics: ascii-art, cli, javascript, json, markdown, pretty-print, table
- Language: JavaScript
- Homepage:
- Size: 18.6 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Tabledown
Easily create markdown tables in your Javascript applications.
## Features
- Input data format agnostic
- Array of arrays
- Array of objects
- Support for several markdown flavors
- Simple tables
- Multiline tables
- Grid tables
- Pipe tables
- Column alignment
- Custom headers
- Optional caption
## Installation
As command line tool:
```sh
npm install --global tabledown
```
As module:
```sh
npm install --save tabledown
```
## Usage
### Command Line
```sh
echo '[{"name": "John", "age": 32}, {"name": "Anna", "age": 27}]' | tabledown
```
yields
```txt
name | age
-----|----
John | 32
Anna | 27
```
### Module
#### Simple
```js
import Tabledown from 'tabledown'
const food = [
{
name: 'banana',
color: 'yellow',
price: 3.23,
quantity: 2,
},
{
name: 'tomato',
color: 'red',
price: 2.67,
quantity: 6,
}
]
const table = new Tabledown({data: food})
console.log(table.toString())
```
yields
```md
name | color | price | quantity
-------|--------|-------|---------
banana | yellow | 3.23 | 2
tomato | red | 2.67 | 6
```
#### Extended
```js
import Tabledown from 'tabledown'
const food = [
{
name: 'banana',
color: 'yellow',
price: 3.23,
quantity: 2,
},
{
name: 'tomato',
color: 'red',
price: 2.67,
quantity: 6,
},
{
name: 'cucumber',
color: 'green',
price: 5.82,
quantity: 4,
},
{
name: 'carrot',
color: 'orange',
price: 3,
quantity: 9,
}
]
const table = new Tabledown({
caption: 'Food',
data: food,
alignments: {
name: 'left',
color: 'right',
price: 'decimal mark', // Not yet implemented
quantity: 'center',
},
headerTexts: {
name: 'the Fruit',
color: 'the Color',
price: 'the Price (€)',
quantity: 'the Quantity',
},
style: 'pipe', // or simple, multiline, grid (not yet implemented)
capitalizeHeaders: true,
})
console.log(table.toString())
```
yields
```md
Table: Food
The Fruit | The Color | The Price (€) | The Quantity
:---------|----------:|---------------|:-----------:
banana | yellow | 3.23 | 2
tomato | red | 2.5 | 6
cucumber | green | 5.82 | 4
carrot | orange | 12 | 9
```
The data can also be provided as an array.
The first sub-array must contain the headers.
```js
const food = [
['name', 'color', 'price', 'quantity'],
['banana', 'yellow', 3.23, 2 ],
['tomato', 'red', 2.5 , 6 ],
['cucumber', 'green', 5.82, 4 ],
['carrot', 'orange', 12, 9 ],
]
const table = new Tabledown({data: food})
```