Marktable

ALPHA: Dev ongoing - Not usable yet

Parse markdown table, edit and format them to markdown or html

Functionalities

• Parse and objectify gfm
• Support multiline cell
• Support colspan
• Support table headers
• Support column alignment
• Support multi table body
• Format table to markdown

Todo or ongoing

• Full unit test
• Table editing
  • add/remove cell, row, column, tbody
  • merge cell, row, tbody
  • move/copy row
• Track one or many pseudo-cursor position before and after table transformations
• Format table to html
• Escape in-content pipe
• Stream API
• Convert CSV to markdown table
• Convert Google Spreadsheet to markdown table
• ...

Installation

npm install --save marktable

API

Basic usage

See too demo/basic.js for more basic examples

var marktable = require('marktable')

// Simple gfm table with alignements
console.log(marktable([
  '|Header 1| Header 2 |',
  '|-:|:-:|',
  '| 42 |',
  '| | o |'
].join('\n')))


// Yield:
/*
| Header 1 | Header 2 |
|---------:|:--------:|
|       42 |          |
|          |     o    |
*/

TODO: Rest of the API

Credit

• Inspired by MultiMarkdown project and its table parser implementation

Related

Some related projects, with different goal and usages, that may match you needs:

• gfm-table: Generate GFM style table
• ascii-table: Easy tables for your console data
• columnify: Render data in text columns, supports in-column text-wrap
• convert-text-table: Convert ascii tables to json arrays
• tablify: Quick and painless printing of tabular data

License

The MIT license (see LICENSE.md)