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.

Use via command line

Install using

npm install -g markdown-tables

For converting a file with only a single sheet, you can use:

markdown-tables ./path/to/input/file.xlsx ./output.md

This will convert the first sheet. If you want to output all sheets (each in a different file), use:

markdown-tables ./path/to/input/file.xlsx --all-sheets ./output-{number}.md

This will create a file for each sheets and insert the corresponding sheet number.

Use via Node JS project

Adding markdown-tables to your Node project for use

npm install markdown-tables --save

You use markdown-tables as such

import markdownTables from "markdown-tables"
const markdownTable = markdownTables(xlsxFilePath)

For getting all sheets and not only the first, use the options parameter:

const markdownTable = markdownTables(xlsxFilePath, { allSheets=true })

Want to contribute to Markdown Tables?

Check out the CONTRIBUTING doc.

Changelog

Check out the CHANGELOG doc.