Skip to content
Helping the world move Excel table data into Markdown tables
JavaScript HCL
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
bin
media
src
test
.eslintrc.js
.gitignore
.npmignore
CHANGELOG.md
CODE_OF_CONDUCT.md
CONTRIBUTING.md
LICENSE
README.md
package-lock.json
package.json

README.md

markdown-tables

markdown-tables-logo

Build Status 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.

You can’t perform that action at this time.