/rehype-table-data-label

A remark plugin to add a data-label attribute to table cells base on the header cell content

Primary LanguageHTMLMIT LicenseMIT

Rehype Table Data Label

rehype plugin to take table header values and add them as data-labels within a data cell. This allows for tables to be consumed in mobile browsers.

Table first being rendered on desktop with headers along the top row. As the table resizes, the table headers are shown next to individual cell values

Input Markdown

| Name    | Country  | City      |
|---------|----------|-----------|
| Jane    | Canada   | Vancouver |
| Thibaut | Belgium  | Ghent     |
| Richard | Scotland | Edinburgh |

Resulting HTML

<table>
    <thead>
        <tr>
            <th>Name</th>
            <th>Country</th>
            <th>City</th>
        </tr>
    </thead>
    <tbody>
        <tr>
            <td data-label="Name">Jane</td>
            <td data-label="Country">Canada</td>
            <td data-label="City">Vancouver</td>
        </tr>
        <tr>
            <td data-label="Name">Thibaut</td>
            <td data-label="Country">Belgium</td>
            <td data-label="City">Ghent</td>
        </tr>
        <tr>
            <td data-label="Name">Richard</td>
            <td data-label="Country">Scotland</td>
            <td data-label="City">Edinburgh</td>
        </tr>
    </tbody>
</table>

Examples

Example directory includes sample markdown files, example.js script which steps through the remark/ rehype conversion process, and an html table that resizes properly on small viewports.