markdown-it-scrolltable
v0.1.6
Published
A markdown-it plugin for horizontal scrolling of responsive tables
Downloads
2,495
Maintainers
Readme
A markdown-it plugin to wrap tables into a <div>
for horizontal scrolling on narrow screens.
Examples
The following markdown table
Column | Column
------ | ------
Cell | Cell
will become
<div class="scroll-table" style="overflow-x:auto">
<table>
<thead>
<tr>
<th>Column</th>
<th>Column</th>
</tr>
</thead>
<tbody>
<tr>
<td>Cell</td>
<td>Cell</td>
</tr>
</tbody>
</table>
</div>
Also, html in your markdown, like for example
<table>
<thead>
<tr>
<th>Column</th>
<th>Column</th>
</tr>
</thead>
<tbody>
<tr>
<td>Cell</td>
<td>Cell</td>
</tr>
</tbody>
</table>
will be transformed into
<div class="scroll-table" style="overflow-x:auto">
<table>
<thead>
<tr>
<th>Column</th>
<th>Column</th>
</tr>
</thead>
<tbody>
<tr>
<td>Cell</td>
<td>Cell</td>
</tr>
</tbody>
</table>
</div>
Usage
var markdownIt = require('markdown-it');
var markdownItScrollTable = require('markdown-it-scrolltable');
markdownIt({
html: true,
linkify: true,
typographer: true,
})
.use(markdownItScrollTable);