# markdown-it-multimd-table > Multimarkdown table syntax plugin for markdown-it markdown parser Latest version **4.2.3** (published 2023-08-12) · MIT license · 0 weekly downloads ## Install ```sh npm install markdown-it-multimd-table pnpm add markdown-it-multimd-table yarn add markdown-it-multimd-table bun add markdown-it-multimd-table ``` ## Health **Score 35/100 (D)** — status: abandoned. Positive: has types; no vulnerabilities; high quality score. Warnings: low downloads; no esm support. Negative: abandoned. ## Facts | | | |---|---| | Version | 4.2.3 | | Published | 2023-08-12 | | First published | 2017-08-12 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | CommonJS | | Dependencies | 0 | | Unpacked size | 88.7 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 161 | | Author | redbug312 | | Maintainers | redbug312 | | Keywords | markdown-it-plugin, markdown-it, markdown, multimarkdown, table | ## Links - npm: https://www.npmjs.com/package/markdown-it-multimd-table - Repository: https://github.com/redbug312/markdown-it-multimd-table - Homepage: https://github.com/redbug312/markdown-it-multimd-table#readme - Issues: https://github.com/redbug312/markdown-it-multimd-table/issues - npm.io page: https://npm.io/package/markdown-it-multimd-table ## Alternatives - [@lexical/table](https://npm.io/package/@lexical/table.md) — 3.0M weekly downloads - [mantine-datatable](https://npm.io/package/mantine-datatable.md) — 98.2K weekly downloads - [react-native-collapsible-tab-view](https://npm.io/package/react-native-collapsible-tab-view.md) — 70.6K weekly downloads - [@handsontable/vue3](https://npm.io/package/@handsontable/vue3.md) — 16.1K weekly downloads - [vuewordcloud](https://npm.io/package/vuewordcloud.md) — 7.2K weekly downloads ## Recent versions - 4.2.3 (latest) — 2023-08-12 - 4.2.2 — 2023-05-13 - 4.2.1 — 2023-03-15 - 4.2.0 — 2022-07-29 - 4.1.3 — 2022-01-28 - 4.1.2 — 2022-01-15 - 4.1.1 — 2021-09-19 - 4.1.0 — 2021-04-15 - 4.0.3 — 2020-07-05 - 4.0.2 — 2020-05-20 - 4.0.1 — 2020-01-17 - 4.0.0 — 2019-11-28 - 3.2.3 — 2019-08-05 - 3.2.2 — 2019-07-29 - 3.2.1 — 2019-07-29 - … 11 more at https://npm.io/package/markdown-it-multimd-table/versions ## README [![GitHub Action](https://github.com/redbug312/markdown-it-multimd-table/workflows/Node.js/badge.svg)](https://github.com/redbug312/markdown-it-multimd-table/actions) [![NPM version](https://img.shields.io/npm/v/markdown-it-multimd-table.svg?style=flat)](https://www.npmjs.org/package/markdown-it-multimd-table) [![Coverage Status](https://coveralls.io/repos/redbug312/markdown-it-multimd-table/badge.svg?branch=master&service=github)](https://coveralls.io/github/redbug312/markdown-it-multimd-table?branch=master) MultiMarkdown table syntax plugin for markdown-it markdown parser ## Intro Markdown specs defines only the basics for tables. When users want common features like `colspan`, they must fallback to raw HTML. And writing tables in HTML is truly *lengthy and troublesome*. This plugin extends markdown-it with MultiMarkdown table syntax. [MultiMarkdown][mmd6] is an extended Markdown spec. It defines clear rules for advanced Markdown table syntax, while being consistent with original pipe table; [markdown-it][mdit] is a popular Markdown parser in JavaScript and allows plugins extending itself. [mmd6]: https://fletcher.github.io/MultiMarkdown-6/ [mdit]: https://markdown-it.github.io/ The features are provided: - Cell spans over columns - Cell spans over rows (optional) - Divide rows into sections - Multiple table headers - Table caption - Block-level elements such as lists, codes... (optional) - Omitted table header (optional) Noted that the plugin is not a re-written of MultiMarkdown. This plugin will behave differently from the official compiler, but doing its best to obey rules defined in [MultiMarkdown User's Guide][mmd6-table]. Please pose an issue if there are weird results for sensible inputs. [mmd6-table]: https://fletcher.github.io/MultiMarkdown-6/syntax/tables.html ## Usage ```javascript // defaults var md = require('markdown-it')() .use(require('markdown-it-multimd-table')); // full options list (equivalent to defaults) var md = require('markdown-it')() .use(require('markdown-it-multimd-table'), { multiline: false, rowspan: false, headerless: false, multibody: true, aotolabel: true, }); md.render(/*...*/) ``` For a quick demo: ```javascript $ mkdir markdown-it-multimd-table $ cd markdown-it-multimd-table $ npm install markdown-it 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 ``` Here's the table expected on browser:
Grouping
First Header Second Header Third Header
Content Long Cell
Content Cell Cell
New section More Data
And more With an escaped '|'
Prototype table
Noted that GitHub filters out `style` property, so the example uses `align` the obsolete one. However it outputs `style="text-align: ..."` in actual. ## Options ### Multiline Backslash at end merges with line content below.
Feature contributed by [Lucas-C](https://github.com/Lucas-C). ```markdown | Markdown | Rendered HTML | |--------------|---------------| | *Italic* | *Italic* | \ | | | | - Item 1 | - Item 1 | \ | - Item 2 | - Item 2 | | ```python | ```python \ | .1 + .2 | .1 + .2 \ | ``` | ``` | ``` This is parsed below when the option enabled:
Markdown Rendered HTML 
*Italic*

Italic

 
- Item 1
- Item 2
  • Item 1
  • Item 2
 
```python
.1 + .2
```
 
.1 + .2
### Rowspan `^^` indicates cells being merged above.
Feature contributed by [pmccloghrylaing](https://github.com/pmccloghrylaing). ```markdown Stage | Direct Products | ATP Yields ----: | --------------: | ---------: Glycolysis | 2 ATP || ^^ | 2 NADH | 3--5 ATP | Pyruvaye oxidation | 2 NADH | 5 ATP | Citric acid cycle | 2 ATP || ^^ | 6 NADH | 15 ATP | ^^ | 2 FADH2 | 3 ATP | **30--32** ATP ||| [Net ATP yields per hexose] ``` This is parsed below when the option enabled:
Net ATP yields per hexose
Stage Direct Products ATP Yields
Glycolysis 2 ATP
2 NADH 3–5 ATP
Pyruvaye oxidation 2 NADH 5 ATP
Citric acid cycle 2 ATP
6 NADH 15 ATP
2 FADH2 3 ATP
30–32 ATP
### Headerless Table header can be eliminated. ```markdown |--|--|--|--|--|--|--|--| |♜| |♝|♛|♚|♝|♞|♜| | |♟|♟|♟| |♟|♟|♟| |♟| |♞| | | | | | | |♗| | |♟| | | | | | | | |♙| | | | | | | | | |♘| | | |♙|♙|♙|♙| |♙|♙|♙| |♖|♘|♗|♕|♔| | |♖| ``` This is parsed below when the option enabled:
♜ ♝ ♛ ♚ ♝ ♞ ♜
♟ ♟ ♟ ♟ ♟ ♟
♟ ♞
♗ ♟
♙
♘
♙ ♙ ♙ ♙ ♙ ♙ ♙
♖ ♘ ♗ ♕ ♔ ♖
### Multibody An empty line separates consecutive table bodies. When disabled, an empty line always cuts off the tables. ### Autolabel Table `id` attribute follows the table caption if not labeled. When disabled, caption without labels cannot generate the attribute. ## Credits * [MultiMarkdown][mmd6], Lightweight markup processor to produce HTML, LaTeX, and more. * [markdown-it][mdit], Markdown parser, done right. 100% CommonMark support, extensions, syntax plugins & high speed. ## License This software is licensed under the [MIT license][license] © RedBug312. [license]: https://opensource.org/licenses/mit-license.php --- _Source: https://npm.io/package/markdown-it-multimd-table · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._