markdown-it-multimd-table

Multimarkdown table syntax plugin for markdown-it markdown parser

Intro

Bored with HTML table tags when I need some extended table functions like colspan in Markdown. I found that MultiMarkdown had defined complete and clear rules for advanced table syntax, which is compatible to standard Markdown table syntax at the same time.

For example, the following features are given:

• colspan attribute
• Multiple <thead> and <tbody>
• Captions

So I altered the table parser in markdown-it for the Multimarkdown syntax.

NOTE: This plugin might behave differently from MultiMarkdown for some edging cases; For this plugin was developed mainly under the rules in MultiMarkdown User's Guide. Please impose an issue if you find problems related.

Usage

var md = require('markdown-it')()
            .use(require('markdown-it-multimd-table'));

md.render(/*...*/)

For test, do this in terminal:

$ npm install markdown-it-multimd-table --prefix .
$ vim test.js

var md = require('markdown-it')()
            .use(require('markdown-it-multimd-table'));
const exampleTable =
"|             |          Grouping           || \n" +
"First Header  | Second Header | Third Header | \n" +
" ------------ | :-----------: | -----------: | \n" +
"Content       |          *Long Cell*        || \n" +
"Content       |   **Cell**    |         Cell | \n" +
"                                               \n" +
"New section   |     More      |         Data | \n" +
"And more      | With an escaped '\|'         ||\n" +
"[Prototype table]                              \n";
console.log(md.render(exampleTable));

$ node test.js > test.html
$ firefox test.html

You might see the table in browser:

Prototype table

	Grouping
First Header	Second Header	Third Header
Content	Long Cell
Content	Cell	Cell
New section	More	Data
And more	With an escaped '|'

Multiple lines of row

Allow table rows parsed as multiple lines with end-of-the-line backslashes, the feature is contributed by Lucas-C.

First header | Second header
-------------|---------------
List:        | More  \
- over       | data  \
- several    |       \
- lines      |

would be parsed as

First header	Second header
List: over several lines	More data

To enable this feature, you have to set the option:

var md = require('markdown-it')()
              .use(require('markdown-it-multimd-table'), {enableMultilineRows: true});

Credits

• MultiMarkdown, Lightweight markup processor to produce HTML, LaTeX, and more.
• markdown-it, Markdown parser, done right. 100% CommonMark support, extensions, syntax plugins & high speed

License

This software is licensed under the MIT license © RedBug312.