mdformat-tables

1.0.0 · active · verified Mon Apr 13

mdformat-tables is a plugin for the `mdformat` markdown formatter, designed specifically for rendering tables according to the GitHub Flavored Markdown (GFM) specification. It ensures tables are consistently formatted and properly aligned. The library is actively maintained, with its current version being 1.0.0, and follows a stable release cadence driven by updates to `mdformat`.

Warnings

breaking Python 3.6 support was dropped in `v1.0.0`. Users on older Python versions must either upgrade their Python environment or pin `mdformat-tables` to an earlier version (e.g., `<1.0.0`).
Fix: Upgrade to Python 3.7+ or pin `mdformat-tables<1.0.0`.
gotcha Compatibility with `mdformat` versions is crucial. `mdformat-tables` versions are often synced with specific `mdformat` versions due to internal API changes (e.g., `v0.3.0` synced with `mdformat 0.6.0`). Mismatched versions can lead to unexpected formatting or errors.
Fix: Always install the latest `mdformat-tables` with the latest `mdformat` or consult their respective changelogs for specific compatibility notes. Ensure both libraries are kept up-to-date in sync.
gotcha Prior to `v0.4.1`, tables containing unescaped pipe characters (`|`) within cells could be incorrectly rendered or parsed, leading to malformed output.
Fix: Upgrade to `mdformat-tables>=0.4.1` to ensure correct pipe escaping and table parsing.
gotcha Before `v0.4.0`, lines that visually resembled table delimiter rows (e.g., `--- | ---`) but were not intended as such could be misinterpreted and incorrectly escaped, affecting non-table content.
Fix: Upgrade to `mdformat-tables>=0.4.0` for improved handling of potential table delimiter rows.

Install

pip install mdformat-tables mdformat Install with mdformat

Imports

mdformat_tables
```
import mdformat_tables
```
Importing the package registers it as an mdformat plugin. Its functionality is then accessed via `mdformat`'s API or CLI using the plugin name 'tables'.

Quickstart

This example demonstrates how to use `mdformat-tables` programmatically. By simply importing `mdformat_tables`, the plugin is registered with `mdformat`. You then pass `plugins=['tables']` to `mdformat.format_markdown` to enable table formatting.

import mdformat
import mdformat_tables # This registers the plugin

markdown_with_table = """
| Header 1 | Header 2 |
|----------|----------|
| Row 1 Col 1 | Row 1 Col 2 |
| Row 2 Col 1 | Row 2 Col 2 |
"""

formatted_markdown = mdformat.format_markdown(markdown_with_table, plugins=['tables'])
print(formatted_markdown)

view raw JSON →