Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

markdown-tables

2.2.0 • Public • Published

markdown-tables-logo

Circle CI npm

What & Why

Convert Excel (.xlsx) data into markdown tables friendly for GitHub or GitLab.

Use

There are two ways to use Markdown Tables. You can use it in a Node JS project or you can use it directly via the command line.

Sample input Excel (.xlsx) data:

Label,Square Footage,Color
Office,224,Blue
Kitchen,230,Green
Clothes Closet,45,Yellow
Storage Closet,56,Red

Sample output md data:

| Label          | Square Footage | Color  |
|----------------|----------------|--------|
| Office         | 224            | Blue   |
| Kitchen        | 230            | Green  |
| Clothes Closet | 45             | Yellow |
| Storage Closet | 56             | Red    |

Using via a Node JS project

  • Adding markdown-tables to your Node project for use
npm install markdown-tables --save
  • You use markdown-tables as such
const markdownTables = require("markdown-tables")
...
const markdownTable = markdownTables(xlsxFilePath)

Using via command line with markdown-tables installed globally

npm install -g markdown-tables
markdown-tables ./<path to input file>/input.xlsx ./out.md

Want to contribute to Markdown Tables?

Check out the CONTRIBUTING doc.

Changelog

Check out the CHANGELOG doc.

Install

npm i markdown-tables

DownloadsWeekly Downloads

1

Version

2.2.0

License

MIT

Unpacked Size

30.3 kB

Total Files

15

Last publish

Collaborators

  • avatar